인스턴스 클러스터 API (인증 기반) (사용 중단됨)

Tier: Free, Premium, Ultimate Offering: Self-Managed

경고: 이 기능은 GitLab 14.5에서 사용이 중단되었습니다.

인스턴스 수준의 Kubernetes 클러스터를 사용하면 Kubernetes 클러스터를 GitLab 인스턴스에 연결하고 해당 클러스터를 인스턴스 내 모든 프로젝트에서 사용할 수 있습니다.

사용자는 이 엔드포인트를 사용하려면 관리자 액세스 권한이 필요합니다.

인스턴스 클러스터 목록

인스턴스 클러스터 목록을 반환합니다.

GET /admin/clusters

예시 요청:

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

예시 응답:

[
  {
    "id": 9,
    "name": "cluster-1",
    "created_at": "2020-07-14T18:36:10.440Z",
    "managed": true,
    "enabled": true,
    "domain": null,
    "provider_type": "user",
    "platform_type": "kubernetes",
    "environment_scope": "*",
    "cluster_type": "instance_type",
    "user": {
      "id": 1,
      "name": "Administrator",
      "username": "root",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
      "web_url": "https://gitlab.example.com/root"
    },
    "platform_kubernetes": {
      "api_url": "https://example.com",
      "namespace": null,
      "authorization_type": "rbac",
      "ca_cert":"-----BEGIN CERTIFICATE-----IxMDM1MV0ZDJkZjM...-----END CERTIFICATE-----"
    },
    "provider_gcp": null,
    "management_project": null
  },
  {
    "id": 10,
    "name": "cluster-2",
    "created_at": "2020-07-14T18:39:05.383Z",
    "domain": null,
    "provider_type": "user",
    "platform_type": "kubernetes",
    "environment_scope": "staging",
    "cluster_type": "instance_type",
    "user": {
      "id": 1,
      "name": "Administrator",
      "username": "root",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
      "web_url": "https://gitlab.example.com/root"
    },
    "platform_kubernetes": {
      "api_url": "https://example.com",
      "namespace": null,
      "authorization_type": "rbac",
      "ca_cert":"-----BEGIN CERTIFICATE-----LzEtMCadtaLGxcsGAZjM...-----END CERTIFICATE-----"
    },
    "provider_gcp": null,
    "management_project": null
  },
  {
    "id": 11,
    "name": "cluster-3",
    ...
  }
]

단일 인스턴스 클러스터 가져오기

단일 인스턴스 클러스터를 반환합니다.

파라미터:

속성	유형	필수	설명
`cluster_id`	integer	yes	클러스터의 ID

GET /admin/clusters/:cluster_id

예시 요청:

curl --header "Private-Token: <your_access_token>" "https://gitlab.example.com/api/v4/admin/clusters/9"

예시 응답:

{
  "id": 9,
  "name": "cluster-1",
  "created_at": "2020-07-14T18:36:10.440Z",
  "managed": true,
  "enabled": true,
  "domain": null,
  "provider_type": "user",
  "platform_type": "kubernetes",
  "environment_scope": "*",
  "cluster_type": "instance_type",
  "user": {
    "id": 1,
    "name": "Administrator",
    "username": "root",
    "state": "active",
    "avatar_url": "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
    "web_url": "https://gitlab.example.com/root"
  },
  "platform_kubernetes": {
    "api_url": "https://example.com",
    "namespace": null,
    "authorization_type": "rbac",
    "ca_cert":"-----BEGIN CERTIFICATE-----IxMDM1MV0ZDJkZjM...-----END CERTIFICATE-----"
  },
  "provider_gcp": null,
  "management_project": null
}

기존 인스턴스 클러스터 추가

기존 Kubernetes 인스턴스 클러스터를 추가합니다.

POST /admin/clusters/add

파라미터:

속성	유형	필수	설명
`name`	string	yes	클러스터의 이름
`domain`	string	no	클러스터의 기본 도메인
`environment_scope`	string	no	클러스터와 연결된 환경입니다. 기본값은 `*`입니다.
`management_project_id`	integer	no	클러스터의 관리 프로젝트의 ID
`enabled`	boolean	no	클러스터의 활성 또는 비활성 여부를 결정합니다. 기본값은 `true`입니다.
`managed`	boolean	no	GitLab이 이 클러스터의 네임스페이스 및 서비스 계정을 관리하는지 여부를 결정합니다. 기본값은 `true`입니다.
`platform_kubernetes_attributes[api_url]`	string	yes	Kubernetes API에 액세스할 URL
`platform_kubernetes_attributes[token]`	string	yes	Kubernetes 인증을 위한 토큰
`platform_kubernetes_attributes[ca_cert]`	string	no	TLS 인증서입니다. API가 자체 서명된 TLS 인증서를 사용하는 경우 필요합니다.
`platform_kubernetes_attributes[namespace]`	string	no	프로젝트와 관련된 고유한 네임스페이스
`platform_kubernetes_attributes[authorization_type]`	string	no	클러스터 인증 유형: `rbac`, `abac` 또는 `unknown_authorization`. 기본값은 `rbac`입니다.

예시 요청:

curl --header "Private-Token:<your_access_token>" "http://gitlab.example.com/api/v4/admin/clusters/add" \
-H "Accept:application/json" \
-H "Content-Type:application/json" \
-X POST --data '{"name":"cluster-3", "environment_scope":"production", "platform_kubernetes_attributes":{"api_url":"https://example.com", "token":"12345",  "ca_cert":"-----BEGIN CERTIFICATE-----qpoeiXXZafCM0ZDJkZjM...-----END CERTIFICATE-----"}}'

예시 응답:

{
  "id": 11,
  "name": "cluster-3",
  "created_at": "2020-07-14T18:42:50.805Z",
  "managed": true,
  "enabled": true,
  "domain": null,
  "provider_type": "user",
  "platform_type": "kubernetes",
  "environment_scope": "production",
  "cluster_type": "instance_type",
  "user": {
    "id": 1,
    "name": "Administrator",
    "username": "root",
    "state": "active",
    "avatar_url": "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
    "web_url": "http://gitlab.example.com:3000/root"
  },
  "platform_kubernetes": {
    "api_url": "https://example.com",
    "namespace": null,
    "authorization_type": "rbac",
    "ca_cert":"-----BEGIN CERTIFICATE-----qpoeiXXZafCM0ZDJkZjM...-----END CERTIFICATE-----"
  },
  "provider_gcp": null,
  "management_project": null
}

인스턴스 클러스터 편집

기존의 인스턴스 클러스터를 업데이트합니다.

PUT /admin/clusters/:cluster_id

매개변수:

속성	유형	필수 여부	설명
`cluster_id`	정수	예	클러스터의 ID
`name`	문자열	아니요	클러스터의 이름
`domain`	문자열	아니요	클러스터의 기본 도메인
`environment_scope`	문자열	아니요	클러스터에 연결된 환경
`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]`	문자열	아니요	TLS 인증서. API가 자체 서명된 TLS 인증서를 사용하는 경우 필요합니다.
`platform_kubernetes_attributes[namespace]`	문자열	아니요	프로젝트와 관련된 고유한 네임스페이스

참고: name, api_url, ca_cert, token은 클러스터가 기존 쿠버네티스 클러스터 추가 옵션을 통해 추가되었거나 기존 인스턴스 클러스터 추가 엔드포인트를 통해 추가된 경우에만 업데이트할 수 있습니다.

예시 요청:

curl --header "Private-Token: <your_access_token>" "http://gitlab.example.com/api/v4/admin/clusters/9" \
-H "Content-Type:application/json" \
-X PUT --data '{"name":"update-cluster-name", "platform_kubernetes_attributes":{"api_url":"https://new-example.com","token":"new-token"}}'

예시 응답:

{
  "id": 9,
  "name": "update-cluster-name",
  "created_at": "2020-07-14T18:36:10.440Z",
  "managed": true,
  "enabled": true,
  "domain": null,
  "provider_type": "user",
  "platform_type": "kubernetes",
  "environment_scope": "*",
  "cluster_type": "instance_type",
  "user": {
    "id": 1,
    "name": "Administrator",
    "username": "root",
    "state": "active",
    "avatar_url": "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
    "web_url": "https://gitlab.example.com/root"
  },
  "platform_kubernetes": {
    "api_url": "https://new-example.com",
    "namespace": null,
    "authorization_type": "rbac",
    "ca_cert":"-----BEGIN CERTIFICATE-----IxMDM1MV0ZDJkZjM...-----END CERTIFICATE-----"
  },
  "provider_gcp": null,
  "management_project": null,
  "project": null
}

인스턴스 클러스터 삭제

기존의 인스턴스 클러스터를 삭제합니다. 연결된 Kubernetes 클러스터 내의 기존 리소스는 제거하지 않습니다.

DELETE /admin/clusters/:cluster_id

매개변수:

속성	유형	필수 여부	설명
`cluster_id`	정수	예	클러스터의 ID

예시 요청:

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

인스턴스 클러스터 API (인증 기반) (사용 중단됨)

인스턴스 클러스터 목록

단일 인스턴스 클러스터 가져오기

기존 인스턴스 클러스터 추가

인스턴스 클러스터 편집

인스턴스 클러스터 삭제

도움말

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

도움받기