api

Red Hat Advanced Cluster Management for Kubernetes 2.5

애플리케이션 리소스, 채널, 서브스크립션 및 쿼리 정보를 생성하고 관리하는 데 사용할 수 있는 API 목록을 확인합니다.

초록

애플리케이션 리소스, 채널, 서브스크립션 및 쿼리 정보를 생성하고 관리하는 데 사용할 수 있는 API 목록을 확인합니다.

1장. api

API에 액세스하여 애플리케이션 리소스, 채널, 서브스크립션 및 정보를 쿼리할 수 있습니다.

사용자 필수 액세스: 역할이 할당된 작업만 수행할 수 있습니다. 역할 기반 액세스 제어 설명서에서 액세스 요구 사항에 대해 알아보십시오.

자세한 내용은 다음 리소스 각각에 대한 API 설명서를 참조하십시오.

1.1. 클러스터 API

1.1.1. 개요

이 문서는 Red Hat Advanced Cluster Management for Kubernetes의 클러스터 리소스에 대한 것입니다. 클러스터 리소스에는 생성, 쿼리, 삭제 및 업데이트 등 네 가지 요청이 있습니다.

1.1.1.1. 버전 정보

버전 : 2.5.0

1.1.1.2. URI 스키마

BasePath : /kubernetes/apis
Schemes : HTTPS

1.1.1.3. 태그

  • cluster.open-cluster-management.io : 클러스터 생성 및 관리

1.1.2. 경로

1.1.2.1. 모든 클러스터 쿼리

GET /cluster.open-cluster-management.io/v1/managedclusters
1.1.2.1.1. 설명

자세한 내용은 클러스터를 쿼리합니다.

1.1.2.1.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

1.1.2.1.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.1.2.1.4. Use
  • cluster/yaml
1.1.2.1.5. 태그
  • cluster.open-cluster-management.io

1.1.2.2. 클러스터 생성

POST /cluster.open-cluster-management.io/v1/managedclusters
1.1.2.2.1. 설명

클러스터 생성

1.1.2.2.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

body

본문
필요

생성할 클러스터를 설명하는 매개변수입니다.

Cluster

1.1.2.2.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.1.2.2.4. Use
  • cluster/yaml
1.1.2.2.5. 태그
  • cluster.open-cluster-management.io
1.1.2.2.6. HTTP 요청의 예
1.1.2.2.6.1. 요청 본문
{
  "apiVersion" : "cluster.open-cluster-management.io/v1",
  "kind" : "ManagedCluster",
  "metadata" : {
    "labels" : {
      "vendor" : "OpenShift"
    },
    "name" : "cluster1"
  },
  "spec": {
    "hubAcceptsClient": true,
    "managedClusterClientConfigs": [
      {
        "caBundle": "test",
        "url": "https://test.com"
      }
    ]
  },
  "status" : { }
}

1.1.2.3. 단일 클러스터 쿼리

GET /cluster.open-cluster-management.io/v1/managedclusters/{cluster_name}
1.1.2.3.1. 설명

자세한 내용은 단일 클러스터를 쿼리합니다.

1.1.2.3.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

cluster_name
required

쿼리할 클러스터의 이름입니다.

string

1.1.2.3.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.1.2.3.4. 태그
  • cluster.open-cluster-management.io

1.1.2.4. 클러스터 삭제

DELETE /cluster.open-cluster-management.io/v1/managedclusters/{cluster_name}
DELETE /hive.openshift.io/v1/{cluster_name}/clusterdeployments/{cluster_name}
1.1.2.4.1. 설명

단일 클러스터 삭제

1.1.2.4.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

cluster_name
required

삭제할 클러스터의 이름입니다.

string

1.1.2.4.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.1.2.4.4. 태그
  • cluster.open-cluster-management.io

1.1.3. 정의

1.1.3.1. Cluster

이름스키마

apiVersion
필요

string

kind
필수

string

메타데이터
필요

object

spec
필수

spec

spec

이름스키마

hubAcceptsClient
required

bool

managedClusterClientConfigs
optional

managedClusterClientConfigs array

leaseDurationSeconds
optional

정수(int32)

managedClusterClientConfigs

이름설명스키마

URL
필요

 

string

cabundle
선택 사항

Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"

문자열(바이트)

1.2. Clustersets API (v1beta1)

1.2.1. 개요

이 문서는 Red Hat Advanced Cluster Management for Kubernetes의 Clusterset 리소스에 대한 것입니다. Clusterset 리소스에는 생성, 쿼리, 삭제 및 업데이트 등 네 가지 요청이 있습니다.

1.2.1.1. 버전 정보

버전 : 2.5.0

1.2.1.2. URI 스키마

BasePath : /kubernetes/apis
Schemes : HTTPS

1.2.1.3. 태그

  • cluster.open-cluster-management.io : Clustersets 생성 및 관리

1.2.2. 경로

1.2.2.1. 모든 클러스터 세트 쿼리

GET /cluster.open-cluster-management.io/v1beta1/managedclustersets
1.2.2.1.1. 설명

자세한 내용은 클러스터 세트를 쿼리합니다.

1.2.2.1.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

1.2.2.1.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.2.2.1.4. Use
  • clusterset/yaml
1.2.2.1.5. 태그
  • cluster.open-cluster-management.io

1.2.2.2. 클러스터 세트 생성

POST /cluster.open-cluster-management.io/v1beta1/managedclustersets
1.2.2.2.1. 설명

클러스터 세트를 생성합니다.

1.2.2.2.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

body

본문
필요

생성할 clusterset을 설명하는 매개변수입니다.

Clusterset

1.2.2.2.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.2.2.2.4. Use
  • clusterset/yaml
1.2.2.2.5. 태그
  • cluster.open-cluster-management.io
1.2.2.2.6. HTTP 요청의 예
1.2.2.2.6.1. 요청 본문
{
  "apiVersion": "cluster.open-cluster-management.io/v1beta1",
  "kind": "ManagedClusterSet",
  "metadata": {
    "name": "clusterset1"
  },
  "spec": {
    "clusterSelector": {
      "selectorType": "LegacyClusterSetLabel"
    }
  },
  "status": {}
}

1.2.2.3. 단일 클러스터 세트 쿼리

GET /cluster.open-cluster-management.io/v1beta1/managedclustersets/{clusterset_name}
1.2.2.3.1. 설명

자세한 내용은 단일 클러스터 세트를 쿼리합니다.

1.2.2.3.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

clusterset_name
required

쿼리할 클러스터 세트의 이름입니다.

string

1.2.2.3.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.2.2.3.4. 태그
  • cluster.open-cluster-management.io

1.2.2.4. 클러스터 세트 삭제

DELETE /cluster.open-cluster-management.io/v1beta1/managedclustersets/{clusterset_name}
1.2.2.4.1. 설명

단일 클러스터 세트를 삭제합니다.

1.2.2.4.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

clusterset_name
required

삭제할 클러스터 세트의 이름입니다.

string

1.2.2.4.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.2.2.4.4. 태그
  • cluster.open-cluster-management.io

1.2.3. 정의

1.2.3.1. Clusterset

이름스키마

apiVersion
필요

string

kind
필수

string

메타데이터
필요

object

1.3. Clustersetbindings API (v1beta1)

1.3.1. 개요

이 문서는 Red Hat Advanced Cluster Management for Kubernetes의 clustersetbinding 리소스에 대한 것입니다. Clustersetbinding 리소스에는 생성, 쿼리, 삭제, 업데이트 등 네 가지 요청이 있습니다.

1.3.1.1. 버전 정보

버전 : 2.5.0

1.3.1.2. URI 스키마

BasePath : /kubernetes/apis
Schemes : HTTPS

1.3.1.3. 태그

  • cluster.open-cluster-management.io : clustersetbindings 생성 및 관리

1.3.2. 경로

1.3.2.1. 모든 clustersetbindings 쿼리

GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/managedclustersetbindings
1.3.2.1.1. 설명

자세한 내용은 clustersetbindings를 쿼리합니다.

1.3.2.1.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

네임스페이스
필요

사용하려는 네임스페이스(예: default)입니다.

string

1.3.2.1.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.3.2.1.4. Use
  • clustersetbinding/yaml
1.3.2.1.5. 태그
  • cluster.open-cluster-management.io

1.3.2.2. clustersetbinding 생성

POST /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/managedclustersetbindings
1.3.2.2.1. 설명

clustersetbinding을 생성합니다.

1.3.2.2.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

네임스페이스
필요

사용하려는 네임스페이스(예: default)입니다.

string

body

본문
필요

생성할 clustersetbinding을 설명하는 매개변수입니다.

clustersetbinding

1.3.2.2.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.3.2.2.4. Use
  • clustersetbinding/yaml
1.3.2.2.5. 태그
  • cluster.open-cluster-management.io
1.3.2.2.6. HTTP 요청의 예
1.3.2.2.6.1. 요청 본문
{
  "apiVersion" : "cluster.open-cluster-management.io/v1beta1",
  "kind" : "ManagedClusterSetBinding",
  "metadata" : {
    "name" : "clusterset1",
    "namespace" : "ns1"
  },
 "spec": {
    "clusterSet": "clusterset1"
  },
  "status" : { }
}

1.3.2.3. 단일 clustersetbinding 쿼리

GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/managedclustersetbindings/{clustersetbinding_name}
1.3.2.3.1. 설명

자세한 내용은 단일 clustersetbinding을 쿼리합니다.

1.3.2.3.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

네임스페이스
필요

사용하려는 네임스페이스(예: default)입니다.

string

경로

clustersetbinding_name
required

쿼리할 clustersetbinding의 이름입니다.

string

1.3.2.3.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.3.2.3.4. 태그
  • cluster.open-cluster-management.io

1.3.2.4. clustersetbinding 삭제

DELETE /cluster.open-cluster-management.io/v1beta1/managedclustersetbindings/{clustersetbinding_name}
1.3.2.4.1. 설명

단일 clustersetbinding을 삭제합니다.

1.3.2.4.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

네임스페이스
필요

사용하려는 네임스페이스(예: default)입니다.

string

경로

clustersetbinding_name
required

삭제할 clustersetbinding의 이름입니다.

string

1.3.2.4.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.3.2.4.4. 태그
  • cluster.open-cluster-management.io

1.3.3. 정의

1.3.3.1. clustersetbinding

이름스키마

apiVersion
필요

string

kind
필수

string

메타데이터
필요

object

spec
필수

spec

spec

이름스키마

clusterSet
required

string

1.4. Clusterview API (v1alpha1)

1.4.1. 개요

이 문서는 Red Hat Advanced Cluster Management for Kubernetes의 clusterview 리소스에 대한 것입니다. clusterview 리소스는 액세스할 수 있는 관리형 클러스터 및 관리형 클러스터 세트의 목록을 볼 수 있는 CLI 명령을 제공합니다. 사용 가능한 세 가지 요청은 list, get, watch입니다.

1.4.1.1. 버전 정보

버전 : 2.5.0

1.4.1.2. URI 스키마

BasePath : /kubernetes/apis
Schemes : HTTPS

1.4.1.3. 태그

  • clusterview.open-cluster-management.io: ID에서 액세스할 수 있는 관리형 클러스터 목록을 확인합니다.

1.4.2. 경로

1.4.2.1. 관리 클러스터 가져오기

GET /managedclusters.clusterview.open-cluster-management.io
1.4.2.1.1. 설명

액세스할 수 있는 관리형 클러스터 목록을 확인합니다.

1.4.2.1.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

1.4.2.1.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.4.2.1.4. Use
  • managedcluster/yaml
1.4.2.1.5. 태그
  • clusterview.open-cluster-management.io

1.4.2.2. 관리형 클러스터 나열

LIST /managedclusters.clusterview.open-cluster-management.io
1.4.2.2.1. 설명

액세스할 수 있는 관리형 클러스터 목록을 확인합니다.

1.4.2.2.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

body

본문
선택 사항

관리 클러스터를 나열할 사용자 ID의 이름입니다.

string

1.4.2.2.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.4.2.2.4. Use
  • managedcluster/yaml
1.4.2.2.5. 태그
  • clusterview.open-cluster-management.io
1.4.2.2.6. HTTP 요청의 예
1.4.2.2.6.1. 요청 본문
{
  "apiVersion" : "clusterview.open-cluster-management.io/v1alpha1",
  "kind" : "ClusterView",
  "metadata" : {
    "name" : "<user_ID>"
  },
  "spec": { },
  "status" : { }
}

1.4.2.3. 관리형 클러스터 세트 조사

WATCH /managedclusters.clusterview.open-cluster-management.io
1.4.2.3.1. 설명

액세스할 수 있는 관리형 클러스터를 확인합니다.

1.4.2.3.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

clusterview_name
optional

조사할 사용자 ID의 이름입니다.

string

1.4.2.3.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.4.2.4. 관리형 클러스터 세트를 나열합니다.

GET /managedclustersets.clusterview.open-cluster-management.io
1.4.2.4.1. 설명

액세스할 수 있는 관리형 클러스터를 나열합니다.

1.4.2.4.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

clusterview_name
optional

조사할 사용자 ID의 이름입니다.

string

1.4.2.4.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.4.2.5. 관리형 클러스터 세트를 나열합니다.

LIST /managedclustersets.clusterview.open-cluster-management.io
1.4.2.5.1. 설명

액세스할 수 있는 관리형 클러스터를 나열합니다.

1.4.2.5.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

clusterview_name
optional

조사할 사용자 ID의 이름입니다.

string

1.4.2.5.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.4.2.6. 관리형 클러스터 세트를 확인합니다.

WATCH /managedclustersets.clusterview.open-cluster-management.io
1.4.2.6.1. 설명

액세스할 수 있는 관리형 클러스터를 확인합니다.

1.4.2.6.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

clusterview_name
optional

조사할 사용자 ID의 이름입니다.

string

1.4.2.6.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.5. 채널 API

1.5.1. 개요

이 문서는 Red Hat Advanced Cluster Management for Kubernetes의 채널 리소스에 대한 것입니다. Channel 리소스에는 생성, 쿼리, 삭제, 업데이트 등 네 가지 요청이 있습니다.

1.5.1.1. 버전 정보

버전 : 2.5.0

1.5.1.2. URI 스키마

BasePath : /kubernetes/apis
Schemes : HTTPS

1.5.1.3. 태그

  • channels.apps.open-cluster-management.io : 배포 가능 생성 및 관리

1.5.2. 경로

1.5.2.1. 채널 생성

POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels
1.5.2.1.1. 설명

채널을 생성합니다.

1.5.2.1.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

네임스페이스
필요

사용하려는 네임스페이스(예: default)입니다.

string

body

본문
필요

생성할 수 있는 배포 가능 매개변수입니다.

채널

1.5.2.1.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.5.2.1.4. Use
  • application/yaml
1.5.2.1.5. 태그
  • channels.apps.open-cluster-management.io
1.5.2.1.6. HTTP 요청의 예
1.5.2.1.6.1. 요청 본문
{
  "apiVersion": "apps.open-cluster-management.io/v1",
  "kind": "Channel",
  "metadata": {
    "name": "sample-channel",
    "namespace": "default"
  },
  "spec": {
    "configMapRef": {
      "kind": "configmap",
      "name": "info-resource-filter-configmap"
    },
    "pathname": "https://charts.helm.sh/stable",
    "type": "HelmRepo"
  }
}

1.5.2.2. 대상 네임스페이스에 대한 모든 채널 쿼리

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels
1.5.2.2.1. 설명

자세한 내용은 채널을 쿼리합니다.

1.5.2.2.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

네임스페이스
필요

사용하려는 네임스페이스(예: default)입니다.

string

1.5.2.2.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.5.2.2.4. Use
  • application/yaml
1.5.2.2.5. 태그
  • channels.apps.open-cluster-management.io

1.5.2.3. 네임스페이스의 단일 채널 쿼리

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels/{channel_name}
1.5.2.3.1. 설명

자세한 내용은 단일 채널을 쿼리합니다.

1.5.2.3.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

channel_name
required

쿼리할 배포 가능의 이름입니다.

string

경로

네임스페이스
필요

사용하려는 네임스페이스(예: default)입니다.

string

1.5.2.3.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.5.2.3.4. 태그
  • channels.apps.open-cluster-management.io

1.5.2.4. 채널 삭제

DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels/{channel_name}
1.5.2.4.1. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

channel_name
required

삭제할 채널의 이름입니다.

string

경로

네임스페이스
필요

사용하려는 네임스페이스(예: default)입니다.

string

1.5.2.4.2. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.5.2.4.3. 태그
  • channels.apps.open-cluster-management.io

1.5.3. 정의

1.5.3.1. 채널

이름스키마

apiVersion
필요

string

kind
필수

string

메타데이터
필요

object

spec
필수

spec

spec

이름설명스키마

configMapRef
optional

ObjectReference에는 참조된 오브젝트를 검사하거나 수정할 수 있는 충분한 정보가 포함되어 있습니다.

configMapRef

Gates
선택 사항

ChannelGate는 채널로의 승격 기준을 정의합니다.

게이트

경로 이름
필요

 

string

secretRef
optional

ObjectReference에는 참조된 오브젝트를 검사하거나 수정할 수 있는 충분한 정보가 포함되어 있습니다.

secretRef

sourceNamespaces
optional

 

CloudEvent(Namespace, HelmRepo, ObjectBucket, Git, namespace, helmrepo, objectbucket, github) 배열

configMapRef

이름설명스키마

apiVersion
선택 사항

참조의 API 버전입니다.

string

fieldPath
optional

전체 오브젝트가 아닌 오브젝트 조각을 참조하는 경우 이 문자열에는 desiredState.manifest.containers[2]와 같은 유효한 JSON/ Go 필드 액세스 문을 포함해야 합니다. 예를 들어 오브젝트 참조가 Pod 내의 컨테이너에 대한 경우 "spec.containers{name}"(여기서 "name"은 이벤트를 트리거한 컨테이너의 이름을 참조하거나 컨테이너 이름이 "spec.containers[2]"(이 Pod의 컨테이너 2가 있는 컨테이너)이 지정되지 않은 경우와 같은 값으로 사용됩니다. 이 구문은 오브젝트의 일부를 참조하는 잘 정의된 방법만 갖도록 선택됩니다. TODO: 이 설계는 최종적인 것이 아니며 이 필드는 향후 변경될 수 있습니다.

string

kind
선택 사항

일종의 참조자입니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

string

이름
선택 사항

참조의 이름입니다. 더 많은 정보: 이름

string

네임스페이스
선택 사항

참조의 네임스페이스입니다. 자세한 내용은 https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

string

resourceVersion
optional

특정 resourceVersion이 있는 경우 이 참조가 생성되는 것입니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency

string

UID
선택 사항

참조의 UID입니다. 자세한 정보: UID

string

게이트

이름설명스키마

선택 사항
주석

k8s의 일반적인 주석

annotations

labelSelector
optional

레이블 선택기는 리소스 집합에 대한 레이블 쿼리입니다. matchLabels 및 matchExpressions의 결과는 ANDed입니다. 빈 라벨 선택기는 모든 오브젝트와 일치합니다. null 라벨 선택기는 오브젝트와 일치하지 않습니다.

labelSelector

이름
선택 사항

 

string

annotations

이름스키마


선택 사항

string


값은선택 사항입니다.

string

labelSelector

이름설명스키마

matchExpressions
optional

matchExpressions는 라벨 선택기 요구 사항의 목록입니다. 요구 사항은 인증됩니다.

matchExpressions 배열

matchLabels
optional

matchLabels는 {key,value} 쌍의 맵입니다. matchLabels 맵의 단일 {key,value}는 key 필드가 "key"이고, 연산자는 "In"이고 values 배열에는 "value"만 포함된 matchExpressions 요소와 동일합니다. 요구 사항은 인증됩니다.

문자열, 문자열 맵

matchExpressions

이름설명스키마


필요

Key는 선택기가 적용되는 레이블 키입니다.

string

Operator
필요

Operator는 값 집합에 대한 키의 관계를 나타냅니다. 유효한 연산자는 In, NotIn, Exists 및 DoesNotExist입니다.

string


값은선택 사항입니다.

값은 문자열 값의 배열입니다. Operator가 In 또는 NotIn인 경우 값 배열은 비어 있지 않아야 합니다. Operator가 Exists 또는 DoesNotExist인 경우 값 배열은 비어 있어야 합니다. 이 배열은 전략적 병합 패치에서 교체됩니다.

문자열 배열

secretRef

이름설명스키마

apiVersion
선택 사항

참조의 API 버전입니다.

string

fieldPath
optional

전체 오브젝트가 아닌 오브젝트 조각을 참조하는 경우 이 문자열에는 desiredState.manifest.containers[2]와 같은 유효한 JSON/ Go 필드 액세스 문을 포함해야 합니다. 예를 들어 오브젝트 참조가 Pod 내의 컨테이너에 대한 경우 "spec.containers{name}"(여기서 "name"은 이벤트를 트리거한 컨테이너의 이름을 참조하거나 컨테이너 이름이 "spec.containers[2]"(이 Pod의 컨테이너 2가 있는 컨테이너)이 지정되지 않은 경우와 같은 값으로 사용됩니다. 이 구문은 오브젝트의 일부를 참조하는 잘 정의된 방법만 갖도록 선택됩니다. TODO: 이 설계는 최종적인 것이 아니며 이 필드는 향후 변경될 수 있습니다.

string

kind
선택 사항

일종의 참조자입니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

string

이름
선택 사항

참조의 이름입니다. 더 많은 정보: 이름

string

네임스페이스
선택 사항

참조의 네임스페이스입니다. 자세한 내용은 https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

string

resourceVersion
optional

특정 resourceVersion이 있는 경우 이 참조가 생성되는 것입니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency

string

UID
선택 사항

참조의 UID입니다. 추가 정보: UIIDs

string

1.6. 서브스크립션 API

1.6.1. 개요

이 문서는 Red Hat Advanced Cluster Management for Kubernetes의 서브스크립션 리소스에 대한 것입니다. 서브스크립션 리소스에는 생성, 쿼리, 삭제, 업데이트 등 네 가지 요청이 있습니다.

1.6.1.1. 버전 정보

버전 : 2.5.0

1.6.1.2. URI 스키마

BasePath : /kubernetes/apis
Schemes : HTTPS

1.6.1.3. 태그

  • subscriptions.apps.open-cluster-management.io : 서브스크립션 생성 및 관리

1.6.2. 경로

1.6.2.1. 서브스크립션 생성

POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions
1.6.2.1.1. 설명

서브스크립션을 생성합니다.

1.6.2.1.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

네임스페이스
필요

사용하려는 네임스페이스(예: default)입니다.

string

body

본문
필요

생성할 서브스크립션을 설명하는 매개변수입니다.

서브스크립션

1.6.2.1.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.6.2.1.4. Use
  • subscription/yaml
1.6.2.1.5. 태그
  • subscriptions.apps.open-cluster-management.io
1.6.2.1.6. HTTP 요청의 예
1.6.2.1.6.1. 요청 본문
{
  "apiVersion" : "apps.open-cluster-management.io/v1",
  "kind" : "Subscription",
  "metadata" : {
    "name" : "sample_subscription",
    "namespace" : "default",
    "labels" : {
      "app" : "sample_subscription-app"
    },
    "annotations" : {
      "apps.open-cluster-management.io/git-path" : "apps/sample/",
      "apps.open-cluster-management.io/git-branch" : "sample_branch"
    }
  },
  "spec" : {
    "channel" : "channel_namespace/sample_channel",
    "packageOverrides" : [ {
      "packageName" : "my-sample-application",
      "packageAlias" : "the-sample-app",
      "packageOverrides" : [ {
        "path" : "spec",
        "value" : {
          "persistence" : {
            "enabled" : false,
            "useDynamicProvisioning" : false
          },
          "license" : "accept",
          "tls" : {
            "hostname" : "my-mcm-cluster.icp"
          },
          "sso" : {
            "registrationImage" : {
              "pullSecret" : "hub-repo-docker-secret"
            }
          }
        }
      } ]
    } ],
    "placement" : {
      "placementRef" : {
        "kind" : "PlacementRule",
        "name" : "demo-clusters"
      }
    }
  }
}

1.6.2.2. 모든 서브스크립션 쿼리

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions
1.6.2.2.1. 설명

자세한 내용은 서브스크립션을 쿼리합니다.

1.6.2.2.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

네임스페이스
필요

사용하려는 네임스페이스(예: default)입니다.

string

1.6.2.2.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.6.2.2.4. Use
  • subscription/yaml
1.6.2.2.5. 태그
  • subscriptions.apps.open-cluster-management.io

1.6.2.3. 단일 서브스크립션 쿼리

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}
1.6.2.3.1. 설명

자세한 내용은 단일 서브스크립션을 쿼리합니다.

1.6.2.3.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

네임스페이스
필요

사용하려는 네임스페이스(예: default)입니다.

string

경로

subscription_name
required

쿼리할 서브스크립션의 이름입니다.

string

1.6.2.3.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.6.2.3.4. 태그
  • subscriptions.apps.open-cluster-management.io

1.6.2.4. 서브스크립션 삭제

DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}
1.6.2.4.1. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

네임스페이스
필요

사용하려는 네임스페이스(예: default)입니다.

string

경로

subscription_name
required

삭제할 서브스크립션의 이름입니다.

string

1.6.2.4.2. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.6.2.4.3. 태그
  • subscriptions.apps.open-cluster-management.io

1.6.3. 정의

1.6.3.1. 서브스크립션

이름스키마

apiVersion
필요

string

kind
필수

string

메타데이터
필요

metadata

spec
필수

spec

상태
선택 사항

status

metadata

이름스키마

선택 사항
주석

object

레이블
선택 사항

object

이름
선택 사항

string

네임스페이스
선택 사항

string

spec

이름스키마

채널
필요

string

이름
선택 사항

string


를 덮어쓰는 경우선택 사항

배열 덮어쓰기

packageFilter
optional

packageFilter

packageOverrides
optional

packageOverrides 배열

배치
선택 사항

placement

Timewindow
선택 사항

timewindow

덮어쓰기

이름스키마

clusterName
required

string

clusterOverrides
required

오브젝트 배열

packageFilter

이름설명스키마

선택 사항
주석

 

문자열, 문자열 맵

filterRef
optional

 

filterRef

labelSelector
optional

 

labelSelector

버전
선택 사항

Pattern : "()((\\.[0-9])(\\.)|(\\.[0-9])?(\\.[xX]))$"

string

filterRef

이름스키마

이름
선택 사항

string

labelSelector

이름스키마

matchExpressions
optional

matchExpressions 배열

matchLabels
optional

문자열, 문자열 맵

matchExpressions

이름스키마


필요

string

Operator
필요

string


값은선택 사항입니다.

문자열 배열

packageOverrides

이름스키마

packageAlias
optional

string

packageName
required

string

packageOverrides
optional

오브젝트 배열

placement

이름스키마

clusterSelector
optional

clusterSelector

클러스터
선택 사항

클러스터 배열

로컬
선택 사항

boolean

placementRef
optional

placementRef

clusterSelector

이름스키마

matchExpressions
optional

matchExpressions 배열

matchLabels
optional

문자열, 문자열 맵

matchExpressions

이름스키마


필요

string

Operator
필요

string


값은선택 사항입니다.

문자열 배열

클러스터

이름스키마

이름
필요

string

placementRef

이름스키마

apiVersion
선택 사항

string

fieldPath
optional

string

kind
선택 사항

string

이름
선택 사항

string

네임스페이스
선택 사항

string

resourceVersion
optional

string

UID
선택 사항

string

timewindow

이름스키마

daysofweek
optional

문자열 배열


선택 시간

시간 배열


위치선택 사항

string

창 유형
선택 사항

(active, blocked, Active, Blocked)

몇 시간

이름스키마


종료일:선택 사항

string


시작옵션

string

status

이름스키마

lastUpdateTime
optional

문자열(date-time)

메시지
선택 사항

string

단계
선택 사항

string

reason
optional

string


상태
선택 사항

object

1.7. PlacementRules API

1.7.1. 개요

이 문서는 Red Hat Advanced Cluster Management for Kubernetes의 PlacementRule 리소스에 대한 것입니다. PlacementRule 리소스에는 사용 가능한 네 가지 요청(생성, 쿼리, 삭제 및 업데이트)이 있습니다.

1.7.1.1. 버전 정보

버전 : 2.5.0

1.7.1.2. URI 스키마

BasePath : /kubernetes/apis
Schemes : HTTPS

1.7.1.3. 태그

  • placementrules.apps.open-cluster-management.io : 배치 규칙 생성 및 관리

1.7.2. 경로

1.7.2.1. 배치 규칙 생성

POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules
1.7.2.1.1. 설명

배치 규칙을 생성합니다.

1.7.2.1.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

네임스페이스
필요

사용하려는 네임스페이스(예: default)입니다.

string

body

본문
필요

생성할 배치 규칙을 설명하는 매개변수입니다.

PlacementRule

1.7.2.1.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.7.2.1.4. Use
  • application/yaml
1.7.2.1.5. 태그
  • placementrules.apps.open-cluster-management.io
1.7.2.1.6. HTTP 요청의 예
1.7.2.1.6.1. 요청 본문
{
  "apiVersion" : "apps.open-cluster-management.io/v1",
  "kind" : "PlacementRule",
  "metadata" : {
    "name" : "towhichcluster",
    "namespace" : "ns-sub-1"
  },
  "spec" : {
    "clusterConditions" : [ {
      "type": "ManagedClusterConditionAvailable",
      "status": "True"
    } ],
    "clusterSelector" : { }
  }
}

1.7.2.2. 모든 배치 규칙 쿼리

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules
1.7.2.2.1. 설명

자세한 내용은 배치 규칙을 쿼리합니다.

1.7.2.2.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

네임스페이스
필요

사용하려는 네임스페이스(예: default)입니다.

string

1.7.2.2.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.7.2.2.4. Use
  • application/yaml
1.7.2.2.5. 태그
  • placementrules.apps.open-cluster-management.io

1.7.2.3. 단일 배치 오차 쿼리

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules/{placementrule_name}
1.7.2.3.1. 설명

자세한 내용은 단일 배치 규칙을 쿼리합니다.

1.7.2.3.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

네임스페이스
필요

사용하려는 네임스페이스(예: default)입니다.

string

경로

placementrule_name
required

쿼리할 배치 유형의 이름입니다.

string

1.7.2.3.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.7.2.3.4. 태그
  • placementrules.apps.open-cluster-management.io

1.7.2.4. 배치 유형 삭제

DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules/{placementrule_name}
1.7.2.4.1. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

네임스페이스
필요

사용하려는 네임스페이스(예: default)입니다.

string

경로

placementrule_name
required

삭제할 배치 유형의 이름입니다.

string

1.7.2.4.2. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.7.2.4.3. 태그
  • placementrules.apps.open-cluster-management.io

1.7.3. 정의

1.7.3.1. Placementrule

이름스키마

apiVersion
필요

string

kind
필수

string

메타데이터
필요

object

spec
필수

spec

spec

이름스키마

clusterConditions
optional

clusterConditions 배열

clusterReplicas
optional

integer

clusterSelector
optional

clusterSelector

클러스터
선택 사항

클러스터 배열

정책
선택 사항

정책 배열

resourceHint
optional

resourceHint

schedulerName
optional

string

clusterConditions

이름스키마

상태
선택 사항

string


선택사항

string

clusterSelector

이름스키마

matchExpressions
optional

matchExpressions 배열

matchLabels
optional

문자열, 문자열 맵

matchExpressions

이름스키마


선택 사항

string

Operator
선택 사항

string


값은선택 사항입니다.

문자열 배열

클러스터

이름스키마

이름
선택 사항

string

Policies

이름스키마

apiVersion
선택 사항

string

fieldPath
optional

string

kind
선택 사항

string

이름
선택 사항

string

네임스페이스
선택 사항

string

resourceVersion
optional

string

UID
선택 사항

string

resourceHint

이름스키마

주문
선택 사항

string


선택사항

string

1.8. 애플리케이션 API

1.8.1. 개요

이 문서는 Red Hat Advanced Cluster Management for Kubernetes용 애플리케이션 리소스를 위한 것입니다. 애플리케이션 리소스에는 생성, 쿼리, 삭제 및 업데이트 등 네 가지 요청이 있습니다.

1.8.1.1. 버전 정보

버전 : 2.5.0

1.8.1.2. URI 스키마

BasePath : /kubernetes/apis
Schemes : HTTPS

1.8.1.3. 태그

  • applications.app.k8s.io : 애플리케이션 생성 및 관리

1.8.2. 경로

1.8.2.1. 애플리케이션 생성

POST /app.k8s.io/v1beta1/namespaces/{namespace}/applications
1.8.2.1.1. 설명

애플리케이션을 생성합니다.

1.8.2.1.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

네임스페이스
필요

사용하려는 네임스페이스(예: default)입니다.

string

body

본문
필요

생성할 애플리케이션을 설명하는 매개변수입니다.

애플리케이션

1.8.2.1.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.8.2.1.4. Use
  • application/yaml
1.8.2.1.5. 태그
  • applications.app.k8s.io
1.8.2.1.6. HTTP 요청의 예
1.8.2.1.6.1. 요청 본문
{
  "apiVersion" : "app.k8s.io/v1beta1",
  "kind" : "Application",
  "metadata" : {
    "labels" : {
      "app" : "nginx-app-details"
    },
    "name" : "nginx-app-3",
    "namespace" : "ns-sub-1"
  },
  "spec" : {
    "componentKinds" : [ {
      "group" : "apps.open-cluster-management.io",
      "kind" : "Subscription"
    } ]
  },
  "selector" : {
    "matchLabels" : {
      "app" : "nginx-app-details"
    }
  },
  "status" : { }
}

1.8.2.2. 모든 애플리케이션 쿼리

GET /app.k8s.io/v1beta1/namespaces/{namespace}/applications
1.8.2.2.1. 설명

자세한 내용은 애플리케이션을 쿼리합니다.

1.8.2.2.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

네임스페이스
필요

사용하려는 네임스페이스(예: default)입니다.

string

1.8.2.2.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.8.2.2.4. Use
  • application/yaml
1.8.2.2.5. 태그
  • applications.app.k8s.io

1.8.2.3. 단일 애플리케이션 쿼리

GET /app.k8s.io/v1beta1/namespaces/{namespace}/applications/{application_name}
1.8.2.3.1. 설명

자세한 내용은 단일 애플리케이션을 쿼리합니다.

1.8.2.3.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

application_name
required

쿼리할 애플리케이션의 이름입니다.

string

경로

네임스페이스
필요

사용하려는 네임스페이스(예: default)입니다.

string

1.8.2.3.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.8.2.3.4. 태그
  • applications.app.k8s.io

1.8.2.4. 애플리케이션 삭제

DELETE /app.k8s.io/v1beta1/namespaces/{namespace}/applications/{application_name}
1.8.2.4.1. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

application_name
required

삭제할 애플리케이션의 이름입니다.

string

경로

네임스페이스
필요

사용하려는 네임스페이스(예: default)입니다.

string

1.8.2.4.2. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.8.2.4.3. 태그
  • applications.app.k8s.io

1.8.3. 정의

1.8.3.1. 애플리케이션

이름스키마

apiVersion
필요

string

kind
필수

string

메타데이터
필요

object

spec
필수

spec

spec

이름스키마

assemblyPhase
optional

string

componentKinds
optional

오브젝트 배열

descriptor
optional

descriptor


에 대한 자세한내용은선택 사항

정보 배열

선택기
선택 사항

object

descriptor

이름스키마


선택 사항

string

아이콘
선택 사항

icons 배열

keywords
optional

문자열 배열

링크
선택 사항

Link array

유지 관리자
선택 사항

유지 관리자 배열


선택 사항

string

소유자
선택 사항

소유자 배열


선택사항

string

버전
선택 사항

string

아이콘

이름스키마

크기
선택 사항

string

test-
필수

string


선택사항

string

이름스키마


선택 사항

string

URL
선택 사항

string

유지 관리자

이름스키마

이메일
선택 사항

string

이름
선택 사항

string

URL
선택 사항

string

소유자

이름스키마

이메일
선택 사항

string

이름
선택 사항

string

URL
선택 사항

string

info

이름스키마

이름
선택 사항

string


선택사항

string


값은선택 사항입니다.

string

valueFrom
optional

valueFrom

valueFrom

이름스키마

configMapKeyRef
optional

configMapKeyRef

ingressRef
optional

ingressRef

secretKeyRef
optional

secretKeyRef

serviceRef
optional

serviceRef


선택사항

string

configMapKeyRef

이름스키마

apiVersion
선택 사항

string

fieldPath
optional

string


선택 사항

string

kind
선택 사항

string

이름
선택 사항

string

네임스페이스
선택 사항

string

resourceVersion
optional

string

UID
선택 사항

string

ingressRef

이름스키마

apiVersion
선택 사항

string

fieldPath
optional

string

호스트
선택 사항

string

kind
선택 사항

string

이름
선택 사항

string

네임스페이스
선택 사항

string

경로
선택 사항

string

resourceVersion
optional

string

UID
선택 사항

string

secretKeyRef

이름스키마

apiVersion
선택 사항

string

fieldPath
optional

string


선택 사항

string

kind
선택 사항

string

이름
선택 사항

string

네임스페이스
선택 사항

string

resourceVersion
optional

string

UID
선택 사항

string

serviceRef

이름스키마

apiVersion
선택 사항

string

fieldPath
optional

string

kind
선택 사항

string

이름
선택 사항

string

네임스페이스
선택 사항

string

경로
선택 사항

string


포트선택 사항

정수(int32)

resourceVersion
optional

string

UID
선택 사항

string

1.9. Helm API

1.9.1. 개요

이 문서는 Red Hat Advanced Cluster Management for Kubernetes의 HelmRelease 리소스에 대한 것입니다. HelmRelease 리소스에는 생성, 쿼리, 삭제, 업데이트 등 네 가지 요청이 있습니다.

1.9.1.1. 버전 정보

버전 : 2.5.0

1.9.1.2. URI 스키마

BasePath : /kubernetes/apis
Schemes : HTTPS

1.9.1.3. 태그

  • helmreleases.apps.open-cluster-management.io : helmreleases 생성 및 관리

1.9.2. 경로

1.9.2.1. helmrelease 생성

POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases
1.9.2.1.1. 설명

helmrelease를 생성합니다.

1.9.2.1.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

네임스페이스
필요

사용하려는 네임스페이스(예: default)입니다.

string

body

본문
필요

생성할 helmrelease를 설명하는 매개변수입니다.

HelmRelease

1.9.2.1.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.9.2.1.4. Use
  • application/yaml
1.9.2.1.5. 태그
  • helmreleases.apps.open-cluster-management.io
1.9.2.1.6. HTTP 요청의 예
1.9.2.1.6.1. 요청 본문
{
  "apiVersion" : "apps.open-cluster-management.io/v1",
  "kind" : "HelmRelease",
  "metadata" : {
    "name" : "nginx-ingress",
    "namespace" : "default"
  },
  "repo" : {
    "chartName" : "nginx-ingress",
    "source" : {
      "helmRepo" : {
        "urls" : [ "https://kubernetes-charts.storage.googleapis.com/nginx-ingress-1.26.0.tgz" ]
      },
      "type" : "helmrepo"
    },
    "version" : "1.26.0"
  },
  "spec" : {
    "defaultBackend" : {
      "replicaCount" : 3
    }
  }
}

1.9.2.2. 모든 helmreleases 쿼리

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases
1.9.2.2.1. 설명

자세한 내용은 helmreleases를 쿼리합니다.

1.9.2.2.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

네임스페이스
필요

사용하려는 네임스페이스(예: default)입니다.

string

1.9.2.2.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.9.2.2.4. Use
  • application/yaml
1.9.2.2.5. 태그
  • helmreleases.apps.open-cluster-management.io

1.9.2.3. 단일 helmrelease 쿼리

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases/{helmrelease_name}
1.9.2.3.1. 설명

자세한 내용은 단일 helmrelease를 쿼리합니다.

1.9.2.3.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

helmrelease_name
required

쿼리할 helmrelease의 이름입니다.

string

경로

네임스페이스
필요

사용하려는 네임스페이스(예: default)입니다.

string

1.9.2.3.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.9.2.3.4. 태그
  • helmreleases.apps.open-cluster-management.io

1.9.2.4. helmrelease 삭제

DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases/{helmrelease_name}
1.9.2.4.1. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

helmrelease_name
required

삭제할 helmrelease의 이름입니다.

string

경로

네임스페이스
필요

사용하려는 네임스페이스(예: default)입니다.

string

1.9.2.4.2. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.9.2.4.3. 태그
  • helmreleases.apps.open-cluster-management.io

1.9.3. 정의

1.9.3.1. HelmRelease

이름스키마

apiVersion
필요

string

kind
필수

string

메타데이터
필요

object

리포지터리
필요

repo

spec
필수

object


필수 상태

status

repo

이름스키마

chartName
optional

string

configMapRef
optional

configMapRef

secretRef
optional

secretRef

소스
선택 사항

source

버전
선택 사항

string

configMapRef

이름스키마

apiVersion
선택 사항

string

fieldPath
optional

string

kind
선택 사항

string

이름
선택 사항

string

네임스페이스
선택 사항

string

resourceVersion
optional

string

UID
선택 사항

string

secretRef

이름스키마

apiVersion
선택 사항

string

fieldPath
optional

string

kind
선택 사항

string

이름
선택 사항

string

네임스페이스
선택 사항

string

resourceVersion
optional

string

UID
선택 사항

string

source

이름스키마

github
optional

github

helmRepo
optional

helmRepo


선택사항

string

github

이름스키마

분기
선택 사항

string

chartPath
optional

string

URL
선택 사항

문자열 배열

helmRepo

이름스키마

URL
선택 사항

문자열 배열

status

이름스키마


필수 조건

conditions 배열

deployedRelease
optional

deployedRelease

conditions

이름스키마

lastTransitionTime
optional

문자열(date-time)

메시지
선택 사항

string

reason
optional

string


필수 상태

string


필수항목 입력

string

deployedRelease

이름스키마

매니페스트
선택 사항

string

이름
선택 사항

string

1.10. 정책 API

1.10.1. 개요

이 문서는 Red Hat Advanced Cluster Management for Kubernetes의 정책 리소스를 위한 것입니다. Policy 리소스에는 생성, 쿼리, 삭제, 업데이트 등 네 가지 요청이 있습니다.

1.10.1.1. 버전 정보

버전 : 2.5.0

1.10.1.2. URI 스키마

BasePath : /kubernetes/apis
Schemes : HTTPS

1.10.1.3. 태그

  • policy.open-cluster-management.io/v1 : 정책 생성 및 관리

1.10.2. 경로

1.10.2.1. 정책 생성

POST /policy.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}
1.10.2.1.1. 설명

정책을 생성합니다.

1.10.2.1.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

네임스페이스
필요

사용하려는 네임스페이스(예: default)입니다.

string

body

본문
필요

생성할 정책을 설명하는 매개변수입니다.

애플리케이션

1.10.2.1.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.10.2.1.4. Use
  • application/json
1.10.2.1.5. 태그
  • policy.open-cluster-management.io
1.10.2.1.6. HTTP 요청의 예
1.10.2.1.6.1. 요청 본문
{
  "apiVersion": "policy.open-cluster-management.io/v1",
  "kind": "Policy",
  "metadata": {
    "name": "test-policy-swagger",
    "description": "Example body for Policy API Swagger docs"
  },
  "spec": {
    "remediationAction": "enforce",
    "namespaces": {
      "include": [
        "default"
      ],
      "exclude": [
        "kube*"
      ]
    },
    "policy-templates": {
    "kind": "ConfigurationPolicy",
    "apiVersion": "policy.open-cluster-management.io/v1",
    "complianceType": "musthave",
    "metadataComplianceType": "musthave",
    "metadata": {
      "namespace": null,
      "name": "test-role"
    },
    "selector": {
      "matchLabels": {
        "cloud": "IBM"
      }
    },
    "spec" : {
      "object-templates": {
        "complianceType": "musthave",
        "metadataComplianceType": "musthave",
        "objectDefinition": {
          "apiVersion": "rbac.authorization.k8s.io/v1",
          "kind": "Role",
          "metadata": {
            "name": "role-policy",
          },
          "rules": [
            {
              "apiGroups": [
                "extensions",
                "apps"
              ],
              "resources": [
                "deployments"
              ],
              "verbs": [
                "get",
                "list",
                "watch",
                "delete"
              ]
            },
            {
              "apiGroups": [
                "core"
              ],
              "resources": [
                "pods"
              ],
              "verbs": [
                "create",
                "update",
                "patch"
              ]
            },
            {
              "apiGroups": [
                "core"
              ],
              "resources": [
                "secrets"
              ],
              "verbs": [
                "get",
                "watch",
                "list",
                "create",
                "delete",
                "update",
                "patch"
              ],
            },
          ],
        },
      },
    },
  },

1.10.2.2. 모든 정책 쿼리

GET /policy.open-cluster-management.io/v1/namespaces/{namespace}/policies/{policy_name}
1.10.2.2.1. 설명

자세한 내용은 정책을 쿼리합니다.

1.10.2.2.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

네임스페이스
필요

정책을 적용하려는 네임스페이스(예: default)입니다.

string

1.10.2.2.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.10.2.2.4. Use
  • application/json
1.10.2.2.5. 태그
  • policy.open-cluster-management.io

1.10.2.3. 단일 정책 쿼리

GET /policy.open-cluster-management.io/v1/namespaces/{namespace}/policies/{policy_name}
1.10.2.3.1. 설명

자세한 내용은 단일 정책을 쿼리합니다.

1.10.2.3.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

policy_name
required

쿼리할 정책의 이름입니다.

string

경로

네임스페이스
필요

사용하려는 네임스페이스(예: default)입니다.

string

1.10.2.3.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.10.2.3.4. 태그
  • policy.open-cluster-management.io

1.10.2.4. 정책 삭제

DELETE /policy.open-cluster-management.io/v1/namespaces/{namespace}/policies/{policy_name}
1.10.2.4.1. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

policy_name
required

삭제할 정책의 이름입니다.

string

경로

네임스페이스
필요

사용하려는 네임스페이스(예: default)입니다.

string

1.10.2.4.2. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.10.2.4.3. 태그
  • policy.open-cluster-management.io

1.10.3. 정의

1.10.3.1. 정책

이름설명스키마

apiVersion
필요

버전이 지정된 정책 스키마입니다.

string

kind
필수

REST 리소스를 나타내는 문자열 값입니다.

string

메타데이터
필요

정책을 정의하는 규칙을 설명합니다.

object

spec

이름설명스키마

remediationAction
optional

리소스에 정의된 대로 위반을 처리하는 방법을 나타내는 값입니다.Values that represents how violations are handled as defined in the resource.

string

namespaceSelector
required

정책이 적용되는 네임스페이스를 나타내는 값입니다.

string

policy-templates

이름설명스키마

apiVersion
필요

버전이 지정된 정책 스키마입니다.

string

kind
선택 사항

REST 리소스를 나타내는 문자열 값입니다.

string

메타데이터
필요

정책을 정의하는 규칙을 설명합니다.

object

complianceType

관리 클러스터에 평가하거나 적용해야 하는 역할 및 기타 Kubernetes 오브젝트의 예상 동작을 나열하는 데 사용됩니다.

string

metadataComplianceType
optional

사용자가 다른 필드와 다른 오브젝트의 레이블 및 주석을 처리하는 방법을 제공합니다. 매개변수 값은 기본적으로 ComplianceType 매개변수의 동일한 값으로 설정됩니다.

string

clusterConditions
optional

레이블을 정의하는 섹션입니다.

string

규칙
선택 사항

 

string

clusterConditions

이름설명스키마

matchLabels
optional

정책을 네임스페이스에 적용하는 데 필요한 레이블입니다.

object

Cloud
선택 사항

정책을 클라우드 공급자에 적용하는 데 필요한 레이블입니다.

string

규칙

이름설명스키마

apiGroups
필요

규칙이 적용되는 API 목록입니다.

string

리소스
필요

리소스 유형 목록입니다.

object


동사필수

동사 목록입니다.

string

1.11. 관찰 기능 API

1.11.1. 개요

이 문서는 Kubernetes용 Red Hat Advanced Cluster Management의 MultiClusterObservability 리소스를 위한 것입니다. MultiClusterObservability 리소스에는 생성, 쿼리, 삭제 및 업데이트의 네 가지 가능한 요청이 있습니다.

1.11.1.1. 버전 정보

버전 : 2.5.0

1.11.1.2. URI 스키마

BasePath : /kubernetes/apis
Schemes : HTTPS

1.11.1.3. 태그

  • observability.open-cluster-management.io : 멀티clusterobservabilities 생성 및 관리

1.11.2. 경로

1.11.2.1. Multiclusterobservability 리소스 생성

POST /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities
1.11.2.1.1. 설명

MultiClusterObservability 리소스를 생성합니다.

1.11.2.1.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

body

본문
필요

생성할 MultiClusterObservability 리소스를 설명하는 매개변수입니다.

MultiClusterObservability

1.11.2.1.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.11.2.1.4. Use
  • application/yaml
1.11.2.1.5. 태그
  • observability.apps.open-cluster-management.io
1.11.2.1.6. HTTP 요청의 예
1.11.2.1.6.1. 요청 본문
{
  "apiVersion": "observability.open-cluster-management.io/v1beta2",
  "kind": "MultiClusterObservability",
  "metadata": {
    "name": "example"
  },
  "spec": {
    "observabilityAddonSpec": {}
    "storageConfig": {
      "metricObjectStorage": {
        "name": "thanos-object-storage",
        "key": "thanos.yaml"
      "writeStorage": {
        - "key": " ",
          "name" : " "
        - "key": " ",
          "name" : " "
         }
       }
   }
}

1.11.2.2. 모든 멀티clusterobservabilities 쿼리

GET /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities
1.11.2.2.1. 설명

자세한 내용은 MultiClusterObservability 리소스를 쿼리합니다.

1.11.2.2.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

1.11.2.2.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.11.2.2.4. Use
  • application/yaml
1.11.2.2.5. 태그
  • observability.apps.open-cluster-management.io

1.11.2.3. 단일 다중 클러스터 관찰 기능 쿼리

GET /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities/{multiclusterobservability_name}
1.11.2.3.1. 설명

자세한 내용은 단일 MultiClusterObservability 리소스를 쿼리합니다.

1.11.2.3.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

multiclusterobservability_name
required

쿼리할 다중 clusterobservability의 이름입니다.

string

1.11.2.3.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.11.2.3.4. 태그
  • observability.apps.open-cluster-management.io

1.11.2.4. Multiclusterobservability 리소스 삭제

DELETE /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities/{multiclusterobservability_name}
1.11.2.4.1. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

multiclusterobservability_name
required

삭제할 멀티clusterobservability의 이름입니다.

string

1.11.2.4.2. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.11.2.4.3. 태그
  • observability.apps.open-cluster-management.io

1.11.3. 정의

1.11.3.1. MultiClusterObservability

이름설명스키마

apiVersion
필요

버전이 지정된 MultiClusterObservability 스키마입니다.

string

kind
필수

REST 리소스인 MultiClusterObservability를 나타내는 문자열 값입니다.

string

메타데이터
필요

정책을 정의하는 규칙을 설명합니다.

object

spec

이름설명스키마

enableDownsampling
optional

downsample을 활성화하거나 비활성화합니다. 기본값은 true 입니다. 다운샘플 데이터가 없으면 쿼리를 사용할 수 없습니다.

boolean

imagePullPolicy
optional

MultiClusterObservability 이미지에 대한 가져오기 정책입니다. 기본값은 Always입니다.

corev1.PullPolicy

imagePullSecret
optional

MultiClusterObservability 이미지에 대한 풀 시크릿입니다. 기본값은 multiclusterhub-operator-pull-secret입니다.

string

nodeSelector
optional

노드 선택기의 사양입니다.

map[string]string

observabilityAddonSpec
required

관찰 기능 애드온이 설치된 모든 관리 클러스터에 대한 글로벌 설정입니다.

observabilityAddonSpec

storageConfig
required

관찰 기능에서 사용할 스토리지 구성을 지정합니다.

StorageConfig

허용 오차
선택 사항

모든 구성 요소에서 테인트를 허용할 수 있는 기능이 제공됩니다.

[]corev1.Toleration

advanced
optional

관찰을 위한 고급 구성 설정입니다.

advanced

리소스
선택 사항

MultiClusterObservability에 필요한 컴퓨팅 리소스입니다.

corev1.ResourceRequirements

복제본
선택 사항

MultiClusterObservability에 대한 복제본입니다.

integer

storageConfig

이름설명스키마

alertmanagerStorageSize
optional

alertmanager 상태 저장 세트에 적용되는 스토리지 양입니다. 기본값은 1Gi 입니다.

string

compactStorageSize
optional

thanos 컴팩트 상태 저장 세트에 적용되는 스토리지 양입니다. 기본값은 100Gi 입니다.

string

metricObjectStorage
required

메트릭에 대한 시크릿을 구성하는 오브젝트 저장소입니다.

metricObjectStorage

receiveStorageSize
optional

thanos에 적용되는 스토리지 양은 상태 저장 세트를 수신합니다. 기본값은 100Gi 입니다.

string

ruleStorageSize
optional

thanos 규칙 상태 저장 세트에 적용되는 스토리지 양입니다. 기본값은 1Gi 입니다.

string

storageClass
optional

storageClass 상태 저장 세트를 지정합니다. 이 스토리지는 운영 체제가 스토리지를 생성하도록 metricObjectStorage 가 구성된 경우 오브젝트 스토리지에 사용됩니다. 기본값은 gp2 입니다.

string

storeStorageSize
optional

thanos 저장소 상태 저장 세트에 적용되는 스토리지 양입니다. 기본값은 10Gi 입니다.

string

writeStorage
optional

끝점 액세스 정보 목록입니다.

[ ]WriteStorage

writeStorage

이름설명스키마

이름
필요

엔드포인트 액세스 정보가 있는 시크릿의 이름입니다.

string


필요

선택할 시크릿의 키입니다.

string

metricObjectStorage

이름설명스키마


필요

선택할 시크릿의 키입니다. 유효한 보안 키여야 합니다. Thanos 문서를 참조하십시오.

string

이름
필요

metricObjectStorage 의 이름입니다. 자세한 내용은 Kubernetes 이름을 참조하십시오.

string

observabilityAddonSpec

이름설명스키마

enableMetrics
optional

관찰 기능 애드온이 허브 클러스터로 메트릭을 전송하는지 여부를 나타냅니다. 기본값은 true 입니다.

boolean


간격선택 사항

관찰 기능 애드온이 허브 클러스터에 지표를 전송할 때의 간격입니다. 기본값은 300초(300초)입니다.

integer

리소스
선택 사항

지표 수집기 리소스 요구 사항의 리소스입니다. 기본 CPU 요청은 100m 이며 메모리 요청은 100Mi 입니다.

corev1.ResourceRequirements

advanced

이름설명스키마

retentionConfig
optional

관찰 기능에서 사용할 데이터 보존 구성을 지정합니다.

RetentionConfig

rbacQueryProxy
optional

rbac-query-proxy 배포의 복제본 및 리소스를 지정합니다.

CommonSpec

grafana
optional

grafana 배포의 복제본 및 리소스를 지정합니다.

CommonSpec

alertmanager
optional

alertmanager statefulset의 복제본 및 리소스를 지정합니다.

CommonSpec

observatoriumAPI
optional

observatorium-api 배포를 위한 복제본 및 리소스를 지정합니다.

CommonSpec

queryFrontend
optional

query-frontend 배포의 복제본 및 리소스를 지정합니다.

CommonSpec


선택적으로 쿼리합니다.

쿼리 배포의 복제본과 리소스를 지정합니다.

CommonSpec


에서선택사항을 수신

수신 상태 저장 세트의 복제본과 리소스를 지정합니다.

CommonSpec

규칙
선택 사항

규칙 statefulset의 복제본 및 리소스를 지정합니다.

CommonSpec


저장소선택 사항입니다.

저장소 상태 저장 세트의 복제본과 리소스를 지정합니다.

CommonSpec

CompactSpec
optional

컴팩트한 statefulset에 대한 리소스를 지정합니다.

compact

storeMemcached
optional

store-memcached의 복제본, 리소스 등을 지정합니다.

storeMemcached

queryFrontendMemcached
optional

query-frontend-memcached의 복제본, 리소스 등을 지정합니다.

CacheConfig

retentionConfig

이름설명스키마

BlockDuration
선택 사항

TSDB(Time Series Database) 블록의 기간을 차단하는 시간입니다. 기본값은 2h 입니다.

string

cleanupInterval
optional

부분적으로 업로드된 블록이 정리되는 빈도와 --wait 가 활성화된 삭제 표시로 차단되는 빈도가 정리됩니다. 기본값은 5m 입니다.

string

deleteDelay
optional

삭제 표시된 블록이 버킷에서 삭제될 때까지의 시간입니다. 기본값은 48h 입니다.

string

retentionInLocal
optional

로컬 스토리지의 원시 샘플을 유지하는 시간입니다. 기본값은 24h 입니다.

string

retentionResolutionRaw
optional

버킷에서 원시 확인 샘플을 유지하는 시간입니다. 기본값은 30일 (30d)입니다.

string

retentionResolution5m
optional

버킷에 해상도 1(5분)의 샘플을 유지하는 데 걸리는 시간입니다. 기본값은 180일(180일)입니다.

string

retentionResolution1h
optional

버킷에서 해결 방법 2 시간 (1시간) 샘플을 유지하는 데 걸리는 시간입니다. 기본값은 0일(0d)입니다.

string

CompactSpec

이름설명스키마

리소스
선택 사항

thanos compact에 필요한 컴퓨팅 리소스

corev1.ResourceRequirements

serviceAccountAnnotations
optional

주석은 컴팩트 서비스 계정으로 저장된 구조화되지 않은 키 값 맵입니다.

map[string]string

storeMemcached

이름설명스키마

리소스
선택 사항

MultiCLusterObservability에 필요한 컴퓨팅 리소스

corev1.ResourceRequirements

복제본
선택 사항

MultiClusterObservability에 대한 복제본입니다.

integer

memoryLimitMb
optional

Memcached의 메모리 제한(MB)입니다.

integer

maxItemSize
optional

Memcached의 최대 항목 크기입니다. 기본값은 1m, min:1k, max:1024m 입니다.

string

connectionLimit
optional

Memcached의 최대 동시 연결 수입니다. 기본값은

integer

status

이름설명스키마

상태
선택 사항

status에는 MultiClusterObservability에 대한 다른 조건 상태가 포함됩니다.

metav1.Condition

CommonSpec

이름설명스키마

리소스
선택 사항

구성 요소에 필요한 컴퓨팅 리소스입니다.

corev1.ResourceRequirements

복제본
선택 사항

구성 요소의 복제본입니다.

integer

QuerySpec

이름

설명

스키마

CommonSpec
optional

쿼리 배포의 복제본과 리소스를 지정합니다.

CommonSpec

serviceAccountAnnotations
optional

주석은 쿼리 서비스 계정으로 저장된 구조화되지 않은 키 값 맵입니다.

map[string]string

ReceiveSpec

이름

설명

스키마

CommonSpec
optional

쿼리 배포의 복제본과 리소스를 지정합니다.

CommonSpec

serviceAccountAnnotations
optional

주석은 쿼리 서비스 계정으로 저장된 구조화되지 않은 키 값 맵입니다.

map[string]string

StoreSpec

이름

설명

스키마

CommonSpec
optional

쿼리 배포의 복제본과 리소스를 지정합니다.

CommonSpec

serviceAccountAnnotations
optional

주석은 쿼리 서비스 계정으로 저장된 구조화되지 않은 키 값 맵입니다.

map[string]string

RuleSpec

이름

설명

스키마

CommonSpec
optional

쿼리 배포의 복제본과 리소스를 지정합니다.

CommonSpec

evalInterval
optional

규칙에 대한 평가 간격을 지정합니다.

string

serviceAccountAnnotations
optional

주석은 쿼리 서비스 계정으로 저장된 구조화되지 않은 키 값 맵입니다.

map[string]string

1.12. 검색 사용자 정의 API

1.12.1. 개요

이 문서는 Red Hat Advanced Cluster Management for Kubernetes의 searchCustomization 리소스에 대한 것입니다. SearchCustomization 리소스에는 생성, 쿼리, 삭제 및 업데이트의 네 가지 요청이 있습니다.

1.12.1.1. 버전 정보

버전 : 2.5.0

1.12.1.2. URI 스키마

BasePath : /kubernetes/apis
Schemes : HTTPS

1.12.1.3. 태그

  • search.open-cluster-management.io/v1 : 지속성 볼륨 생성 및 관리

1.12.2. 경로

1.12.2.1. 검색 사용자 정의 생성

POST /search.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}
1.12.2.1.1. 설명

searchCustomization을 생성합니다.

1.12.2.1.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

네임스페이스
필요

사용하려는 네임스페이스(예: default)입니다.

string

body

본문
필요

생성할 정책을 설명하는 매개변수입니다.

 
1.12.2.1.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.12.2.1.4. Use
  • searchCustomization/json
1.12.2.1.5. 태그
  • search.open-cluster-management.io
1.12.2.1.6. HTTP 요청의 예
1.12.2.1.6.1. 요청 본문
{
  "apiVersion": "search.open-cluster-management.io/v1",
  "kind": "SearchCustomization",
  "metadata": {
    "name": "test-search-swagger",
    "description": "Example body for SearchCustomization API Swagger docs"
  },
  "spec": {
    "remediationAction": "enforce",
    "namespaces": {
      "include": [
        "default"
      ],
      "exclude": [
        "kube*"
      ]
    },
    "policy-templates": {
    "kind": "ConfigurationPolicy",
    "apiVersion": "search.open-cluster-management.io/v1alpha1",
    "complianceType": "musthave",
    "metadata": {
      "namespace": null,
      "name": "test-role"
    },
    "selector": {
      "matchLabels": {
        "cloud": "IBM"
      }
    },
    "spec" : {
      "object-templates": {
        "complianceType": "mustHave",
        "objectDefinition": {
          "apiVersion": "rbac.authorization.k8s.io/v1",
          "kind": "Role",
          "metadata": {
            "name": "role-policy",
          },
          "rules": [
            {
              "apiGroups": [
                "extensions",
                "apps"
              ],
              "resources": [
                "deployments"
              ],
              "verbs": [
                "get",
                "list",
                "watch",
                "delete"
              ]
            },
            {
              "apiGroups": [
                "core"
              ],
              "resources": [
                "pods"
              ],
              "verbs": [
                "create",
                "update",
                "patch"
              ]
            },
            {
              "apiGroups": [
                "core"
              ],
              "resources": [
                "secrets"
              ],
              "verbs": [
                "get",
                "watch",
                "list",
                "create",
                "delete",
                "update",
                "patch"
              ],
            },
          ],
        },
      },
    },
  },

1.12.2.2. query searchCustomization

GET /search.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}
1.12.2.2.1. 설명

자세한 내용은 searchCustomization을 쿼리합니다.

1.12.2.2.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

네임스페이스
필요

정책을 적용하려는 네임스페이스(예: default)입니다.

string

1.12.2.2.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.12.2.2.4. Use
  • searchCustomization/json
1.12.2.2.5. 태그
  • search.open-cluster-management.io

1.12.2.3. 단일 정책 쿼리

GET /search.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}
1.12.2.3.1. 설명

자세한 내용은 단일 searchCustomization을 쿼리합니다.

1.12.2.3.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

policy_name
required

쿼리할 정책의 이름입니다.

string

경로

네임스페이스
필요

사용하려는 네임스페이스(예: default)입니다.

string

1.12.2.3.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.12.2.3.4. 태그
  • search.open-cluster-management.io

1.12.2.4. 검색 사용자 지정 삭제

DELETE /search.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}
1.12.2.4.1. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

policy_name
required

삭제할 정책의 이름입니다.

string

경로

네임스페이스
필요

사용하려는 네임스페이스(예: default)입니다.

string

1.12.2.4.2. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.12.2.4.3. 태그
  • search.open-cluster-management.io

1.12.3. 정의

1.12.3.1. SearchCustomization

이름설명스키마

apiVersion
필요

버전이 지정된 SearchCustomization 스키마입니다.

string

kind
필수

REST 리소스를 나타내는 문자열 값입니다.

string

메타데이터
필요

정책을 정의하는 규칙을 설명합니다.

object

spec

이름설명스키마

remediationAction
optional

리소스에 정의된 대로 위반을 처리하는 방법을 나타내는 값입니다.Values that represents how violations are handled as defined in the resource.

string

네임스페이스
필요

정책을 적용할 때 포함하거나 제외할 네임스페이스를 나타내는 값입니다.

string

policy-templates

이름설명스키마

apiVersion
필요

버전이 지정된 SearchCustomization 스키마입니다.

string

kind
선택 사항

REST 리소스를 나타내는 문자열 값입니다.

string

메타데이터
필요

정책을 정의하는 규칙을 설명합니다.

object

complianceType

관리 클러스터에 평가하거나 적용해야 하는 역할 및 기타 Kubernetes 오브젝트의 예상 동작을 나열하는 데 사용됩니다.

string

clusterConditions
optional

레이블을 정의하는 섹션입니다.

string

규칙
선택 사항

 

string

clusterConditions

이름설명스키마

matchLabels
optional

정책을 네임스페이스에 적용하는 데 필요한 레이블입니다.

object

Cloud
선택 사항

정책을 클라우드 공급자에 적용하는 데 필요한 레이블입니다.

string

규칙

이름설명스키마

apiGroups
필요

규칙이 적용되는 API 목록입니다.

string

리소스
필요

리소스 유형 목록입니다.

object


동사필수

동사 목록입니다.

string

1.13. MultiClusterHub API

1.13.1. 개요

이 문서는 Red Hat Advanced Cluster Management for Kubernetes용 MultiClusterHub 리소스에 대한 것입니다. MultiClusterHub 리소스에는 생성, 쿼리, 삭제 및 업데이트의 네 가지 가능한 요청이 있습니다.

1.13.1.1. 버전 정보

버전 : 2.5.0

1.13.1.2. URI 스키마

BasePath : /kubernetes/apis
Schemes : HTTPS

1.13.1.3. 태그

  • multiclusterhubs.operator.open-cluster-management.io : 멀티 클러스터 허브 Operator 생성 및 관리

1.13.2. 경로

1.13.2.1. MultiClusterHub 리소스 생성

POST /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/mch
1.13.2.1.1. 설명

MultiClusterHub 리소스를 생성하여 다중 클러스터 허브 인스턴스의 구성을 정의합니다.

1.13.2.1.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

네임스페이스
필요

사용하려는 네임스페이스(예: default)입니다.

string

body

본문
필요

생성할 다중 클러스터 허브를 설명하는 매개변수입니다.

정의

1.13.2.1.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.13.2.1.4. Use
  • multiclusterhubs/yaml
1.13.2.1.5. 태그
  • multiclusterhubs.operator.open-cluster-management.io
1.13.2.1.6. HTTP 요청의 예
1.13.2.1.6.1. 요청 본문
{
  "apiVersion": "apiextensions.k8s.io/v1",
  "kind": "CustomResourceDefinition",
  "metadata": {
    "name": "multiclusterhubs.operator.open-cluster-management.io"
    },
  "spec": {
    "group": "operator.open-cluster-management.io",
    "names": {
      "kind": "MultiClusterHub",
      "listKind": "MultiClusterHubList",
      "plural": "multiclusterhubs",
      "shortNames": [
          "mch"
	  ],
     "singular": "multiclusterhub"
     },
    "scope": "Namespaced",
    "versions": [
        {
	    "additionalPrinterColumns": [
                {
		   "description": "The overall status of the multicluster hub.",
                   "jsonPath": ".status.phase",
                   "name": "Status",
                   "type": "string"
		   },
               {
	           "jsonPath": ".metadata.creationTimestamp",
                   "name": "Age",
                   "type": "date"
		   }
            ],
            "name": "v1",
            "schema": {
                "openAPIV3Schema": {
                    "description": "MultiClusterHub defines the configuration for an instance of
          the multiCluster hub.",
        "properties": {
            "apiVersion": {
                "description": "APIVersion defines the versioned schema of this representation
              of an object. Servers should convert recognized schemas to the latest
              internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
                "type": "string"
            },
            "kind": {
                "description": "Kind is a string value representing the REST resource this
              object represents. Servers may infer this from the endpoint the client
              submits requests to. Cannot be updated. The value is in CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
                "type": "string"
            },
            "metadata": {
                "type": "object"
            },
            "spec": {
                "description": "MultiClusterHubSpec defines the desired state of MultiClusterHub.",
                "properties": {
                    "availabilityConfig": {
                        "description": "Specifies deployment replication for improved availability.
                  Options are: Basic and High (default).",
                        "type": "string"
                },
                "customCAConfigmap": {
                    "description": "Provide the customized OpenShift default ingress CA certificate
                  to {product-title-short}.",
                  }
                    "type": "string"
                },
        "disableHubSelfManagement": {
                    "description": "Disable automatic import of the hub cluster as a managed
                  cluster.",
                    "type": "boolean"
                },
        "disableUpdateClusterImageSets": {
                    "description": "Disable automatic update of ClusterImageSets.",
                    "type": "boolean"
                },
                "hive": {
                    "description": "(Deprecated) Overrides for the default HiveConfig specification.",
                    "properties": {
        "additionalCertificateAuthorities": {
        "description": "(Deprecated) AdditionalCertificateAuthorities is
                      a list of references to secrets in the 'hive' namespace that
                      contain an additional Certificate Authority to use when communicating
                      with target clusters. These certificate authorities are
                      used in addition to any self-signed CA generated by each cluster
                      on installation.",
                           "items": {
                    "description": "LocalObjectReference contains the information
                        to let you locate the referenced object inside the same namespace.",
                    "properties": {
                    "name": {
                        "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
                        "type": "string"
                     }
		             },
                    "type": "object"
                      },
                           "type": "array"
                    },
                       "backup": {
                    "description": "(Deprecated) Backup specifies configuration for backup
                      integration. If absent, backup integration is disabled.",
                    "properties": {
                    "minBackupPeriodSeconds": {
                    "description": "(Deprecated) MinBackupPeriodSeconds specifies
                          that a minimum of MinBackupPeriodSeconds occurs in between
                          each backup. This is used to rate limit backups. This potentially
                          batches together multiple changes into one backup. No backups
                          are lost for changes that happen during the interval
                          that is queued up, and results in a backup once
                          the interval has been completed.",
                    "type": "integer"
                        },
                    "velero": {
                    "description": "(Deprecated) Velero specifies configuration for the Velero backup integration.",
		    "properties": {
			"enabled": {
			    "description": "(Deprecated) Enabled dictates if the Velero backup integration is enabled. If not specified, the default is disabled.",
			    "type": "boolean"
			}
		   },
		    "type": "object"
				        }
				  },
				        "type": "object"
				     },
		    "externalDNS": {
		    "description": "(Deprecated) ExternalDNS specifies configuration for external-dns if it is to be deployed by Hive. If absent, external-dns is not deployed.",
		    "properties": {
		    "aws": {
		    "description": "(Deprecated) AWS contains AWS-specific settings for external DNS.",
		    "properties": {
		        "credentials": {
			    "description": "(Deprecated) Credentials reference a secret that is used to authenticate with AWS Route53. It needs permission to manage entries in each of the managed domains for this cluster. Secret should have AWS keys named 'aws_access_key_id' and 'aws_secret_access_key'.",
			    "properties": {
				"name": {
																		            "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
																		                             "type": "string"
						    }
					},
			    "type": "object"
			}
		},
		   "type": "object"
					},
		   "gcp": {
		   "description": "(Deprecated) GCP contains Google Cloud Platform specific settings for external DNS.",
		   "properties": {
		       "credentials": {
			   "description": "(Deprecated) Credentials reference a secret that is used to authenticate with GCP DNS. It needs permission to manage entries in each of the managed domains for this cluster. Secret should have a key names 'osServiceAccount.json'. The credentials must specify the project to use.",
			   "properties": {
			       "name": {
		   "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
				   "type": "string"
							}
						},
			   "type": "object"
			}
		},
		"type": "object"
					}
				},
				      "type": "object"
					},
		"failedProvisionConfig": {
		"description": "(Deprecated) FailedProvisionConfig is used to configure settings related to handling provision failures.",
		"properties": {
		"skipGatherLogs": {
		"description": "(Deprecated) SkipGatherLogs disables functionality that attempts to gather full logs from the cluster if an installation fails for any reason. The logs are stored in a persistent volume for up to seven days.",
	        "type": "boolean"
				   }
				},
				  "type": "object"
				  },
		"globalPullSecret": {
		"description": "(Deprecated) GlobalPullSecret is used to specify a pull secret that is used globally by all of the cluster deployments. For each cluster deployment, the contents of GlobalPullSecret are merged with the specific pull secret for a cluster deployment(if specified), with precedence given to the contents of the pull secret for the cluster deployment.",
		"properties": {
		"name": {
		"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
		"type": "string"
			                }
				},
				  "type": "object"
							},
		"maintenanceMode": {
	        "description": "(Deprecated) MaintenanceMode can be set to true to disable the Hive controllers in situations where you need to ensure nothing is running that adds or act upon finalizers on Hive types. This should rarely be needed. Sets replicas to zero for the 'hive-controllers' deployment to accomplish this.",
				  "type": "boolean"
							}
						},
			  "required": [
				         "failedProvisionConfig"
						     ],
			  "type": "object"
						 },
		"imagePullSecret": {
		    "description": "Override pull secret for accessing MultiClusterHub operand and endpoint images.",
		    "type": "string"
					},
		"ingress": {
		    "description": "Configuration options for ingress management.",
		    "properties": {
			"sslCiphers": {
	"description": "List of SSL ciphers enabled for management ingress. Defaults to full list of supported ciphers.",
			    "items": {
		    "type": "string"
					},
			    "type": "array"
						}
					},
			       "type": "object"
						},
			   "nodeSelector": {
		   "additionalProperties": {
				   "type": "string"
						},
			       "description": "Set the node selectors..",
			       "type": "object"
			},
			   "overrides": {
			       "description": "Developer overrides.",
			       "properties": {
		   "imagePullPolicy": {
		   "description": "Pull policy of the multicluster hub images.",
			               "type": "string"
							}
						},
			      "type": "object"
									},
		   "separateCertificateManagement": {
				     "description": "(Deprecated) Install cert-manager into its own namespace.",
				     "type": "boolean"
						    }
					   },
			   "type": "object"
		       },
		       "status": {
			 "description": "MulticlusterHubStatus defines the observed state of MultiClusterHub.",
			 "properties": {
			     "components": {
		      "additionalProperties": {
		      "description": "StatusCondition contains condition information.",
				      "properties": {
		      "lastTransitionTime": {
		      "description": "LastTransitionTime is the last time the condition changed from one status to another.",
		      "format": "date-time",
		      "type": "string"
					},
		      "message": {
		      "description": "Message is a human-readable message indicating\ndetails about the last status change.",
		      "type": "string"
						},
				          "reason": {
		      "description": "Reason is a (brief) reason for the last status change of the condition.",
		      "type": "string"
						},
					  "status": {
		      "description": "Status is the status of the condition. One of True, False, Unknown.",
		      "type": "string"
					},
					  "type": {
		      "description": "Type is the type of the cluster condition.",
		      "type": "string"
					}
				},
				     "type": "object"
						      },
				  "description": "Components []ComponentCondition `json:\"manifests,omitempty\"`",
				  "type": "object"
							},
			      "conditions": {
				  "description": "Conditions contain the different condition statuses for the MultiClusterHub.",
				  "items": {
		      "description": "StatusCondition contains condition information.",
				      "properties": {
		      "lastTransitionTime": {
		      "description": "LastTransitionTime is the last time the condition changed from one status to another.",
		      "format": "date-time",
		      "type": "string"
					},
		      "lastUpdateTime": {
		      "description": "The last time this condition was updated.",
		      "format": "date-time",
		      "type": "string"
					},
		      "message": {
		      "description": "Message is a human-readable message indicating details about the last status change.",
		      "type": "string"
						},
				          "reason": {
		      "description": "Reason is a (brief) reason for the last status change of the condition.",
		      "type": "string"
					},
					  "status": {
		      "description": "Status is the status of the condition. One of True, False, Unknown.",
		      "type": "string"
						},
					  "type": {
		      "description": "Type is the type of the cluster condition.",
		      "type": "string"
					}
				},
				     "type": "object"
						      },
				 "type": "array"
					},
			     "currentVersion": {
				 "description": "CurrentVersion indicates the current version..",
				 "type": "string"
						},
			     "desiredVersion": {
				 "description": "DesiredVersion indicates the desired version.",
				 "type": "string"
						 },
			     "phase": {
				 "description": "Represents the running phase of the MultiClusterHub",
				 "type": "string"
							}
						},
	                 "type": "object"
					   }
				   },
                "type": "object"
			        }
		         },
        "served": true,
        "storage": true,
        "subresources": {
	    "status": {}
	    }
	}
    ]
  }
}

1.13.2.2. 모든 MultiClusterHubs 쿼리

GET /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/operator
1.13.2.2.1. 설명

자세한 내용은 다중 클러스터 허브 Operator를 쿼리합니다.

1.13.2.2.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

네임스페이스
필요

사용하려는 네임스페이스(예: default)입니다.

string

1.13.2.2.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.13.2.2.4. Use
  • operator/yaml
1.13.2.2.5. 태그
  • multiclusterhubs.operator.open-cluster-management.io

1.13.2.3. MultiClusterHub Operator 쿼리

GET /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/operator/{multiclusterhub_name}
1.13.2.3.1. 설명

자세한 내용은 단일 멀티 클러스터 허브 Operator를 쿼리합니다.

1.13.2.3.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

application_name
required

쿼리할 애플리케이션의 이름입니다.

string

경로

네임스페이스
필요

사용하려는 네임스페이스(예: default)입니다.

string

1.13.2.3.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.13.2.3.4. 태그
  • multiclusterhubs.operator.open-cluster-management.io

1.13.2.4. MultiClusterHub Operator 삭제

DELETE /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/operator/{multiclusterhub_name}
1.13.2.4.1. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

application_name
required

삭제할 다중 클러스터 허브 Operator의 이름입니다.

string

경로

네임스페이스
필요

사용하려는 네임스페이스(예: default)입니다.

string

1.13.2.4.2. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.13.2.4.3. 태그
  • multiclusterhubs.operator.open-cluster-management.io

1.13.3. 정의

1.13.3.1. Multicluster hub operator

이름설명스키마

apiVersion
필요

버전이 지정된 MultiClusterHub 스키마입니다.

string

kind
필수

REST 리소스를 나타내는 문자열 값입니다.

string

메타데이터
필요

리소스를 정의하는 규칙을 설명합니다.

object

spec
필수

리소스 사양입니다.

spec

spec

availabilityConfig
optional
가용성 향상을 위한 배포 복제를 지정합니다. 기본값은 High 입니다.string

customCAConfigmap
optional

Red Hat Advanced Cluster Management에 사용자 정의된 OpenShift 기본 수신 CA 인증서를 제공합니다.

string

disableHubSelfManagement
optional

hub 클러스터의 자동 가져오기를 관리형 클러스터로 비활성화합니다.

boolean

disableUpdateClusterImageSets
optional

ClusterImageSets 자동 업데이트를 비활성화합니다.

boolean

Hive
선택 사항

(더 이상 사용되지 않음) 기본 HiveConfig 사양을 덮어쓰는 오브젝트입니다.

Hive

imagePullSecret
optional

MultiClusterHub 피연산자 및 끝점 이미지에 액세스하기 위한 풀 시크릿을 덮어씁니다.

string

Ingress
선택 사항

수신 관리를 위한 구성 옵션입니다.

Ingress

nodeSelector
optional

노드 선택기를 설정합니다.

string

separateCertificateManagement
optional

(더 이상 사용되지 않음) 자체 네임스페이스에 cert-manager 를 설치합니다.

boolean

Hive

additionalCertificateAuthorities
optional
(더 이상 사용되지 않음) 대상 클러스터와 통신할 때 사용할 추가 인증 기관이 포함된 hive 네임스페이스의 보안에 대한 참조 목록입니다. 이러한 인증 기관은 설치 시 각 클러스터에서 생성한 자체 서명된 CA 외에 사용됩니다.object

백업
선택 사항

(더 이상 사용되지 않음) 백업 통합을 위한 구성을 지정합니다. 없는 경우 백업 통합이 비활성화됩니다.

Backup

externalDNS
optional

(더 이상 사용되지 않음) Hive에서 배포할 경우 external-dns 에 대한 설정을 지정합니다. 없는 경우 external-dns 가 배포되지 않습니다.

object

failedProvisionConfig
required

(더 이상 사용되지 않음) 프로비저닝 실패 처리와 관련된 설정을 구성하는 데 사용됩니다.

failedProvisionConfig

globalPullSecret
optional

(더 이상 사용되지 않음) 모든 클러스터 배포에서 전역적으로 사용되는 풀 시크릿을 지정하는 데 사용됩니다. 각 클러스터 배포의 경우 globalPullSecret 의 콘텐츠가 클러스터 배포(지정된 경우)의 특정 풀 시크릿과 병합되며, 클러스터 배포의 풀 시크릿 콘텐츠에 우선합니다.

object

maintenanceMode
optional

(더 이상 사용되지 않음)를 true로 설정하여 Hive 유형의 종료자에서 추가되거나 작동하는 것을 확인할 필요가 없는 경우 하이브 컨트롤러를 비활성화할 수 있습니다. 이 작업은 거의 필요하지 않습니다. hive-controllers 배포를 수행하려면 replicas를 0 으로 설정합니다.

boolean

Ingress

sslCiphers
optional
관리 Ingress에 활성화된 SSL 암호화 목록입니다. 기본값은 지원되는 암호화의 전체 목록입니다.string

Backup

minBackupPeriodSeconds
optional
(더 이상 사용되지 않음) 각 백업 사이에 최소 MinBackupPeriodSeconds 가 발생하도록 지정합니다. 이는 백업 속도를 지정하는 데 사용됩니다. 이로 인해 여러 변경 사항이 하나의 백업에 함께 배치될 수 있습니다. 이 간격 동안 변경이 큐에 추가되어 간격이 완료되면 백업이 발생하므로 백업이 손실되지 않습니다.integer

velero
optional

(더 이상 사용되지 않음) Velero는 Velero 백업 통합에 대한 구성을 지정합니다.

object

failedProvisionConfig

skipGatherLogs
optional
(더 이상 사용되지 않음) 설치에 실패하는 경우 클러스터에서 전체 로그를 수집하려고 시도하는 기능을 비활성화합니다. 로그는 최대 7일 동안 영구 볼륨에 저장됩니다.boolean

status

구성 요소
선택 사항
상태 구성의 구성 요소입니다.object

조건
선택 사항

다중 클러스터 허브의 다양한 조건을 포함합니다.

conditions

desiredVersion
optional

원하는 버전을 나타냅니다.

string

단계
선택 사항

MultiClusterHub 리소스의 활성 단계를 나타냅니다. 이 매개변수에 사용되는 값은 Pending,Running,Installing,Updating,Uninstalling입니다.

string

conditions

lastTransitionTime
optional
조건이 한 상태에서 다른 상태로 마지막으로 변경된 시간입니다.string

lastUpdateTime
optional

이 조건이 마지막으로 업데이트된 것입니다.

string


필요한 메시지

message는 마지막 상태 변경에 대한 세부 정보를 나타내는 사람이 읽을 수 있는 메시지입니다.

string


필수 이유

짧은 이유는 조건 상태가 변경된 이유입니다.

string


필수 상태

조건의 상태:

string


필수항목 입력

클러스터 조건의 유형입니다.

string

StatusConditions

kind
필수
이 상태를 나타내는 리소스 종류입니다.string

사용 가능한
필요

이 구성 요소가 올바르게 실행되고 있는지 여부를 나타냅니다.

boolean

lastTransitionTime
optional

조건이 한 상태에서 다른 상태로 마지막으로 변경된 시간입니다.

metav1.time

lastUpdateTime
optional

이 조건이 마지막으로 업데이트된 것입니다.

metav1.time


필요한 메시지

message는 마지막 상태 변경에 대한 세부 정보를 나타내는 사람이 읽을 수 있는 메시지입니다.

string

reason
optional

짧은 이유는 조건 상태가 변경된 이유입니다.

string

상태
선택 사항

조건의 상태:

string


선택사항

클러스터 조건의 유형입니다.

string

1.14. placements API (v1beta1)

1.14.1. 개요

이 문서는 Red Hat Advanced Cluster Management for Kubernetes의 배치 리소스를 위한 것입니다. 배치 리소스에는 생성, 쿼리, 삭제 및 업데이트 등 네 가지 요청이 있습니다.

1.14.1.1. 버전 정보

버전 : 2.5.0

1.14.1.2. URI 스키마

BasePath : /kubernetes/apis
Schemes : HTTPS

1.14.1.3. 태그

  • cluster.open-cluster-management.io : 배치 생성 및 관리

1.14.2. 경로

1.14.2.1. 모든 배치 쿼리

GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placements
1.14.2.1.1. 설명

자세한 내용은 배치를 쿼리합니다.

1.14.2.1.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

1.14.2.1.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.14.2.1.4. Use
  • placement/yaml
1.14.2.1.5. 태그
  • cluster.open-cluster-management.io

1.14.2.2. 배치 생성

POST /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placements
1.14.2.2.1. 설명

배치 생성.

1.14.2.2.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

body

본문
필요

생성할 배치를 설명하는 매개변수입니다.

placement

1.14.2.2.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.14.2.2.4. Use
  • placement/yaml
1.14.2.2.5. 태그
  • cluster.open-cluster-management.io
1.14.2.2.6. HTTP 요청의 예
1.14.2.2.6.1. 요청 본문
{
  "apiVersion" : "cluster.open-cluster-management.io/v1beta1",
  "kind" : "Placement",
  "metadata" : {
    "name" : "placement1",
    "namespace": "ns1"
  },
  "spec": {
    "predicates": [
      {
        "requiredClusterSelector": {
          "labelSelector": {
            "matchLabels": {
              "vendor": "OpenShift"
            }
          }
        }
      }
    ]
  },
  "status" : { }
}

1.14.2.3. 단일 배치 쿼리

GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placements/{placement_name}
1.14.2.3.1. 설명

자세한 내용은 단일 배치를 쿼리합니다.

1.14.2.3.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

placement_name
required

쿼리할 배치의 이름입니다.

string

1.14.2.3.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.14.2.3.4. 태그
  • cluster.open-cluster-management.io

1.14.2.4. 배치 삭제

DELETE /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placements/{placement_name}
1.14.2.4.1. 설명

단일 배치 삭제.

1.14.2.4.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

placement_name
required

삭제할 배치의 이름입니다.

string

1.14.2.4.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.14.2.4.4. 태그
  • cluster.open-cluster-management.io

1.14.3. 정의

1.14.3.1. placement

이름설명스키마

apiVersion
필요

배치의 버전이 지정된 스키마입니다.

string

kind
필수

REST 리소스를 나타내는 문자열 값입니다.

string

메타데이터
필요

배치의 메타 데이터입니다.

object

spec
필수

배치 사양입니다.

spec

spec

이름설명스키마

ClusterSets
선택 사항

ManagedClusters가 선택된 ManagedClusterSets의 하위 집합입니다. 비어 있는 경우 배치 네임스페이스에 바인딩된 ManagedClusterSets에서 ManagedClusters가 선택됩니다. 그렇지 않으면 ManagedClusters가 이 하위 집합의 교집합에서 선택되고 ManagedClusterSets는 placement 네임스페이스에 바인딩됩니다.

문자열 배열

numberOfClusters
optional

선택할 ManagedCluster의 수입니다.

정수(int32)

서술자
선택 사항

ManagedClusters를 선택할 클러스터 서술자의 하위 집합입니다. 조건부 논리는 OR 입니다.

clusterPredicate 배열

clusterPredicate

이름설명스키마

requiredClusterSelector
optional

레이블 및 클러스터 클레임을 사용하여 ManagedClusters를 선택하는 클러스터 선택기입니다.

clusterSelector

clusterSelector

이름설명스키마

labelSelector
optional

라벨별 ManagedClusters의 선택기입니다.

object

claimSelector
optional

클레임별 ManagedClusters의 선택기입니다.

clusterClaimSelector

clusterClaimSelector

이름설명스키마

matchExpressions
optional

클러스터 클레임 선택기 요구 사항의 하위 집합입니다. 조건부 논리는 AND 입니다.

< object > array

1.15. PlacementDecisions API (v1beta1)

1.15.1. 개요

이 문서는 Kubernetes용 Red Hat Advanced Cluster Management의 PlacementDecision 리소스를 위한 것입니다. PlacementDecision 리소스에는 네 가지 요청(생성, 쿼리, 삭제 및 업데이트)이 있습니다.

1.15.1.1. 버전 정보

버전 : 2.5.0

1.15.1.2. URI 스키마

BasePath : /kubernetes/apis
Schemes : HTTPS

1.15.1.3. 태그

  • cluster.open-cluster-management.io : PlacementDecisions 생성 및 관리

1.15.2. 경로

1.15.2.1. 모든 PlacementDecisions 쿼리

GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placementdecisions
1.15.2.1.1. 설명

자세한 내용은 PlacementDecisions를 쿼리합니다.

1.15.2.1.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

1.15.2.1.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.15.2.1.4. Use
  • placementdecision/yaml
1.15.2.1.5. 태그
  • cluster.open-cluster-management.io

1.15.2.2. PlacementDecision 생성

POST /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placementdecisions
1.15.2.2.1. 설명

PlacementDecision 생성.

1.15.2.2.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

body

본문
필요

생성할 PlacementDecision을 설명하는 매개변수입니다.

PlacementDecision

1.15.2.2.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.15.2.2.4. Use
  • placementdecision/yaml
1.15.2.2.5. 태그
  • cluster.open-cluster-management.io
1.15.2.2.6. HTTP 요청의 예
1.15.2.2.6.1. 요청 본문
{
  "apiVersion" : "cluster.open-cluster-management.io/v1beta1",
  "kind" : "PlacementDecision",
  "metadata" : {
    "labels" : {
      "cluster.open-cluster-management.io/placement" : "placement1"
    },
    "name" : "placement1-decision1",
    "namespace": "ns1"
  },
  "status" : { }
}

1.15.2.3. 단일 PlacementDecision 쿼리

GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placementdecisions/{placementdecision_name}
1.15.2.3.1. 설명

자세한 내용은 단일 PlacementDecision을 쿼리합니다.

1.15.2.3.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

placementdecision_name
required

쿼리할 PlacementDecision의 이름입니다.

string

1.15.2.3.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.15.2.3.4. 태그
  • cluster.open-cluster-management.io

1.15.2.4. PlacementDecision 삭제

DELETE /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placementdecisions/{placementdecision_name}
1.15.2.4.1. 설명

단일 PlacementDecision 삭제

1.15.2.4.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

placementdecision_name
required

삭제할 PlacementDecision의 이름입니다.

string

1.15.2.4.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.15.2.4.4. 태그
  • cluster.open-cluster-management.io

1.15.3. 정의

1.15.3.1. PlacementDecision

이름설명스키마

apiVersion
필요

PlacementDecision의 버전이 지정된 스키마입니다.

string

kind
필수

REST 리소스를 나타내는 문자열 값입니다.

string

메타데이터
필요

PlacementDecision의 메타 데이터입니다.

object

1.16. DiscoveryConfig API

1.16.1. 개요

이 문서는 Red Hat Advanced Cluster Management for Kubernetes용 DiscoveryConfig 리소스용입니다. DiscoveryConfig 리소스에는 생성, 쿼리, 삭제, 업데이트 등 네 가지 요청이 있습니다.

1.16.1.1. 버전 정보

버전 : 2.5.0

1.16.1.2. URI 스키마

BasePath : /kubernetes/apis
Schemes : HTTPS

1.16.1.3. 태그

  • discoveryconfigs.discovery.open-cluster-management.io : DiscoveryConfig 만들기 및 관리

1.16.2. 경로

1.16.2.1. DiscoveryConfig 생성

POST /app.k8s.io/v1/namespaces/{namespace}/discoveryconfigs
1.16.2.1.1. 설명

DiscoveryConfig를 생성합니다.

1.16.2.1.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

네임스페이스
필요

사용하려는 네임스페이스(예: default)입니다.

string

body

본문
필요

생성할 DiscoveryConfig를 설명하는 매개변수입니다.

DiscoveryConfig

1.16.2.1.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.16.2.1.4. Use
  • discoveryconfigs/yaml
1.16.2.1.5. 태그
  • discoveryconfigs.discovery.open-cluster-management.io
1.16.2.1.5.1. 요청 본문
{
  "apiVersion": "apiextensions.k8s.io/v1",
  "kind": "CustomResourceDefinition",
  "metadata": {
    "annotations": {
      "controller-gen.kubebuilder.io/version": "v0.4.1",
    },
    "creationTimestamp": null,
    "name": "discoveryconfigs.discovery.open-cluster-management.io",
  },
  "spec": {
    "group": "discovery.open-cluster-management.io",
    "names": {
      "kind": "DiscoveryConfig",
      "listKind": "DiscoveryConfigList",
      "plural": "discoveryconfigs",
      "singular": "discoveryconfig"
    },
    "scope": "Namespaced",
    "versions": [
      {
        "name": "v1",
        "schema": {
          "openAPIV3Schema": {
            "description": "DiscoveryConfig is the Schema for the discoveryconfigs API",
            "properties": {
              "apiVersion": {
                "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
                "type": "string"
              },
              "kind": {
                "description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
                "type": "string"
              },
              "metadata": {
                "type": "object"
              },
              "spec": {
                "description": "DiscoveryConfigSpec defines the desired state of DiscoveryConfig",
                "properties": {
                  "credential": {
                    "description": "Credential is the secret containing credentials to connect to the OCM api on behalf of a user",
                    "type": "string"
                  },
                  "filters": {
                    "description": "Sets restrictions on what kind of clusters to discover",
                    "properties": {
                      "lastActive": {
                        "description": "LastActive is the last active in days of clusters to discover, determined by activity timestamp",
                        "type": "integer"
                      },
                      "openShiftVersions": {
                        "description": "OpenShiftVersions is the list of release versions of OpenShift of the form \"<Major>.<Minor>\"",
                        "items": {
                          "description": "Semver represents a partial semver string with the major and minor version in the form \"<Major>.<Minor>\". For example: \"4.5\"",
                          "pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
                          "type": "string"
                        },
                        "type": "array"
                      }
                    },
                    "type": "object"
                  }
                },
                "required": [
                  "credential"
                ],
                "type": "object"
              },
              "status": {
                "description": "DiscoveryConfigStatus defines the observed state of DiscoveryConfig",
                "type": "object"
              }
            },
            "type": "object"
          }
        },
        "served": true,
        "storage": true,
        "subresources": {
          "status": {}
        }
      }
    ]
  },
  "status": {
    "acceptedNames": {
      "kind": "",
      "plural": ""
    },
    "conditions": [],
    "storedVersions": []
  }
}

1.16.2.2. 모든 DiscoveryConfigs 쿼리

GET /operator.open-cluster-management.io/v1/namespaces/{namespace}/operator
1.16.2.2.1. 설명

자세한 내용은 검색 구성 Operator를 쿼리합니다.

1.16.2.2.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

네임스페이스
필요

사용하려는 네임스페이스(예: default)입니다.

string

1.16.2.2.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.16.2.2.4. Use
  • operator/yaml
1.16.2.2.5. 태그
  • discoveryconfigs.discovery.open-cluster-management.io

1.16.2.3. DiscoveryConfig Operator 삭제

DELETE /operator.open-cluster-management.io/v1/namespaces/{namespace}/operator/{discoveryconfigs_name}
1.16.2.3.1. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

application_name
required

삭제할 Discovery Config Operator의 이름입니다.

string

경로

네임스페이스
필요

사용하려는 네임스페이스(예: default)입니다.

string

1.16.2.3.2. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.16.2.3.3. 태그
  • discoveryconfigs.operator.open-cluster-management.io

1.16.3. 정의

1.16.3.1. DiscoveryConfig

이름설명스키마

apiVersion
필요

버전이 지정된 discoveryconfigs 스키마입니다.

string

kind
필수

REST 리소스를 나타내는 문자열 값입니다.

string

메타데이터
필요

리소스를 정의하는 규칙을 설명합니다.

object

spec
필수

원하는 DiscoveryConfig 상태를 정의합니다.

사양 목록보기

1.16.3.2. 사양 목록

이름설명스키마

인증 정보
필요

자격 증명은 사용자를 대신하여 OCM API에 연결할 인증 정보가 포함된 시크릿입니다.

string


필터선택 사항

검색할 클러스터 유형에 대한 제한을 설정합니다.

필터 목록보기

1.16.3.3. 필터 목록

이름설명스키마

lastActive
required

LastActive는 활동 타임 스탬프에 따라 감지할 클러스터의 마지막 활성 기간입니다.

integer

openShiftVersions
optional

OpenShiftVersions는 "<Major>.<Minor>" 형식의 OpenShift 릴리스 버전 목록입니다.

object

1.17. DiscoveredCluster API

1.17.1. 개요

이 문서는 Red Hat Advanced Cluster Management for Kubernetes의 DiscoveredCluster 리소스에 대한 것입니다. DiscoveredCluster 리소스에는 생성, 쿼리, 삭제, 업데이트 등 네 가지 요청이 있습니다.

1.17.1.1. 버전 정보

버전 : 2.5.0

1.17.1.2. URI 스키마

BasePath : /kubernetes/apis
Schemes : HTTPS

1.17.1.3. 태그

  • discoveredclusters.discovery.open-cluster-management.io : DiscoveredClusters 생성 및 관리

1.17.2. 경로

1.17.2.1. DiscoveredCluster 생성

POST /app.k8s.io/v1/namespaces/{namespace}/discoveredclusters
1.17.2.1.1. 설명

DiscoveredCluster를 생성합니다.

1.17.2.1.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

네임스페이스
필요

사용하려는 네임스페이스(예: default)입니다.

string

body

본문
필요

DiscoveredCluster를 설명하는 매개변수입니다.

DiscoveredCluster

1.17.2.1.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.17.2.1.4. Use
  • discoveredclusters/yaml
1.17.2.1.5. 태그
  • discoveredclusters.discovery.open-cluster-management.io
1.17.2.1.5.1. 요청 본문
{
  "apiVersion": "apiextensions.k8s.io/v1",
  "kind": "CustomResourceDefinition",
  "metadata": {
    "annotations": {
      "controller-gen.kubebuilder.io/version": "v0.4.1",\
    },
    "creationTimestamp": null,
    "name": "discoveredclusters.discovery.open-cluster-management.io",
  },
  "spec": {
    "group": "discovery.open-cluster-management.io",
    "names": {
      "kind": "DiscoveredCluster",
      "listKind": "DiscoveredClusterList",
      "plural": "discoveredclusters",
      "singular": "discoveredcluster"
    },
    "scope": "Namespaced",
    "versions": [
      {
        "name": "v1",
        "schema": {
          "openAPIV3Schema": {
            "description": "DiscoveredCluster is the Schema for the discoveredclusters API",
            "properties": {
              "apiVersion": {
                "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
                "type": "string"
              },
              "kind": {
                "description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
                "type": "string"
              },
              "metadata": {
                "type": "object"
              },
              "spec": {
                "description": "DiscoveredClusterSpec defines the desired state of DiscoveredCluster",
                "properties": {
                  "activityTimestamp": {
                    "format": "date-time",
                    "type": "string"
                  },
                  "apiUrl": {
                    "type": "string"
                  },
                  "cloudProvider": {
                    "type": "string"
                  },
                  "console": {
                    "type": "string"
                  },
                  "creationTimestamp": {
                    "format": "date-time",
                    "type": "string"
                  },
                  "credential": {
                    "description": "ObjectReference contains enough information to let you inspect or modify the referred object. --- New uses of this type are discouraged because of difficulty describing its usage when embedded in APIs.  1. Ignored fields.  It includes many fields which are not generally honored.  For instance, ResourceVersion and FieldPath are both very rarely valid in actual usage.  2. Invalid usage help.  It is impossible to add specific help for individual usage.  In most embedded usages, there are particular     restrictions like, \"must refer only to types A and B\" or \"UID not honored\" or \"name must be restricted\".     Those cannot be well described when embedded.  3. Inconsistent validation.  Because the usages are different, the validation rules are different by usage, which makes it hard for users to predict what will happen.  4. The fields are both imprecise and overly precise.  Kind is not a precise mapping to a URL. This can produce ambiguity     during interpretation and require a REST mapping.  In most cases, the dependency is on the group,resource tuple     and the version of the actual struct is irrelevant.  5. We cannot easily change it.  Because this type is embedded in many locations, updates to this type     will affect numerous schemas.  Don't make new APIs embed an underspecified API type they do not control. Instead of using this type, create a locally provided and used type that is well-focused on your reference. For example, ServiceReferences for admission registration: https://github.com/kubernetes/api/blob/release-1.17/admissionregistration/v1/types.go#L533 .",
                    "properties": {
                      "apiVersion": {
                        "description": "API version of the referent.",
                        "type": "string"
                      },
                      "fieldPath": {
                        "description": "If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: \"spec.containers{name}\" (where \"name\" refers to the name of the container that triggered the event) or if no container name is specified \"spec.containers[2]\" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future.",
                        "type": "string"
                      },
                      "kind": {
                        "description": "Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
                        "type": "string"
                      },
                      "name": {
                        "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
                        "type": "string"
                      },
                      "namespace": {
                        "description": "Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/",
                        "type": "string"
                      },
                      "resourceVersion": {
                        "description": "Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency",
                        "type": "string"
                      },
                      "uid": {
                        "description": "UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids",
                        "type": "string"
                      }
                    },
                    "type": "object"
                  },
                  "displayName": {
                    "type": "string"
                  },
                  "isManagedCluster": {
                    "type": "boolean"
                  },
                  "name": {
                    "type": "string"
                  },
                  "openshiftVersion": {
                    "type": "string"
                  },
                  "status": {
                    "type": "string"
                  },
                  "type": {
                    "type": "string"
                  }
                },
                "required": [
                  "apiUrl",
                  "displayName",
                  "isManagedCluster",
                  "name",
                  "type"
                ],
                "type": "object"
              },
              "status": {
                "description": "DiscoveredClusterStatus defines the observed state of DiscoveredCluster",
                "type": "object"
              }
            },
            "type": "object"
          }
        },
        "served": true,
        "storage": true,
        "subresources": {
          "status": {}
        }
      }
    ]
  },
  "status": {
    "acceptedNames": {
      "kind": "",
      "plural": ""
    },
    "conditions": [],
    "storedVersions": []
  }
}

1.17.2.2. 모든 DiscoveredClusters 쿼리

GET /operator.open-cluster-management.io/v1/namespaces/{namespace}/operator
1.17.2.2.1. 설명

자세한 내용은 검색된 클러스터 Operator를 쿼리합니다.

1.17.2.2.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

네임스페이스
필요

사용하려는 네임스페이스(예: default)입니다.

string

1.17.2.2.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.17.2.2.4. Use
  • operator/yaml
1.17.2.2.5. 태그
  • discoveredclusters.discovery.open-cluster-management.io

1.17.2.3. DiscoveredCluster Operator 삭제

DELETE /operator.open-cluster-management.io/v1/namespaces/{namespace}/operator/{discoveredclusters_name}
1.17.2.3.1. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

application_name
required

삭제하려는 검색된 클러스터 Operator의 이름입니다.

string

경로

네임스페이스
필요

사용하려는 네임스페이스(예: default)입니다.

string

1.17.2.3.2. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.17.2.3.3. 태그
  • discoveredclusters.operator.open-cluster-management.io

1.17.3. 정의

1.17.3.1. DiscoveredCluster

이름설명스키마

apiVersion
필요

검색된 클러스터의 버전이 지정된 스키마입니다.

string

kind
필수

REST 리소스를 나타내는 문자열 값입니다.

string

메타데이터
필요

리소스를 정의하는 규칙을 설명합니다.

object