프로젝트 클러스터 API (인증서 기반) (폐기됨)
Tier: Free, Premium, Ultimate
Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
요약
이 기능은 GitLab 14.5에서 폐기되었습니다. 이러한 엔드포인트를 사용하려면 Maintainer 또는 Owner 역할이 필요합니다. 지정된 프로젝트의 모든 클러스터를 나열합니다. 프로젝트에서 지정된 클러스터를 조회합니다.
Warning
이 기능은 GitLab 14.5에서 폐기되었습니다.
이러한 엔드포인트를 사용하려면 Maintainer 또는 Owner 역할이 필요합니다.
프로젝트의 모든 클러스터 목록#
지정된 프로젝트의 모든 클러스터를 나열합니다.
GET /projects/:id/clusters
매개변수:
| 속성 | 유형 | 필수 | 설명 |
|---|---|---|---|
id |
integer or string | 예 | 프로젝트 ID 또는 URL 인코딩된 경로 |
요청 예시:
curl --request GET \
--header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/projects/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":"project_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",
"namespace":"cluster-1-namespace",
"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 /projects/:id/clusters/:cluster_id
매개변수:
| 속성 | 유형 | 필수 | 설명 |
|---|---|---|---|
id |
integer or string | 예 | 프로젝트 ID 또는 URL 인코딩된 경로 |
cluster_id |
integer | 예 | 클러스터 ID |
요청 예시:
curl --request GET \
--header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/projects/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":"project_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",
"namespace":"cluster-1-namespace",
"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"
},
"project":
{
"id":26,
"description":"",
"name":"project-with-clusters-api",
"name_with_namespace":"Administrator / project-with-clusters-api",
"path":"project-with-clusters-api",
"path_with_namespace":"root/project-with-clusters-api",
"created_at":"2019-01-02T20:13:32.600Z",
"default_branch":null,
"tag_list":[], //deprecated, use `topics` instead
"topics":[],
"ssh_url_to_repo":"ssh://gitlab.example.com/root/project-with-clusters-api.git",
"http_url_to_repo":"https://gitlab.example.com/root/project-with-clusters-api.git",
"web_url":"https://gitlab.example.com/root/project-with-clusters-api",
"readme_url":null,
"avatar_url":null,
"star_count":0,
"forks_count":0,
"last_activity_at":"2019-01-02T20:13:32.600Z",
"namespace":
{
"id":1,
"name":"root",
"path":"root",
"kind":"user",
"full_path":"root",
"parent_id":null
}
}
}
프로젝트에 클러스터 추가#
지정된 프로젝트에 기존 클러스터를 추가합니다.
POST /projects/:id/clusters/user
매개변수:
| 속성 | 유형 | 필수 | 설명 |
|---|---|---|---|
id |
integer or 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[namespace] |
string | 아니요 | 프로젝트와 관련된 고유 네임스페이스 |
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" \
--data '{"name":"cluster-5", "platform_kubernetes_attributes":{"api_url":"https://35.111.51.20","token":"12345","namespace":"cluster-5-namespace","ca_cert":"-----BEGIN CERTIFICATE-----\r\nhFiK1L61owwDQYJKoZIhvcNAQELBQAw\r\nLzEtMCsGA1UEAxMkZDA1YzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM4ZDBj\r\nMB4XDTE4MTIyNzIwMDM1MVoXDTIzMTIyNjIxMDM1MVowLzEtMCsGA1UEAxMkZDA1\r\nYzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM.......-----END CERTIFICATE-----"}}' \
--url "https://gitlab.example.com/api/v4/projects/26/clusters/user"
응답 예시:
{
"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":"project_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",
"namespace":"cluster-5-namespace",
"authorization_type":"rbac",
"ca_cert":"-----BEGIN CERTIFICATE-----\r\nhFiK1L61owwDQYJKoZIhvcNAQELBQAw\r\nLzEtMCsGA1UEAxMkZDA1YzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM4ZDBj\r\nMB4XDTE4MTIyNzIwMDM1MVoXDTIzMTIyNjIxMDM1MVowLzEtMCsGA1UEAxMkZDA1\r\nYzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM.......-----END CERTIFICATE-----"
},
"management_project":null,
"project":
{
"id":26,
"description":"",
"name":"project-with-clusters-api",
"name_with_namespace":"Administrator / project-with-clusters-api",
"path":"project-with-clusters-api",
"path_with_namespace":"root/project-with-clusters-api",
"created_at":"2019-01-02T20:13:32.600Z",
"default_branch":null,
"tag_list":[], //deprecated, use `topics` instead
"topics":[],
"ssh_url_to_repo":"ssh:://gitlab.example.com/root/project-with-clusters-api.git",
"http_url_to_repo":"https://gitlab.example.com/root/project-with-clusters-api.git",
"web_url":"https://gitlab.example.com/root/project-with-clusters-api",
"readme_url":null,
"avatar_url":null,
"star_count":0,
"forks_count":0,
"last_activity_at":"2019-01-02T20:13:32.600Z",
"namespace":
{
"id":1,
"name":"root",
"path":"root",
"kind":"user",
"full_path":"root",
"parent_id":null
}
}
}
프로젝트의 클러스터 업데이트#
프로젝트에서 지정된 클러스터를 업데이트합니다.
PUT /projects/:id/clusters/:cluster_id
매개변수:
| 속성 | 유형 | 필수 | 설명 |
|---|---|---|---|
id |
integer or 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 인증서를 사용하는 경우 필요합니다. |
platform_kubernetes_attributes[namespace] |
string | 아니요 | 프로젝트와 관련된 고유 네임스페이스 |
environment_scope |
string | 아니요 | 클러스터와 연결된 환경 |
Note
name, api_url, ca_cert, token은 "기존 Kubernetes 클러스터 추가" 옵션 또는
"프로젝트에 클러스터 추가" 엔드포인트를 통해 클러스터가 추가된 경우에만 업데이트할 수 있습니다.
요청 예시:
curl --request PUT \
--header "PRIVATE-TOKEN: <your_access_token>" \
--header "Content-Type:application/json" \
--data '{"name":"new-cluster-name","domain":"new-domain.com","api_url":"https://new-api-url.com"}' \
--url "https://gitlab.example.com/api/v4/projects/26/clusters/24"
응답 예시:
{
"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":"project_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",
"namespace":"cluster-5-namespace",
"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"
},
"project":
{
"id":26,
"description":"",
"name":"project-with-clusters-api",
"name_with_namespace":"Administrator / project-with-clusters-api",
"path":"project-with-clusters-api",
"path_with_namespace":"root/project-with-clusters-api",
"created_at":"2019-01-02T20:13:32.600Z",
"default_branch":null,
"tag_list":[], //deprecated, use `topics` instead
"topics":[],
"ssh_url_to_repo":"ssh:://gitlab.example.com/root/project-with-clusters-api.git",
"http_url_to_repo":"https://gitlab.example.com/root/project-with-clusters-api.git",
"web_url":"https://gitlab.example.com/root/project-with-clusters-api",
"readme_url":null,
"avatar_url":null,
"star_count":0,
"forks_count":0,
"last_activity_at":"2019-01-02T20:13:32.600Z",
"namespace":
{
"id":1,
"name":"root",
"path":"root",
"kind":"user",
"full_path":"root",
"parent_id":null
}
}
}
프로젝트에서 클러스터 삭제#
프로젝트에서 지정된 클러스터를 삭제합니다. 연결된 Kubernetes 클러스터 내의 기존 리소스는 제거되지 않습니다.
DELETE /projects/:id/clusters/:cluster_id
매개변수:
| 속성 | 유형 | 필수 | 설명 |
|---|---|---|---|
id |
integer or string | 예 | 프로젝트 ID 또는 URL 인코딩된 경로 |
cluster_id |
integer | 예 | 클러스터 ID |
요청 예시:
curl --request DELETE \
--header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/projects/26/clusters/23"