프로젝트 클러스터 API (인증서 기반) (deprecated)

Tier: Free, Premium, Ultimate Offering: GitLab.com, Self-Managed, GitLab Dedicated

이 기능은 GitLab 14.5에서 deprecated되었습니다.

이 엔드포인트를 사용하려면 최소한 Maintainer 역할이 필요합니다.

프로젝트 클러스터 디렉터리

프로젝트 클러스터 디렉터리을 반환합니다.

GET /projects/:id/clusters

파라미터:

속성	타입	필수	설명
`id`	숫자 또는 문자열	예	인증된 사용자가 소유한 프로젝트의 ID 또는 URL 인코딩된 경로

예시 요청:

curl --header "Private-Token: <your_access_token>" "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"
    },
    ...
  }
]

단일 프로젝트 클러스터 가져오기

단일 프로젝트 클러스터를 가져옵니다.

GET /projects/:id/clusters/:cluster_id

파라미터:

속성	타입	필수	설명
`id`	숫자 또는 문자열	예	인증된 사용자가 소유한 프로젝트의 ID 또는 URL 인코딩된 경로
`cluster_id`	숫자	예	클러스터의 ID

예시 요청:

curl --header "Private-Token: <your_access_token>" "https://gitlab.example.com/api/v4/projects/26/clusters/18"

예시 응답:

{
  "id":18,
  "name":"cluster-1",
  "domain":"example.com",
  ...
}

기존 클러스터를 프로젝트에 추가

기존의 쿠버네티스 클러스터를 프로젝트에 추가합니다.

POST /projects/:id/clusters/user

파라미터:

속성	타입	필수	설명
`id`	숫자 또는 문자열	예	인증된 사용자가 소유한 프로젝트의 ID 또는 URL 인코딩된 경로
`name`	문자열	예	클러스터의 이름
`domain`	문자열	아니오	클러스터의 기본 도메인
`management_project_id`	숫자	아니오	클러스터의 관리 프로젝트의 ID
`enabled`	부울	아니오	클러스터가 활성화되었는지 여부를 결정하며, 기본값은 `true`입니다
`managed`	부울	아니오	GitLab이 이 클러스터를 위해 네임스페이스와 서비스 계정을 관리하는지 여부를 결정합니다. 기본값은 `true`입니다.
`platform_kubernetes_attributes[api_url]`	문자열	예	쿠버네티스 API에 액세스하는 URL
`platform_kubernetes_attributes[token]`	문자열	예	쿠버네티스를 인증하는 토큰
`platform_kubernetes_attributes[ca_cert]`	문자열	아니오	TLS 인증서. API가 셀프 사인된 TLS 인증서를 사용하는 경우 필요합니다.
`platform_kubernetes_attributes[namespace]`	문자열	아니오	프로젝트와 관련된 고유한 네임스페이스
`platform_kubernetes_attributes[authorization_type]`	문자열	아니오	클러스터 인증 유형: `rbac`, `abac` 또는 `unknown_authorization`. 기본값은 `rbac`입니다.
`environment_scope`	문자열	아니오	클러스터와 연관된 환경입니다. 기본값은 `*`입니다. Premium 및 Ultimate 전용입니다.

예시 요청:

curl --header "Private-Token: <your_access_token>" "https://gitlab.example.com/api/v4/projects/26/clusters/user" \
-H "Accept: application/json" \
-H "Content-Type:application/json" \
-X POST --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-----"}}'

예시 응답:

{
  "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",
  ...
}

프로젝트 클러스터 편집

기존 프로젝트 클러스터를 업데이트합니다.

PUT /projects/:id/clusters/:cluster_id

매개변수:

속성	유형	필수	설명
`id`	정수 또는 문자열	예	인증된 사용자가 소유한 프로젝트의 ID 또는 URL-인코딩된 경로
`cluster_id`	정수	예	클러스터의 ID
`name`	문자열	아니요	클러스터의 이름
`domain`	문자열	아니요	클러스터의 기본 도메인
`management_project_id`	정수	아니요	클러스터의 관리 프로젝트의 ID
`enabled`	부울	아니요	클러스터의 활성 상태 여부
`managed`	부울	아니요	GitLab이 이 클러스터의 네임스페이스와 서비스 계정을 관리하는지 여부
`platform_kubernetes_attributes[api_url]`	문자열	아니요	Kubernetes API에 액세스하는 URL
`platform_kubernetes_attributes[token]`	문자열	아니요	Kubernetes 인증에 사용되는 토큰
`platform_kubernetes_attributes[ca_cert]`	문자열	아니요	필요한 경우 API가 자체 서명된 TLS 인증서를 사용하는 경우 필요한 TLS 인증서
`platform_kubernetes_attributes[namespace]`	문자열	아니요	프로젝트와 관련된 고유한 네임스페이스
`environment_scope`	문자열	아니요	클러스터에 연관된 환경

name, api_url, ca_cert, token은 클러스터가 “기존 Kubernetes 클러스터 추가” 옵션을 통해 추가되었거나 “프로젝트에 기존 클러스터 추가” 엔드포인트를 통해 추가 된 경우에만 업데이트할 수 있습니다.

예시 요청:

curl --header "Private-Token: <your_access_token>" "https://gitlab.example.com/api/v4/projects/26/clusters/24" \
-H "Content-Type:application/json" \
-X PUT --data '{"name":"new-cluster-name","domain":"new-domain.com","api_url":"https://new-api-url.com"}'

예시 응답:

{
  "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`	정수 또는 문자열	예	인증된 사용자가 소유한 프로젝트의 ID 또는 URL-인코딩된 경로
`cluster_id`	정수	예	클러스터의 ID

예시 요청:

curl --request DELETE --header "Private-Token: <your_access_token>" "https://gitlab.example.com/api/v4/projects/26/clusters/23"

프로젝트 클러스터 API (인증서 기반) (deprecated)

프로젝트 클러스터 디렉터리

단일 프로젝트 클러스터 가져오기

기존 클러스터를 프로젝트에 추가

프로젝트 클러스터 편집

프로젝트 클러스터 삭제

도움말

기능 사용 가능성과 제품 평가판

도움받기