그룹 클러스터 API (인증서 기반) (Deprecated)
Tier: Free, Premium, Ultimate
Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
요약
이 기능은 GitLab 14.5에서 Deprecated되었습니다. 프로젝트 레벨 및 인스턴스 레벨 Kubernetes 클러스터와 유사하게, 그룹 레벨 Kubernetes 클러스터를 사용하면 그룹에 Kubernetes 클러스터를 연결하여 여러 프로젝트에서 동일한 클러스터를 사용할 수 있습니다.
Warning
이 기능은 GitLab 14.5에서 Deprecated되었습니다.
프로젝트 레벨 및 인스턴스 레벨 Kubernetes 클러스터와 유사하게, 그룹 레벨 Kubernetes 클러스터를 사용하면 그룹에 Kubernetes 클러스터를 연결하여 여러 프로젝트에서 동일한 클러스터를 사용할 수 있습니다.
이 엔드포인트를 사용하려면 그룹에서 Maintainer 또는 Owner 권한이 필요합니다.
그룹 클러스터 목록 조회#
지정된 그룹의 모든 그룹 클러스터를 나열합니다.
GET /groups/:id/clusters
파라미터:
| 속성 | 유형 | 필수 | 설명 |
|---|---|---|---|
id |
integer 또는 string | 예 | 그룹의 ID 또는 URL 인코딩된 경로 |
요청 예시:
curl --header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/groups/26/clusters"
응답 예시:
[
{
"id":18,
"name":"cluster-1",
"domain":"example.com",
"created_at":"2019-01-02T20:18:12.563Z",
"managed": true,
"enabled": true,
"provider_type":"user",
"platform_type":"kubernetes",
"environment_scope":"*",
"cluster_type":"group_type",
"user":
{
"id":1,
"name":"Administrator",
"username":"root",
"state":"active",
"avatar_url":"https://www.gravatar.com/avatar/4249f4df72b..",
"web_url":"https://gitlab.example.com/root"
},
"platform_kubernetes":
{
"api_url":"https://104.197.68.152",
"authorization_type":"rbac",
"ca_cert":"-----BEGIN CERTIFICATE-----\r\nhFiK1L61owwDQYJKoZIhvcNAQELBQAw\r\nLzEtMCsGA1UEAxMkZDA1YzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM4ZDBj\r\nMB4XDTE4MTIyNzIwMDM1MVoXDTIzMTIyNjIxMDM1MVowLzEtMCsGA1UEAxMkZDA1\r\nYzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM.......-----END CERTIFICATE-----"
},
"management_project":
{
"id":2,
"description":null,
"name":"project2",
"name_with_namespace":"John Doe8 / project2",
"path":"project2",
"path_with_namespace":"namespace2/project2",
"created_at":"2019-10-11T02:55:54.138Z"
}
},
{
"id":19,
"name":"cluster-2",
...
}
]
그룹 클러스터 조회#
지정된 그룹 클러스터를 조회합니다.
GET /groups/:id/clusters/:cluster_id
파라미터:
| 속성 | 유형 | 필수 | 설명 |
|---|---|---|---|
id |
integer 또는 string | 예 | 그룹의 ID 또는 URL 인코딩된 경로 |
cluster_id |
integer | 예 | 클러스터의 ID |
요청 예시:
curl --header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/groups/26/clusters/18"
응답 예시:
{
"id":18,
"name":"cluster-1",
"domain":"example.com",
"created_at":"2019-01-02T20:18:12.563Z",
"managed": true,
"enabled": true,
"provider_type":"user",
"platform_type":"kubernetes",
"environment_scope":"*",
"cluster_type":"group_type",
"user":
{
"id":1,
"name":"Administrator",
"username":"root",
"state":"active",
"avatar_url":"https://www.gravatar.com/avatar/4249f4df72b..",
"web_url":"https://gitlab.example.com/root"
},
"platform_kubernetes":
{
"api_url":"https://104.197.68.152",
"authorization_type":"rbac",
"ca_cert":"-----BEGIN CERTIFICATE-----\r\nhFiK1L61owwDQYJKoZIhvcNAQELBQAw\r\nLzEtMCsGA1UEAxMkZDA1YzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM4ZDBj\r\nMB4XDTE4MTIyNzIwMDM1MVoXDTIzMTIyNjIxMDM1MVowLzEtMCsGA1UEAxMkZDA1\r\nYzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM.......-----END CERTIFICATE-----"
},
"management_project":
{
"id":2,
"description":null,
"name":"project2",
"name_with_namespace":"John Doe8 / project2",
"path":"project2",
"path_with_namespace":"namespace2/project2",
"created_at":"2019-10-11T02:55:54.138Z"
},
"group":
{
"id":26,
"name":"group-with-clusters-api",
"web_url":"https://gitlab.example.com/group-with-clusters-api"
}
}
그룹 클러스터 생성#
기존 Kubernetes 클러스터를 추가하여 지정된 그룹에 대한 그룹 클러스터를 생성합니다.
POST /groups/:id/clusters/user
파라미터:
| 속성 | 유형 | 필수 | 설명 |
|---|---|---|---|
id |
integer 또는 string | 예 | 그룹의 ID 또는 URL 인코딩된 경로 |
name |
string | 예 | 클러스터의 이름 |
domain |
string | 아니요 | 클러스터의 기본 도메인 |
management_project_id |
integer | 아니요 | 클러스터의 관리 프로젝트 ID |
enabled |
boolean | 아니요 | 클러스터가 활성 상태인지 여부 결정. 기본값은 true |
managed |
boolean | 아니요 | GitLab이 이 클러스터의 네임스페이스와 서비스 계정을 관리하는지 여부 결정. 기본값은 true |
platform_kubernetes_attributes[api_url] |
string | 예 | Kubernetes API에 접근하기 위한 URL |
platform_kubernetes_attributes[token] |
string | 예 | Kubernetes 인증을 위한 토큰 |
platform_kubernetes_attributes[ca_cert] |
string | 아니요 | TLS 인증서. API가 자체 서명된 TLS 인증서를 사용하는 경우 필수. |
platform_kubernetes_attributes[authorization_type] |
string | 아니요 | 클러스터 인증 유형: rbac, abac 또는 unknown_authorization. 기본값은 rbac. |
environment_scope |
string | 아니요 | 클러스터에 연결된 환경. 기본값은 *. Premium 및 Ultimate만 해당. |
요청 예시:
curl --request POST \
--header "PRIVATE-TOKEN: <your_access_token>" \
--header "Accept: application/json" \
--header "Content-Type:application/json" \
--url "https://gitlab.example.com/api/v4/groups/26/clusters/user" \
--data '{
"name":"cluster-5",
"platform_kubernetes_attributes":{
"api_url":"https://35.111.51.20",
"token":"12345",
"ca_cert":"-----BEGIN CERTIFICATE-----\r\nhFiK1L61owwDQYJKoZIhvcNAQELBQAw\r\nLzEtMCsGA1UEAxMkZDA1YzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM4ZDBj\r\nMB4XDTE4MTIyNzIwMDM1MVoXDTIzMTIyNjIxMDM1MVowLzEtMCsGA1UEAxMkZDA1\r\nYzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM.......-----END CERTIFICATE-----"
}
}'
응답 예시:
{
"id":24,
"name":"cluster-5",
"created_at":"2019-01-03T21:53:40.610Z",
"managed": true,
"enabled": true,
"provider_type":"user",
"platform_type":"kubernetes",
"environment_scope":"*",
"cluster_type":"group_type",
"user":
{
"id":1,
"name":"Administrator",
"username":"root",
"state":"active",
"avatar_url":"https://www.gravatar.com/avatar/4249f4df72b..",
"web_url":"https://gitlab.example.com/root"
},
"platform_kubernetes":
{
"api_url":"https://35.111.51.20",
"authorization_type":"rbac",
"ca_cert":"-----BEGIN CERTIFICATE-----\r\nhFiK1L61owwDQYJKoZIhvcNAQELBQAw\r\nLzEtMCsGA1UEAxMkZDA1YzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM4ZDBj\r\nMB4XDTE4MTIyNzIwMDM1MVoXDTIzMTIyNjIxMDM1MVowLzEtMCsGA1UEAxMkZDA1\r\nYzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM.......-----END CERTIFICATE-----"
},
"management_project":null,
"group":
{
"id":26,
"name":"group-with-clusters-api",
"web_url":"https://gitlab.example.com/root/group-with-clusters-api"
}
}
그룹 클러스터 업데이트#
지정된 그룹 클러스터를 업데이트합니다.
PUT /groups/:id/clusters/:cluster_id
파라미터:
| 속성 | 유형 | 필수 | 설명 |
|---|---|---|---|
id |
integer 또는 string | 예 | 그룹의 ID 또는 URL 인코딩된 경로 |
cluster_id |
integer | 예 | 클러스터의 ID |
name |
string | 아니요 | 클러스터의 이름 |
domain |
string | 아니요 | 클러스터의 기본 도메인 |
management_project_id |
integer | 아니요 | 클러스터의 관리 프로젝트 ID |
enabled |
boolean | 아니요 | 클러스터가 활성 상태인지 여부 결정 |
managed |
boolean | 아니요 | GitLab이 이 클러스터의 네임스페이스와 서비스 계정을 관리하는지 여부 결정 |
platform_kubernetes_attributes[api_url] |
string | 아니요 | Kubernetes API에 접근하기 위한 URL |
platform_kubernetes_attributes[token] |
string | 아니요 | Kubernetes 인증을 위한 토큰 |
platform_kubernetes_attributes[ca_cert] |
string | 아니요 | TLS 인증서. API가 자체 서명된 TLS 인증서를 사용하는 경우 필수. |
environment_scope |
string | 아니요 | 클러스터에 연결된 환경. Premium 및 Ultimate만 해당. |
Note
name, api_url, ca_cert 및 token은 "기존 Kubernetes 클러스터 추가" 옵션이나 "그룹 클러스터 생성" 엔드포인트를 통해 클러스터가 추가된 경우에만 업데이트할 수 있습니다.
요청 예시:
curl --request PUT \
--header "PRIVATE-TOKEN: <your_access_token>" \
--header "Content-Type:application/json" \
--url "https://gitlab.example.com/api/v4/groups/26/clusters/24" \
--data '{
"name":"new-cluster-name",
"domain":"new-domain.com",
"platform_kubernetes_attributes":{
"api_url":"https://10.10.101.1:6433"
}
}'
응답 예시:
{
"id":24,
"name":"new-cluster-name",
"domain":"new-domain.com",
"created_at":"2019-01-03T21:53:40.610Z",
"managed": true,
"enabled": true,
"provider_type":"user",
"platform_type":"kubernetes",
"environment_scope":"*",
"cluster_type":"group_type",
"user":
{
"id":1,
"name":"Administrator",
"username":"root",
"state":"active",
"avatar_url":"https://www.gravatar.com/avatar/4249f4df72b..",
"web_url":"https://gitlab.example.com/root"
},
"platform_kubernetes":
{
"api_url":"https://new-api-url.com",
"authorization_type":"rbac",
"ca_cert":null
},
"management_project":
{
"id":2,
"description":null,
"name":"project2",
"name_with_namespace":"John Doe8 / project2",
"path":"project2",
"path_with_namespace":"namespace2/project2",
"created_at":"2019-10-11T02:55:54.138Z"
},
"group":
{
"id":26,
"name":"group-with-clusters-api",
"web_url":"https://gitlab.example.com/group-with-clusters-api"
}
}
그룹 클러스터 삭제#
지정된 그룹 클러스터를 삭제합니다. 연결된 Kubernetes 클러스터 내의 기존 리소스는 제거하지 않습니다.
DELETE /groups/:id/clusters/:cluster_id
파라미터:
| 속성 | 유형 | 필수 | 설명 |
|---|---|---|---|
id |
integer 또는 string | 예 | 그룹의 ID 또는 URL 인코딩된 경로 |
cluster_id |
integer | 예 | 클러스터의 ID |
요청 예시:
curl --request DELETE \
--header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/groups/26/clusters/23"