API
API
초록
1장. API
API에 액세스하여 애플리케이션 리소스, 채널, 서브스크립션 및 정보를 생성 및 관리하고 정보를 쿼리할 수 있습니다.
사용자 필수 액세스: 역할이 할당된 작업만 수행할 수 있습니다. 역할 기반 액세스 제어 설명서에서 액세스 요구 사항에 대해 알아봅니다.
통합 콘솔에서 모든 API에 액세스할 수도 있습니다. local-cluster
보기에서 Home > API Explorer 로 이동하여 API 그룹을 살펴봅니다.
자세한 내용은 다음 리소스 각각에 대한 API 설명서를 참조하십시오.
- 클러스터 API
- ClusterInstance API
- ClusterSets API (v1beta2)
- ClusterSetBindings API (v1beta2)
- 채널 API
- 서브스크립션 API
- PlacementRules API (더 이상 사용되지 않음)
- 애플리케이션 API
- Helm API
- 정책 API
- 관찰 기능 API
- 검색 쿼리 API
- MultiClusterHub API
- 배치 API(v1beta1)
- PlacementDecisions API (v1beta1)
- DiscoveryConfig API
- DiscoveredCluster API
- AddOnDeploymentConfig API (v1alpha1)
- ClusterManagementAddOn API (v1alpha1)
- ManagedClusterAddOn API (v1alpha1)
- ManagedClusterSet API
- KlusterletConfig API (v1alpha1)
- 정책 규정 준수 API (기술 프리뷰)
1.1. 클러스터 API
1.1.1. 개요
이 문서는 Red Hat Advanced Cluster Management for Kubernetes용 클러스터 리소스에 대한 것입니다. 클러스터 리소스에는 생성, 쿼리, 삭제 및 업데이트의 네 가지 요청이 있습니다. ManagedCluster
는 관리 클러스터의 원하는 상태 및 현재 상태를 나타냅니다. ManagedCluster
는 클러스터 범위 리소스입니다.
1.1.1.1. 버전 정보
버전 : 2.12.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. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
1.1.2.1.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.1.2.1.4. 사용
-
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. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
본문 |
본문 | 생성할 클러스터를 설명하는 매개변수입니다. |
1.1.2.2.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.1.2.2.4. 사용
-
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. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
cluster_name | 쿼리할 클러스터의 이름입니다. | 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. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
cluster_name | 삭제할 클러스터의 이름입니다. | 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 |
종류 | REST 리소스를 나타내는 문자열 값입니다. | string |
메타데이터 |
| object |
사양 |
|
spec
이름 | 설명 | 스키마 |
---|---|---|
hubAcceptsClient |
허브가 관리 클러스터에서 klusterlet 에이전트와의 연결을 설정할 수 있는지 여부를 지정합니다. 기본값은 | bool |
managedClusterClientConfigs | 관리 클러스터의 apiserver 주소를 나열합니다. | |
leaseDurationSeconds | 관리 클러스터에서 klusterlet 에이전트의 리스 업데이트 시간 간격을 지정합니다. 기본적으로 klusterlet 에이전트는 60초마다 리스를 업데이트합니다. | 정수(int32) |
테인트 | 예약 중에 관리 클러스터가 하나 이상의 관리 클러스터 세트에 할당되지 않도록 합니다. | taint 배열 |
managedClusterClientConfigs
이름 | 설명 | 스키마 |
---|---|---|
URL | string | |
cabundle | 패턴 : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$" | 문자열(바이트) |
taint
이름 | 설명 | 스키마 |
---|---|---|
키 | 클러스터에 적용되는 taint 키입니다. | string |
값 | taint 키에 해당하는 taint 값입니다. | string |
effect |
테인트를 허용하지 않는 배치에 테인트의 영향 유효한 값은 | string |
1.2. ClusterInstance API
1.2.1. 개요
이 문서는 Red Hat Advanced Cluster Management for Kubernetes용 ClusterInstance 리소스에 대한 것입니다. ClusterInstance 리소스에는 생성, 쿼리, 삭제 및 업데이트의 네 가지 요청이 있습니다.
1.2.1.1. 버전 정보
버전 : 2.12.0
1.2.1.2. URI 스키마
BasePath : /kubernetes/apis
Schemes : HTTPS
1.2.1.3. 태그
- siteconfig.open-cluster-management.io : 클러스터 생성 및 관리
1.2.2. 경로
1.2.2.1. 모든 클러스터 쿼리
GET /siteconfig.open-cluster-management.io/v1alpha1/{clusterinstance_namespace}/{clusterinstance_name}
1.2.2.1.1. 설명
자세한 내용은 클러스터를 쿼리합니다.
1.2.2.1.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
clusterinstance_namespace | 쿼리할 ClusterInstance의 네임스페이스입니다. | string |
경로 |
clusterinstance_name | 쿼리할 ClusterInstance의 이름입니다. | string |
1.2.2.1.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.2.2.1.4. 사용
-
clusterinstance/json
1.2.2.1.5. 태그
- siteconfig.open-cluster-management.io
1.2.2.2. 설치 매니페스트 생성
POST /siteconfig.open-cluster-management.io/v1alpha1/<clusterinstance_namespace>/<clusterinstance_name>
1.2.2.2.1. 설명
선택한 설치 방법을 위해 SiteConfig Operator를 사용하여 설치 매니페스트를 생성합니다.
1.2.2.2.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
본문 |
본문 | 생성할 설치 매니페스트를 설명하는 매개변수입니다. | |
경로 |
clusterinstance_namespace | 사용하려는 ClusterInstance의 네임스페이스입니다. | string |
경로 |
clusterinstance_name | 사용할 ClusterInstance의 이름입니다. | string |
1.2.2.2.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.2.2.2.4. 사용
-
clusterinstance/json
1.2.2.2.5. 태그
- siteconfig.open-cluster-management.io
1.2.2.2.6. HTTP 요청의 예
1.2.2.2.6.1. 요청 본문
{ "apiVersion": "siteconfig.open-cluster-management.io/v1alpha1", "kind": "ClusterInstance", "metadata": { "name": "site-sno-du-1", "namespace": "site-sno-du-1" }, "spec": { "baseDomain": "example.com", "pullSecretRef": { "name": "pullSecretName" }, "sshPublicKey": "ssh-rsa ", "clusterName": "site-sno-du-1", "proxy": { "noProxys": "foobar" }, "caBundleRef": { "name": "my-bundle-ref" }, "extraManifestsRefs": [ { "name": "foobar1" }, { "name": "foobar2" } ], "networkType": "OVNKubernetes", "installConfigOverrides": "{\"capabilities\":{\"baselineCapabilitySet\": \"None\", \"additionalEnabledCapabilities\": [ \"marketplace\", \"NodeTuning\" ] }}", "extraLabels": { "ManagedCluster": { "group-du-sno": "test", "common": "true", "sites": "site-sno-du-1" } }, "clusterNetwork": [ { "cidr": "203.0.113.0/24", "hostPrefix": 23 } ], "machineNetwork": [ { "cidr": "203.0.113.0/24" } ], "serviceNetwork": [ { "cidr": "203.0.113.0/24" } ], "additionalNTPSources": [ "NTP.server1", "198.51.100.100" ], "ignitionConfigOverride": "{\"ignition\": {\"version\": \"3.1.0\"}, \"storage\": {\"files\": [{\"path\": \"/etc/containers/registries.conf\", \"overwrite\": true, \"contents\": {\"source\": \"data:text/plain;base64,foobar==\"}}]}}", "diskEncryption": { "type": "nbde", "tang": [ { "url": "http://192.0.2.5:7500", "thumbprint": "1234567890" } ] }, "clusterType": "SNO", "templateRefs": [ { "name": "ai-cluster-templates-v1", "namespace": "rhacm" } ], "nodes": [ { "hostName": "node1", "role": "master", "templateRefs": [ { "name": "ai-node-templates-v1", "namespace": "rhacm" } ], "ironicInspect": "", "bmcAddress": "idrac-virtualmedia+https://203.0.113.100/redfish/v1/Systems/System.Embedded.1", "bmcCredentialsName": { "name": "<bmcCredentials_secre_name>" }, "bootMACAddress": "00:00:5E:00:53:00", "bootMode": "UEFI", "installerArgs": "[\"--append-karg\", \"nameserver=8.8.8.8\", \"-n\"]", "ignitionConfigOverride": "{\"ignition\": {\"version\": \"3.1.0\"}, \"storage\": {\"files\": [{\"path\": \"/etc/containers/registries.conf\", \"overwrite\": true, \"contents\": {\"source\": \"data:text/plain;base64,foobar==\"}}]}}", "nodeNetwork": { "interfaces": [ { "name": "eno1", "macAddress": "00:00:5E:00:53:01" } ], "config": { "interfaces": [ { "name": "eno1", "type": "ethernet", "ipv4": { "enabled": true, "dhcp": false, "address": [ { "ip": "192.0.2.1", "prefix-length": 24 } ] }, "ipv6": { "enabled": true, "dhcp": false, "address": [ { "ip": "2001:0DB8:0:0:0:0:0:1", "prefix-length": 32 } ] } } ], "dns-resolver": { "config": { "server": [ "198.51.100.1" ] } }, "routes": { "config": [ { "destination": "0.0.0.0/0", "next-hop-address": "203.0.113.255", "next-hop-interface": "eno1", "table-id": 254 } ] } } } } ] } }
1.2.2.3. 단일 클러스터 쿼리
GET /siteconfig.open-cluster-management.io/v1alpha1/<clusterinstance_namespace>/<clusterinstance_name>
1.2.2.3.1. 설명
자세한 내용은 단일 클러스터를 쿼리합니다.
1.2.2.3.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
clusterinstance_namespace | 쿼리할 ClusterInstance의 네임스페이스입니다. | string |
경로 |
clusterinstance_name | 쿼리할 ClusterInstance의 이름입니다. | string |
1.2.2.3.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.2.2.3.4. 태그
- siteconfig.open-cluster-management.io
1.2.3. 정의
1.2.3.1. ClusterInstance
중요: 특정 필드는 특정 설치 흐름에만 관련이 있습니다. 관련 문서를 확인하여 선택한 설치 방법에 적용할 수 있는 필드를 확인합니다. 지원 설치 관리자 및 이미지 기반 설치의 경우 다음 문서를 참조하십시오.
이름 | 설명 | 스키마 |
---|---|---|
apiVersion |
| string |
종류 | REST 리소스를 나타내는 문자열 값입니다. | string |
메타데이터 |
| object |
사양 |
| |
상태 |
| status 오브젝트 |
spec
이름 | 설명 | 스키마 |
---|---|---|
additionalNTPSources | 모든 클러스터 호스트에 추가해야 하는 NTP 소스를 지정합니다. 다른 방법을 통해 구성된 모든 NTP 소스에 추가됩니다. | array |
baseDomain | 배포된 클러스터에 사용되는 기본 도메인을 지정합니다. | string |
caBundleRef |
호스트에 대한 신뢰할 수 있는 인증서의 새 번들이 포함된 | string |
클러스터 이름 | 클러스터 이름을 지정합니다. | string |
clusterNetwork | Pod의 IP 주소 풀 목록을 지정합니다. | array |
clusterType | 클러스터 유형을 지정합니다. 지원되는 값은 다음과 같습니다.
| string |
cpuPartitioningMode |
설치 시 CPU 워크로드 파티셔닝에 대해 클러스터를 설정합니다. | string |
diskEncryption | 클러스터의 디스크 암호화를 활성화하거나 비활성화합니다. | object |
extraAnnotations |
다음 형식을 사용하여 렌더링된 템플릿에 적용할 추가 클러스터 수준 주석을 지정합니다. extraAnnotations: ClusterDeployment: myClusterAnnotation: success | object |
extraLabels |
다음 형식을 사용하여 렌더링된 템플릿에 적용할 추가 클러스터 수준 레이블을 지정합니다. extraLabels: ManagedCluster: common: "true" label-a : "value-a" | object |
extraManifestsRefs |
클러스터에 적용할 추가 매니페스트가 포함된 | array |
holdInstallation |
지원 설치 관리자를 사용할 때 설치를 방지하려면 | bool |
ignitionConfigOverride |
초기 Ignition 구성에 대한 사용자 덮어쓰기를 지정합니다. | string |
installConfigOverrides | 설치 구성 매개 변수를 정의합니다. | string |
machineNetwork | 머신의 IP 주소 풀 목록을 지정합니다. | array |
NetworkType |
설치할 CNI(Container Network Interface) 플러그인을 지정합니다. 기본값은 IPv4용 | string |
platformType | 설치할 특정 플랫폼의 이름을 정의합니다. 지원되는 값은 다음과 같습니다.
| string |
프록시 | 클러스터 설치 구성에 사용되는 프록시 설정을 정의합니다. | object |
pruneManifests |
| array |
pullSecretRef |
이미지를 가져올 수 있도록 | object |
serviceNetwork | 서비스의 IP 주소 풀 목록을 지정합니다. | array |
sshPublicKey | 인스턴스에 대한 액세스를 제공하려면 공개 SSH(Secure Shell) 키를 지정합니다. 이 키는 SSH 액세스를 허용하도록 호스트에 추가됩니다. | string |
| 각 노드의 구성 매개변수를 지정합니다. | 노드 배열 |
templateRefs |
클러스터 수준 템플릿에 대한 참조 목록을 지정합니다. 클러스터 수준 템플릿은 | array |
노드
이름 | 설명 | 스키마 |
---|---|---|
automatedCleaningMode |
디스크를 완전히 삭제하지 않고 값을 | string |
bmcAddress | 호스트에 액세스하는 데 사용하는 BMC 주소입니다. 모든 클러스터 유형에 적용됩니다. BMC 주소 지정에 대한 자세한 내용은 추가 리소스의 BMC 주소 지정을 참조하십시오. 참고: 지금까지 엣지 Telco 사용 사례에서는 가상 미디어만 GitOps ZTP에서 사용할 수 있도록 지원됩니다. | string |
bmcCredentialsName |
호스트 BMC 인증 정보를 사용하여 별도로 생성하는 | string |
bootMACAddress |
PXE가 부팅되는 MAC 주소를 지정합니다. 가상 BMC에 의해 구동되는 | string |
bootMode |
호스트의 부팅 모드를
| string |
extraAnnotations |
다음 형식을 사용하여 렌더링된 템플릿에 적용할 추가 노드 수준 주석을 지정합니다. extraAnnotations: BareMetalHost: myNodeAnnotation: success | object |
extraLabels |
렌더링된 템플릿에 적용할 추가 노드 수준 레이블을 지정합니다. extraLabels: ManagedCluster: common: "true" label-a : "value-a" | object |
호스트 이름 | 호스트 이름을 정의합니다. | string |
installerArgs | 호스트의 :op-system-first: 설치 프로그램 인수에 대한 사용자 덮어쓰기를 지정합니다. | string |
ignitionConfigOverride | 초기 Ignition 구성에 대한 사용자 덮어쓰기를 지정합니다. 이 필드를 사용하여 영구 스토리지의 파티션을 할당합니다. 디스크 ID와 크기를 특정 하드웨어에 조정합니다. | string |
ironicInspect | 베어 메탈 호스트를 등록하는 동안 자동 인트로스펙션이 실행되는지 여부를 지정합니다. | string |
nodeLabels | 관리 클러스터에서 노드의 사용자 정의 노드 레이블을 지정합니다. 이는 Red Hat Advanced Cluster Management 구성 요소에서 사용하지 않는 추가 레이블입니다. 사용자 정의 노드 레이블을 추가하면 해당 라벨의 특정 구성을 참조하는 사용자 정의 머신 구성 풀과 연결할 수 있습니다. 설치 중에 사용자 지정 노드 레이블을 추가하면 배포 프로세스가 더 효과적이며 설치가 완료된 후 추가 재부팅이 필요하지 않습니다.
참고: | object |
nodeNetwork | 정적 네트워크가 있는 노드의 네트워크 설정을 구성합니다. | object |
pruneManifests |
| array |
역할 |
노드의 역할(예: | string |
rootDeviceHints |
배포할 장치를 지정합니다. 재부팅 시 안정적인 식별자를 사용하는 것이 좋습니다. 예를 들어 | object |
templateRefs |
노드 수준 템플릿에 대한 참조 목록을 지정합니다. 노드 수준 템플릿은 | array |
status
이름 | 설명 | 스키마 |
---|---|---|
조건 |
| conditions 배열 |
deploymentConditions |
| |
manifestsRendered | 렌더링된 매니페스트와 해당 상태를 나열합니다. | array |
observedGeneration |
| integer |
conditions
유형 | 설명 |
---|---|
ClusterInstanceValidated |
SiteConfig Operator가 |
RenderedTemplates | siteConfig Operator가 참조된 Golang 클러스터 템플릿을 성공적으로 검증했음을 나타냅니다. |
RenderedTemplatesValidated | SiteConfig 운영자가 설치 매니페스트를 렌더링하고 예행 실행에 성공했음을 나타냅니다. |
RenderedTemplatesApplied | SiteConfig 운영자가 설치 매니페스트를 생성하고 기본 Operator가 이를 사용했음을 나타냅니다. |
provisioned | 기본 Operator가 클러스터를 프로비저닝하고 있음을 나타냅니다. |
deploymentConditions
유형 | 설명 |
---|---|
ClusterInstallRequirementsMet | 설치를 시작할 수 있음을 나타냅니다. |
ClusterInstallCompleted | 클러스터 설치에 성공했음을 나타냅니다. |
ClusterInstallFailed | 클러스터 설치에 실패했음을 나타냅니다. |
ClusterInstallStopped | 클러스터 설치가 중지되었음을 나타냅니다. |
추가 리소스
1.3. Clustersets API (v1beta2)
1.3.1. 개요
이 문서는 Red Hat Advanced Cluster Management for Kubernetes용 ClusterSet 리소스를 위한 것입니다. ClusterSet 리소스에는 생성, 쿼리, 삭제 및 업데이트의 네 가지 요청이 있습니다. ManagedClusterSet은 ManagedClusters 그룹을 정의합니다. ManagedClusterSet을 참조하는 ManagedCluster의 cluster.open-cluster-management.io/clusterset
이라는 라벨을 추가하여 ManagedCluster를 특정 ManagedClusterSet에 할당할 수 있습니다. Managed clustersets/join
의 가상 하위 리소스에 대한 생성
권한을 허용하는 RBAC 규칙이 있는 경우에만 ManagedCluster에서 이 라벨을 추가하거나 제거할 수 있습니다. 이 레이블을 업데이트하려면 소스 및 대상 ManagedClusterSets 모두에 이 권한이 있어야 합니다.
1.3.1.1. 버전 정보
버전 : 2.12.0
1.3.1.2. URI 스키마
BasePath : /kubernetes/apis
Schemes : HTTPS
1.3.1.3. 태그
- cluster.open-cluster-management.io : Clustersets 생성 및 관리
1.3.2. 경로
1.3.2.1. 모든 clustersets 쿼리
GET /cluster.open-cluster-management.io/v1beta2/managedclustersets
1.3.2.1.1. 설명
자세한 내용은 Clustersets를 쿼리합니다.
1.3.2.1.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
1.3.2.1.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.3.2.1.4. 사용
-
clusterset/yaml
1.3.2.1.5. 태그
- cluster.open-cluster-management.io
1.3.2.2. clusterset 생성
POST /cluster.open-cluster-management.io/v1beta2/managedclustersets
1.3.2.2.1. 설명
클러스터 세트를 생성합니다.
1.3.2.2.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
본문 |
본문 | 생성할 clusterset을 설명하는 매개변수입니다. |
1.3.2.2.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.3.2.2.4. 사용
-
clusterset/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/v1beta2", "kind": "ManagedClusterSet", "metadata": { "name": "clusterset1" }, "spec": { "clusterSelector": { "selectorType": "ExclusiveClusterSetLabel" } }, "status": {} }
1.3.2.3. 단일 클러스터 세트 쿼리
GET /cluster.open-cluster-management.io/v1beta2/managedclustersets/{clusterset_name}
1.3.2.3.1. 설명
자세한 내용은 단일 클러스터 세트를 쿼리합니다.
1.3.2.3.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
clusterset_name | 쿼리할 클러스터 세트의 이름입니다. | 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. clusterset 삭제
DELETE /cluster.open-cluster-management.io/v1beta2/managedclustersets/{clusterset_name}
1.3.2.4.1. 설명
단일 클러스터 세트를 삭제합니다.
1.3.2.4.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
clusterset_name | 삭제할 클러스터 세트의 이름입니다. | 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. clusterset
이름 | 스키마 |
---|---|
apiVersion | string |
종류 | string |
메타데이터 | object |
1.4. Clustersetbindings API (v1beta2)
1.4.1. 개요
이 문서는 Red Hat Advanced Cluster Management for Kubernetes용 ClusterSetBinding 리소스를 위한 것입니다. ClusterSetBinding 리소스에는 생성, 쿼리, 삭제 및 업데이트의 네 가지 요청이 있습니다. ManagedClusterSetBinding은 ManagedClusterSet을 특정 네임스페이스로 제한합니다. Managed clustersets/bind 의 가상 하위 리소스에서 생성할 수 있는 RBAC 규칙이 있는 경우 네임스페이스에 ManagedClusterSetBinding을
수 있습니다.
생성하고
ManagedClusterSet에 바인딩할
1.4.1.1. 버전 정보
버전 : 2.12.0
1.4.1.2. URI 스키마
BasePath : /kubernetes/apis
Schemes : HTTPS
1.4.1.3. 태그
- cluster.open-cluster-management.io : clustersetbindings 생성 및 관리
1.4.2. 경로
1.4.2.1. 모든 clustersetbindings 쿼리
GET /cluster.open-cluster-management.io/v1beta2/namespaces/{namespace}/managedclustersetbindings
1.4.2.1.1. 설명
자세한 내용은 clustersetbindings를 쿼리합니다.
1.4.2.1.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
네임스페이스 | 사용할 네임스페이스(예: default)입니다. | string |
1.4.2.1.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.4.2.1.4. 사용
-
clustersetbinding/yaml
1.4.2.1.5. 태그
- cluster.open-cluster-management.io
1.4.2.2. clustersetbinding 생성
POST /cluster.open-cluster-management.io/v1beta2/namespaces/{namespace}/managedclustersetbindings
1.4.2.2.1. 설명
clustersetbinding을 생성합니다.
1.4.2.2.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
네임스페이스 |
사용할 네임스페이스(예: | string |
본문 |
본문 | 생성할 clustersetbinding을 설명하는 매개변수입니다. |
1.4.2.2.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.4.2.2.4. 사용
-
clustersetbinding/yaml
1.4.2.2.5. 태그
- cluster.open-cluster-management.io
1.4.2.2.6. HTTP 요청의 예
1.4.2.2.6.1. 요청 본문
{ "apiVersion" : "cluster.open-cluster-management.io/v1beta2", "kind" : "ManagedClusterSetBinding", "metadata" : { "name" : "clusterset1", "namespace" : "ns1" }, "spec": { "clusterSet": "clusterset1" }, "status" : { } }
1.4.2.3. 단일 clustersetbinding 쿼리
GET /cluster.open-cluster-management.io/v1beta2/namespaces/{namespace}/managedclustersetbindings/{clustersetbinding_name}
1.4.2.3.1. 설명
자세한 내용은 단일 clustersetbinding을 쿼리합니다.
1.4.2.3.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
네임스페이스 |
사용할 네임스페이스(예: | string |
경로 |
clustersetbinding_name | 쿼리할 clustersetbinding의 이름입니다. | string |
1.4.2.3.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.4.2.3.4. 태그
- cluster.open-cluster-management.io
1.4.2.4. clustersetbinding 삭제
DELETE /cluster.open-cluster-management.io/v1beta2/managedclustersetbindings/{clustersetbinding_name}
1.4.2.4.1. 설명
단일 clustersetbinding을 삭제합니다.
1.4.2.4.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
네임스페이스 |
사용할 네임스페이스(예: | string |
경로 |
clustersetbinding_name | 삭제할 clustersetbinding의 이름입니다. | string |
1.4.2.4.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.4.2.4.4. 태그
- cluster.open-cluster-management.io
1.4.3. 정의
1.4.3.1. Clustersetbinding
이름 | 설명 | 스키마 |
---|---|---|
apiVersion |
| string |
종류 | REST 리소스를 나타내는 문자열 값입니다. | string |
메타데이터 |
| object |
사양 |
|
spec
이름 | 설명 | 스키마 |
---|---|---|
clusterSet |
바인딩할 | string |
1.5. Clusterview API(v1alpha1)
1.5.1. 개요
이 문서는 Red Hat Advanced Cluster Management for Kubernetes의 clusterview
리소스에 대한 것입니다. clusterview
리소스는 액세스할 수 있는 관리 클러스터 및 관리 클러스터 세트 목록을 볼 수 있는 CLI 명령을 제공합니다. 가능한 세 가지 요청은 list, get, watch입니다.
1.5.1.1. 버전 정보
버전 : 2.12.0
1.5.1.2. URI 스키마
BasePath : /kubernetes/apis
Schemes : HTTPS
1.5.1.3. 태그
- clusterview.open-cluster-management.io : ID가 액세스할 수 있는 관리 클러스터 목록을 확인합니다.
1.5.2. 경로
1.5.2.1. 관리 클러스터 가져오기
GET /managedclusters.clusterview.open-cluster-management.io
1.5.2.1.1. 설명
액세스할 수 있는 관리 클러스터 목록을 확인합니다.
1.5.2.1.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
1.5.2.1.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.5.2.1.4. 사용
-
managedcluster/yaml
1.5.2.1.5. 태그
- clusterview.open-cluster-management.io
1.5.2.2. 관리 클러스터 나열
LIST /managedclusters.clusterview.open-cluster-management.io
1.5.2.2.1. 설명
액세스할 수 있는 관리 클러스터 목록을 확인합니다.
1.5.2.2.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
본문 |
본문 | 관리 클러스터를 나열할 사용자 ID의 이름입니다. | string |
1.5.2.2.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.5.2.2.4. 사용
-
managedcluster/yaml
1.5.2.2.5. 태그
- clusterview.open-cluster-management.io
1.5.2.2.6. HTTP 요청의 예
1.5.2.2.6.1. 요청 본문
{ "apiVersion" : "clusterview.open-cluster-management.io/v1alpha1", "kind" : "ClusterView", "metadata" : { "name" : "<user_ID>" }, "spec": { }, "status" : { } }
1.5.2.3. 관리 클러스터 세트 모니터링
WATCH /managedclusters.clusterview.open-cluster-management.io
1.5.2.3.1. 설명
액세스할 수 있는 관리형 클러스터를 확인합니다.
1.5.2.3.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
clusterview_name | 조사할 사용자 ID의 이름입니다. | string |
1.5.2.3.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.5.2.4. 관리되는 클러스터 세트를 나열합니다.
GET /managedclustersets.clusterview.open-cluster-management.io
1.5.2.4.1. 설명
액세스할 수 있는 관리 클러스터를 나열합니다.
1.5.2.4.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
clusterview_name | 조사할 사용자 ID의 이름입니다. | string |
1.5.2.4.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.5.2.5. 관리되는 클러스터 세트를 나열합니다.
LIST /managedclustersets.clusterview.open-cluster-management.io
1.5.2.5.1. 설명
액세스할 수 있는 관리 클러스터를 나열합니다.
1.5.2.5.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
clusterview_name | 조사할 사용자 ID의 이름입니다. | string |
1.5.2.5.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.5.2.6. 관리되는 클러스터 세트를 확인합니다.
WATCH /managedclustersets.clusterview.open-cluster-management.io
1.5.2.6.1. 설명
액세스할 수 있는 관리형 클러스터를 확인합니다.
1.5.2.6.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
clusterview_name | 조사할 사용자 ID의 이름입니다. | string |
1.5.2.6.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.6. 채널 API
1.6.1. 개요
이 문서는 Red Hat Advanced Cluster Management for Kubernetes용 채널 리소스에 대한 것입니다. 채널 리소스에는 생성, 쿼리, 삭제 및 업데이트의 네 가지 요청이 있습니다.
1.6.1.1. 버전 정보
버전 : 2.12.0
1.6.1.2. URI 스키마
BasePath : /kubernetes/apis
Schemes : HTTPS
1.6.1.3. 태그
- channels.apps.open-cluster-management.io : deployables 생성 및 관리
1.6.2. 경로
1.6.2.1. 채널 생성
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels
1.6.2.1.1. 설명
채널을 생성합니다.
1.6.2.1.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
네임스페이스 | 사용할 네임스페이스(예: default)입니다. | string |
본문 |
본문 | 생성할 배포를 설명하는 매개변수입니다. |
1.6.2.1.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.6.2.1.4. 사용
-
application/yaml
1.6.2.1.5. 태그
- channels.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": "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.6.2.2. 대상 네임스페이스의 모든 채널 쿼리
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels
1.6.2.2.1. 설명
자세한 내용은 채널을 쿼리합니다.
1.6.2.2.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
네임스페이스 | 사용할 네임스페이스(예: default)입니다. | string |
1.6.2.2.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.6.2.2.4. 사용
-
application/yaml
1.6.2.2.5. 태그
- channels.apps.open-cluster-management.io
1.6.2.3. 네임스페이스의 단일 채널 쿼리
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels/{channel_name}
1.6.2.3.1. 설명
자세한 내용은 단일 채널을 쿼리합니다.
1.6.2.3.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
channel_name | 쿼리할 배포 가능의 이름입니다. | string |
경로 |
네임스페이스 | 사용할 네임스페이스(예: default)입니다. | string |
1.6.2.3.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.6.2.3.4. 태그
- channels.apps.open-cluster-management.io
1.6.2.4. 채널 삭제
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels/{channel_name}
1.6.2.4.1. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
channel_name | 삭제할 채널의 이름입니다. | string |
경로 |
네임스페이스 | 사용할 네임스페이스(예: default)입니다. | string |
1.6.2.4.2. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.6.2.4.3. 태그
- channels.apps.open-cluster-management.io
1.6.3. 정의
1.6.3.1. 채널
이름 | 스키마 |
---|---|
apiVersion | string |
종류 | string |
메타데이터 | object |
사양 |
spec
이름 | 설명 | 스키마 |
---|---|---|
configMapRef | ObjectReference에는 참조된 오브젝트를 검사하거나 수정할 수 있는 충분한 정보가 포함되어 있습니다. | |
| ChannelGate는 채널 승격 기준을 정의합니다. | |
경로 이름 | string | |
secretRef | ObjectReference에는 참조된 오브젝트를 검사하거나 수정할 수 있는 충분한 정보가 포함되어 있습니다. | |
sourceNamespaces | enum (Namespace, HelmRepo, ObjectBucket, Git, namespace, helmrepo, objectbucket, github) 배열 |
configMapRef
이름 | 설명 | 스키마 |
---|---|---|
apiVersion | 참조의 API 버전입니다. | string |
fieldPath | 전체 오브젝트 대신 오브젝트 조각을 참조하는 경우 이 문자열에는 desiredState.manifest.containers[2]와 같은 유효한 JSON/Go 필드 액세스 문이 포함되어야 합니다. 예를 들어 오브젝트 참조가 Pod 내의 컨테이너에 대한 경우 "spec.containers{name}"과 같은 값을 사용합니다(여기서 "name"은 이벤트를 트리거한 컨테이너 이름을 참조하거나 컨테이너 이름이 "spec.containers[2]"이 Pod에서 인덱스 2가 있는 컨테이너를 참조하는 경우). 이 구문은 오브젝트의 일부를 참조하는 잘 정의된 방법을 사용하는 경우에만 선택됩니다. TODO: 이 설계는 최종적이지 않으며 이 필드는 향후 변경될 수 있습니다. | string |
종류 | 일종의 추천입니다. 자세한 내용은 https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/ |
이름 |
추천자의 이름입니다. 자세한 정보: 이름 | string |
네임스페이스 |
참조의 네임스페이스입니다. 자세한 내용은 https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ | string |
resourceVersion |
이 참조가 수행되는 특정 resourceVersion(있는 경우). 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency | string |
UID |
Gates
이름 | 설명 | 스키마 |
---|---|---|
주석 | k8s의 일반적인 주석 | |
labelSelector | 레이블 선택기는 리소스 집합에 대한 레이블 쿼리입니다. matchLabels 및 matchExpressions의 결과는 ANDed입니다. 빈 라벨 선택기는 모든 오브젝트와 일치합니다. null 라벨 선택기는 오브젝트와 일치하지 않습니다. | |
이름 | string |
annotations
이름 | 스키마 |
---|---|
키 | string |
값 | string |
labelSelector
이름 | 설명 | 스키마 |
---|---|---|
matchExpressions | matchExpressions는 라벨 선택기 요구 사항 목록입니다. 요구 사항은 AND로 설정됩니다. | |
matchLabels | matchLabels는 {key,value} 쌍으로 구성된 맵입니다. matchLabels 맵의 단일 {key,value}는 키 필드가 "key"이고, 연산자는 "In"이고, values 배열에는 "value"만 포함된 matchExpressions 요소와 동일합니다. 요구 사항은 AND로 설정됩니다. | 문자열, 문자열 맵 |
matchExpressions
이름 | 설명 | 스키마 |
---|---|---|
키 | key는 선택기가 적용되는 라벨 키입니다. | string |
Operator | Operator는 일련의 값과의 키 관계를 나타냅니다. 유효한 연산자는 In, NotIn, Exists 및 DoesNotExist입니다. | string |
| 값은 문자열 값의 배열입니다. 연산자가 In 또는 NotIn인 경우 값 배열은 비어 있지 않아야 합니다. 연산자가 Exists 또는 DoesNotExist인 경우 값 배열은 비어 있어야 합니다. 이 배열은 전략적 병합 패치 중에 교체됩니다. | 문자열 배열 |
secretRef
이름 | 설명 | 스키마 |
---|---|---|
apiVersion | 참조의 API 버전입니다. | string |
fieldPath | 전체 오브젝트 대신 오브젝트 조각을 참조하는 경우 이 문자열에는 desiredState.manifest.containers[2]와 같은 유효한 JSON/Go 필드 액세스 문이 포함되어야 합니다. 예를 들어 오브젝트 참조가 Pod 내의 컨테이너에 대한 경우 "spec.containers{name}"과 같은 값을 사용합니다(여기서 "name"은 이벤트를 트리거한 컨테이너 이름을 참조하거나 컨테이너 이름이 "spec.containers[2]"이 Pod에서 인덱스 2가 있는 컨테이너를 참조하는 경우). 이 구문은 오브젝트의 일부를 참조하는 잘 정의된 방법을 사용하는 경우에만 선택됩니다. TODO: 이 설계는 최종적이지 않으며 이 필드는 향후 변경될 수 있습니다. | string |
종류 | 일종의 추천입니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | string |
이름 | 추천자의 이름입니다. 자세한 정보: 이름 | string |
네임스페이스 | 참조의 네임스페이스입니다. 자세한 내용은 https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ | string |
resourceVersion | 이 참조가 수행되는 특정 resourceVersion(있는 경우). 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency | string |
UID | 참조의 UID입니다. 자세한 정보: UIID | string |
1.7. 서브스크립션 API
1.7.1. 개요
이 문서는 Red Hat Advanced Cluster Management for Kubernetes 서브스크립션 리소스에 대한 것입니다. 서브스크립션 리소스에는 생성, 쿼리, 삭제 및 업데이트의 네 가지 요청이 있습니다. 더 이상 사용되지 않음: PlacementRule
1.7.1.1. 버전 정보
버전 : 2.12.0
1.7.1.2. URI 스키마
BasePath : /kubernetes/apis
Schemes : HTTPS
1.7.1.3. 태그
- subscriptions.apps.open-cluster-management.io : 서브스크립션 생성 및 관리
1.7.2. 경로
1.7.2.1. 서브스크립션 생성
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions
1.7.2.1.1. 설명
서브스크립션을 생성합니다.
1.7.2.1.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
네임스페이스 | 사용할 네임스페이스(예: default)입니다. | string |
본문 |
본문 | 생성할 서브스크립션을 설명하는 매개변수입니다. |
1.7.2.1.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.7.2.1.4. 사용
-
subscription/yaml
1.7.2.1.5. 태그
- subscriptions.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" : "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.7.2.2. 모든 서브스크립션 쿼리
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions
1.7.2.2.1. 설명
자세한 내용은 서브스크립션을 쿼리합니다.
1.7.2.2.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
네임스페이스 | 사용할 네임스페이스(예: default)입니다. | string |
1.7.2.2.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.7.2.2.4. 사용
-
subscription/yaml
1.7.2.2.5. 태그
- subscriptions.apps.open-cluster-management.io
1.7.2.3. 단일 서브스크립션 쿼리
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}
1.7.2.3.1. 설명
자세한 내용은 단일 서브스크립션을 쿼리합니다.
1.7.2.3.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
네임스페이스 | 사용할 네임스페이스(예: default)입니다. | string |
경로 |
subscription_name | 쿼리할 서브스크립션의 이름입니다. | string |
1.7.2.3.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.7.2.3.4. 태그
- subscriptions.apps.open-cluster-management.io
1.7.2.4. 서브스크립션 삭제
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}
1.7.2.4.1. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
네임스페이스 | 사용할 네임스페이스(예: default)입니다. | string |
경로 |
subscription_name | 삭제할 서브스크립션의 이름입니다. | string |
1.7.2.4.2. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.7.2.4.3. 태그
- subscriptions.apps.open-cluster-management.io
1.7.3. 정의
1.7.3.1. 서브스크립션
이름 | 스키마 |
---|---|
apiVersion | string |
종류 | string |
메타데이터 | |
사양 | |
상태 |
메타데이터
이름 | 스키마 |
---|---|
주석 | object |
레이블 | object |
이름 | string |
네임스페이스 | string |
spec
이름 | 스키마 |
---|---|
채널 | string |
이름 | string |
| 배열 덮어쓰기 |
packageFilter | |
packageOverrides | packageOverrides array |
배치 | |
Timewindow |
덮어쓰기
이름 | 스키마 |
---|---|
클러스터 이름 | string |
clusterOverrides | 오브젝트 배열 |
packageFilter
이름 | 설명 | 스키마 |
---|---|---|
주석 | 문자열, 문자열 맵 | |
filterRef | ||
labelSelector | ||
버전 |
패턴 : | string |
filterRef
이름 | 스키마 |
---|---|
이름 | string |
labelSelector
이름 | 스키마 |
---|---|
matchExpressions | |
matchLabels | 문자열, 문자열 맵 |
matchExpressions
이름 | 스키마 |
---|---|
키 | string |
Operator | string |
| 문자열 배열 |
packageOverrides
이름 | 스키마 |
---|---|
packageAlias | string |
PACKAGENAME | string |
packageOverrides | 오브젝트 배열 |
배치
이름 | 스키마 |
---|---|
clusterSelector | |
클러스터 | 클러스터 배열 |
로컬 | boolean |
placementRef |
clusterSelector
이름 | 스키마 |
---|---|
matchExpressions | |
matchLabels | 문자열, 문자열 맵 |
matchExpressions
이름 | 스키마 |
---|---|
키 | string |
Operator | string |
| 문자열 배열 |
클러스터
이름 | 스키마 |
---|---|
이름 | string |
placementRef
이름 | 스키마 |
---|---|
apiVersion | string |
fieldPath | string |
종류 | string |
이름 | string |
네임스페이스 | string |
resourceVersion | string |
UID | string |
timewindow
이름 | 스키마 |
---|---|
daysof week | 문자열 배열 |
시간 | 시간 배열 |
위치 | string |
windowtype | enum (active, blocked, Active, Blocked) |
몇 시간
이름 | 스키마 |
---|---|
| string |
| string |
status
이름 | 스키마 |
---|---|
lastUpdateTime | 문자열 (date-time) |
메시지 | string |
| string |
이유 | string |
상태 | object |
1.8. PlacementRules API (더 이상 사용되지 않음)
1.8.1. 개요
이 문서는 Red Hat Advanced Cluster Management for Kubernetes용 PlacementRule 리소스를 위한 것입니다. PlacementRule 리소스에는 생성, 쿼리, 삭제 및 업데이트의 네 가지 요청이 있습니다.
1.8.1.1. 버전 정보
버전 : 2.12.0
1.8.1.2. URI 스키마
BasePath : /kubernetes/apis
Schemes : HTTPS
1.8.1.3. 태그
- placementrules.apps.open-cluster-management.io : 배치 규칙 생성 및 관리
1.8.2. 경로
1.8.2.1. 배치 규칙 생성
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules
1.8.2.1.1. 설명
배치 규칙을 생성합니다.
1.8.2.1.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
네임스페이스 | 사용할 네임스페이스(예: default)입니다. | string |
본문 |
본문 | 생성할 배치 규칙을 설명하는 매개변수입니다. |
1.8.2.1.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.8.2.1.4. 사용
-
application/yaml
1.8.2.1.5. 태그
- placementrules.apps.open-cluster-management.io
1.8.2.1.6. HTTP 요청의 예
1.8.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.8.2.2. 모든 배치 규칙 쿼리
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules
1.8.2.2.1. 설명
자세한 내용은 배치 규칙을 쿼리합니다.
1.8.2.2.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
네임스페이스 | 사용할 네임스페이스(예: default)입니다. | string |
1.8.2.2.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.8.2.2.4. 사용
-
application/yaml
1.8.2.2.5. 태그
- placementrules.apps.open-cluster-management.io
1.8.2.3. 단일 placementrule 쿼리
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules/{placementrule_name}
1.8.2.3.1. 설명
자세한 내용은 단일 배치 규칙을 쿼리합니다.
1.8.2.3.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
네임스페이스 | 사용할 네임스페이스(예: default)입니다. | string |
경로 |
placementrule_name | 쿼리할 placementrule의 이름입니다. | string |
1.8.2.3.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.8.2.3.4. 태그
- placementrules.apps.open-cluster-management.io
1.8.2.4. placementrule 삭제
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules/{placementrule_name}
1.8.2.4.1. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
네임스페이스 | 사용할 네임스페이스(예: default)입니다. | string |
경로 |
placementrule_name | 삭제할 placementrule의 이름입니다. | string |
1.8.2.4.2. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.8.2.4.3. 태그
- placementrules.apps.open-cluster-management.io
1.8.3. 정의
1.8.3.1. Placementrule
이름 | 스키마 |
---|---|
apiVersion | string |
종류 | string |
메타데이터 | object |
사양 |
spec
이름 | 스키마 |
---|---|
clusterConditions | |
clusterReplicas | integer |
clusterSelector | |
클러스터 | 클러스터 배열 |
정책 | 정책 배열 |
resourceHint | |
schedulerName | string |
clusterConditions
이름 | 스키마 |
---|---|
상태 | string |
유형 | string |
clusterSelector
이름 | 스키마 |
---|---|
matchExpressions | |
matchLabels | 문자열, 문자열 맵 |
matchExpressions
이름 | 스키마 |
---|---|
키 | string |
Operator | string |
| 문자열 배열 |
클러스터
이름 | 스키마 |
---|---|
이름 | string |
Policies
이름 | 스키마 |
---|---|
apiVersion | string |
fieldPath | string |
종류 | string |
이름 | string |
네임스페이스 | string |
resourceVersion | string |
UID | string |
resourceHint
이름 | 스키마 |
---|---|
주문 | string |
유형 | string |
1.9. 애플리케이션 API
1.9.1. 개요
이 문서는 Red Hat Advanced Cluster Management for Kubernetes용 애플리케이션 리소스에 대한 것입니다. 애플리케이션 리소스에는 생성, 쿼리, 삭제 및 업데이트의 네 가지 요청이 있습니다.
1.9.1.1. 버전 정보
버전 : 2.12.0
1.9.1.2. URI 스키마
BasePath : /kubernetes/apis
Schemes : HTTPS
1.9.1.3. 태그
- applications.app.k8s.io : 애플리케이션 생성 및 관리
1.9.2. 경로
1.9.2.1. 애플리케이션 생성
POST /app.k8s.io/v1beta1/namespaces/{namespace}/applications
1.9.2.1.1. 설명
애플리케이션을 생성합니다.
1.9.2.1.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
네임스페이스 | 사용할 네임스페이스(예: default)입니다. | string |
본문 |
본문 | 생성할 애플리케이션을 설명하는 매개변수입니다. |
1.9.2.1.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.9.2.1.4. 사용
-
application/yaml
1.9.2.1.5. 태그
- applications.app.k8s.io
1.9.2.1.6. HTTP 요청의 예
1.9.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.9.2.2. 모든 애플리케이션 쿼리
GET /app.k8s.io/v1beta1/namespaces/{namespace}/applications
1.9.2.2.1. 설명
자세한 내용은 애플리케이션을 쿼리합니다.
1.9.2.2.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
네임스페이스 | 사용할 네임스페이스(예: default)입니다. | string |
1.9.2.2.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.9.2.2.4. 사용
-
application/yaml
1.9.2.2.5. 태그
- applications.app.k8s.io
1.9.2.3. 단일 애플리케이션 쿼리
GET /app.k8s.io/v1beta1/namespaces/{namespace}/applications/{application_name}
1.9.2.3.1. 설명
자세한 내용은 단일 애플리케이션을 쿼리합니다.
1.9.2.3.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
application_name | 쿼리할 애플리케이션의 이름입니다. | string |
경로 |
네임스페이스 | 사용할 네임스페이스(예: default)입니다. | string |
1.9.2.3.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.9.2.3.4. 태그
- applications.app.k8s.io
1.9.2.4. 애플리케이션 삭제
DELETE /app.k8s.io/v1beta1/namespaces/{namespace}/applications/{application_name}
1.9.2.4.1. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
application_name | 삭제할 애플리케이션의 이름입니다. | string |
경로 |
네임스페이스 | 사용할 네임스페이스(예: default)입니다. | string |
1.9.2.4.2. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.9.2.4.3. 태그
- applications.app.k8s.io
1.9.3. 정의
1.9.3.1. 애플리케이션
이름 | 스키마 |
---|---|
apiVersion | string |
종류 | string |
메타데이터 | object |
사양 |
spec
이름 | 스키마 |
---|---|
assemblyPhase | string |
구성 요소 종류 | 오브젝트 배열 |
설명자 | |
정보 | 정보 배열 |
선택기 | object |
설명자
이름 | 스키마 |
---|---|
설명 | string |
아이콘 | 아이콘 배열 |
키워드 | 문자열 배열 |
링크 | 링크 배열 |
유지 관리자 | 유지 관리자 배열 |
참고 | string |
소유자 | 소유자 배열 |
유형 | string |
버전 | string |
아이콘
이름 | 스키마 |
---|---|
크기 | string |
src | string |
유형 | string |
links
이름 | 스키마 |
---|---|
설명 | string |
URL | string |
유지 관리자
이름 | 스키마 |
---|---|
이메일 | string |
이름 | string |
URL | string |
소유자
이름 | 스키마 |
---|---|
이메일 | string |
이름 | string |
URL | string |
info
이름 | 스키마 |
---|---|
이름 | string |
유형 | string |
값 | string |
valueFrom |
valueFrom
이름 | 스키마 |
---|---|
configMapKeyRef | |
ingressRef | |
secretKeyRef | |
serviceRef | |
유형 | string |
configMapKeyRef
이름 | 스키마 |
---|---|
apiVersion | string |
fieldPath | string |
키 | string |
종류 | string |
이름 | string |
네임스페이스 | string |
resourceVersion | string |
UID | string |
ingressRef
이름 | 스키마 |
---|---|
apiVersion | string |
fieldPath | string |
호스트 | string |
종류 | string |
이름 | string |
네임스페이스 | string |
경로 | string |
resourceVersion | string |
UID | string |
secretKeyRef
이름 | 스키마 |
---|---|
apiVersion | string |
fieldPath | string |
키 | string |
종류 | string |
이름 | string |
네임스페이스 | string |
resourceVersion | string |
UID | string |
serviceRef
이름 | 스키마 |
---|---|
apiVersion | string |
fieldPath | string |
종류 | string |
이름 | string |
네임스페이스 | string |
경로 | string |
포트 | 정수(int32) |
resourceVersion | string |
UID | string |
1.10. Helm API
1.10.1. 개요
이 문서는 Red Hat Advanced Cluster Management for Kubernetes의 HelmRelease 리소스에 대한 것입니다. HelmRelease 리소스에는 생성, 쿼리, 삭제 및 업데이트의 네 가지 요청이 있습니다.
1.10.1.1. 버전 정보
버전 : 2.12.0
1.10.1.2. URI 스키마
BasePath : /kubernetes/apis
Schemes : HTTPS
1.10.1.3. 태그
- helmreleases.apps.open-cluster-management.io : helmreleases 생성 및 관리
1.10.2. 경로
1.10.2.1. helmrelease 생성
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases
1.10.2.1.1. 설명
helmrelease를 생성합니다.
1.10.2.1.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
네임스페이스 | 사용할 네임스페이스(예: default)입니다. | string |
본문 |
본문 | 생성할 helmrelease를 설명하는 매개변수입니다. |
1.10.2.1.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.10.2.1.4. 사용
-
application/yaml
1.10.2.1.5. 태그
- helmreleases.apps.open-cluster-management.io
1.10.2.1.6. HTTP 요청의 예
1.10.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.10.2.2. 모든 helmrelease 쿼리
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases
1.10.2.2.1. 설명
자세한 내용은 helmreleases를 쿼리합니다.
1.10.2.2.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
네임스페이스 | 사용할 네임스페이스(예: default)입니다. | string |
1.10.2.2.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.10.2.2.4. 사용
-
application/yaml
1.10.2.2.5. 태그
- helmreleases.apps.open-cluster-management.io
1.10.2.3. 단일 helmrelease 쿼리
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases/{helmrelease_name}
1.10.2.3.1. 설명
자세한 내용은 단일 helmrelease를 쿼리합니다.
1.10.2.3.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
helmrelease_name | 쿼리하려는 helmrelease의 이름입니다. | string |
경로 |
네임스페이스 | 사용할 네임스페이스(예: default)입니다. | string |
1.10.2.3.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.10.2.3.4. 태그
- helmreleases.apps.open-cluster-management.io
1.10.2.4. helmrelease 삭제
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases/{helmrelease_name}
1.10.2.4.1. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
helmrelease_name | 삭제할 helmrelease의 이름입니다. | string |
경로 |
네임스페이스 | 사용할 네임스페이스(예: default)입니다. | string |
1.10.2.4.2. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.10.2.4.3. 태그
- helmreleases.apps.open-cluster-management.io
1.10.3. 정의
1.10.3.1. HelmRelease
이름 | 스키마 |
---|---|
apiVersion | string |
종류 | string |
메타데이터 | object |
리포지토리 | |
사양 | object |
상태 |
리포지토리
이름 | 스키마 |
---|---|
chartName | string |
configMapRef | |
secretRef | |
소스 | |
버전 | string |
configMapRef
이름 | 스키마 |
---|---|
apiVersion | string |
fieldPath | string |
종류 | string |
이름 | string |
네임스페이스 | string |
resourceVersion | string |
UID | string |
secretRef
이름 | 스키마 |
---|---|
apiVersion | string |
fieldPath | string |
종류 | string |
이름 | string |
네임스페이스 | string |
resourceVersion | string |
UID | string |
소스
이름 | 스키마 |
---|---|
GitHub | |
helmRepo | |
유형 | string |
github
이름 | 스키마 |
---|---|
분기 | string |
chartPath | string |
URL | 문자열 배열 |
helmRepo
이름 | 스키마 |
---|---|
URL | 문자열 배열 |
status
이름 | 스키마 |
---|---|
| conditions 배열 |
배포된 릴리스 |
conditions
이름 | 스키마 |
---|---|
lastTransitionTime | 문자열 (date-time) |
메시지 | string |
이유 | string |
상태 | string |
유형 | string |
deployedRelease
이름 | 스키마 |
---|---|
매니페스트 | string |
이름 | string |
1.11. 정책 API
1.11.1. 개요
이 문서는 Red Hat Advanced Cluster Management for Kubernetes의 정책 리소스에 대한 것입니다. Policy 리소스에는 생성, 쿼리, 삭제 및 업데이트의 네 가지 요청이 있습니다.
1.11.1.1. 버전 정보
버전 : 2.12.0
1.11.1.2. URI 스키마
BasePath : /kubernetes/apis
Schemes : HTTPS
1.11.1.3. 태그
- policy.open-cluster-management.io/v1 : 정책 생성 및 관리
1.11.2. 경로
1.11.2.1. 정책 생성
POST /policy.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}
1.11.2.1.1. 설명
정책을 생성합니다.
1.11.2.1.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
네임스페이스 | 사용할 네임스페이스(예: default)입니다. | string |
본문 |
본문 | 생성할 정책을 설명하는 매개변수입니다. |
1.11.2.1.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.11.2.1.4. 사용
-
application/json
1.11.2.1.5. 태그
- policy.open-cluster-management.io
1.11.2.1.6. HTTP 요청의 예
1.11.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", "customMessage": { "compliant": [], "noncompliant": [] }, "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.11.2.2. 모든 정책 쿼리
GET /policy.open-cluster-management.io/v1/namespaces/{namespace}/policies/{policy_name}
1.11.2.2.1. 설명
자세한 내용은 정책을 쿼리합니다.
1.11.2.2.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
네임스페이스 | 정책을 적용할 네임스페이스(예: default)입니다. | string |
1.11.2.2.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.11.2.2.4. 사용
-
application/json
1.11.2.2.5. 태그
- policy.open-cluster-management.io
1.11.2.3. 단일 정책 쿼리
GET /policy.open-cluster-management.io/v1/namespaces/{namespace}/policies/{policy_name}
1.11.2.3.1. 설명
자세한 내용은 단일 정책을 쿼리합니다.
1.11.2.3.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
policy_name | 쿼리할 정책의 이름입니다. | string |
경로 |
네임스페이스 | 사용할 네임스페이스(예: default)입니다. | string |
1.11.2.3.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.11.2.3.4. 태그
- policy.open-cluster-management.io
1.11.2.4. 정책 삭제
DELETE /policy.open-cluster-management.io/v1/namespaces/{namespace}/policies/{policy_name}
1.11.2.4.1. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
policy_name | 삭제할 정책의 이름입니다. | string |
경로 |
네임스페이스 | 사용할 네임스페이스(예: default)입니다. | string |
1.11.2.4.2. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.11.2.4.3. 태그
- policy.open-cluster-management.io
1.11.3. 정의
1.11.3.1. 정책
이름 | 설명 | 스키마 |
---|---|---|
apiVersion | 버전이 지정된 정책 스키마입니다. | string |
종류 | REST 리소스를 나타내는 문자열 값입니다. | string |
메타데이터 | 정책을 정의하는 규칙을 설명합니다. | object |
spec
이름 | 설명 | 스키마 |
---|---|---|
remediationAction | 리소스에서 정의된 대로 위반을 처리하는 방법을 나타내는 값입니다. | string |
customMessage |
규정 준수 상태에 따라 구성 정책에서 사용자 지정 메시지를 구성할 수 있는 매개변수 필드입니다. 구성 정책 컨트롤러의 현재 정책 상태의 | string |
namespaceSelector | 정책이 적용되는 네임스페이스를 나타내는 값입니다. | string |
policy-templates
이름 | 설명 | 스키마 |
---|---|---|
apiVersion | 버전이 지정된 정책 스키마입니다. | string |
종류 | REST 리소스를 나타내는 문자열 값입니다. | string |
메타데이터 | 정책을 정의하는 규칙을 설명합니다. | object |
complianceType | 관리 클러스터에 평가하거나 적용해야 하는 역할 및 기타 Kubernetes 오브젝트에 대한 예상 동작을 나열하는 데 사용됩니다. | string |
metadataComplianceType |
사용자가 다른 필드와 다른 오브젝트의 레이블 및 주석을 처리할 수 있는 방법을 제공합니다. 매개변수 값은 기본값은 | string |
clusterConditions | 레이블을 정의할 섹션입니다. | string |
규칙 | string |
clusterConditions
이름 | 설명 | 스키마 |
---|---|---|
matchLabels | 정책을 네임스페이스에 적용하는 데 필요한 레이블입니다. | object |
클라우드 | 정책을 클라우드 공급자에 적용하는 데 필요한 레이블입니다. | string |
규칙
이름 | 설명 | 스키마 |
---|---|---|
apiGroups | 규칙이 적용되는 API 목록입니다. | string |
| 리소스 유형 목록입니다. | object |
동사 | 동사 목록입니다. | string |
1.12. 관찰 기능 API
1.12.1. 개요
이 문서는 Red Hat Advanced Cluster Management for Kubernetes용 MultiClusterObservability 리소스에 대한 것입니다. MultiClusterObservability 리소스에는 생성, 쿼리, 삭제 및 업데이트의 네 가지 요청이 있습니다.
1.12.1.1. 버전 정보
버전 : 2.12.0
1.12.1.2. URI 스키마
BasePath : /kubernetes/apis
Schemes : HTTPS
1.12.1.3. 태그
- observability.open-cluster-management.io : multiclusterobservabilities 생성 및 관리
1.12.2. 경로
1.12.2.1. multiclusterobservability 리소스 생성
POST /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities
1.12.2.1.1. 설명
MultiClusterObservability 리소스를 생성합니다.
1.12.2.1.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
본문 |
본문 | 생성할 MultiClusterObservability 리소스를 설명하는 매개변수입니다. |
1.12.2.1.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.12.2.1.4. 사용
-
application/yaml
1.12.2.1.5. 태그
- observability.apps.open-cluster-management.io
1.12.2.1.6. HTTP 요청의 예
1.12.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.12.2.2. 모든 multiclusterobservabilities 쿼리
GET /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities
1.12.2.2.1. 설명
자세한 내용은 MultiClusterObservability 리소스를 쿼리합니다.
1.12.2.2.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
1.12.2.2.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.12.2.2.4. 사용
-
application/yaml
1.12.2.2.5. 태그
- observability.apps.open-cluster-management.io
1.12.2.3. 단일 multiclusterobservability 쿼리
GET /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities/{multiclusterobservability_name}
1.12.2.3.1. 설명
자세한 내용은 단일 MultiClusterObservability 리소스를 쿼리합니다.
1.12.2.3.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
multiclusterobservability_name | 쿼리할 multiclusterobservability의 이름입니다. | string |
1.12.2.3.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.12.2.3.4. 태그
- observability.apps.open-cluster-management.io
1.12.2.4. multiclusterobservability 리소스 삭제
DELETE /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities/{multiclusterobservability_name}
1.12.2.4.1. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
multiclusterobservability_name | 삭제할 multiclusterobservability의 이름입니다. | string |
1.12.2.4.2. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.12.2.4.3. 태그
- observability.apps.open-cluster-management.io
1.12.3. 정의
1.12.3.1. MultiClusterObservability
이름 | 설명 | 스키마 |
---|---|---|
apiVersion | MultiClusterObservability의 버전이 지정된 스키마입니다. | string |
종류 | REST 리소스 MultiClusterObservability를 나타내는 문자열 값입니다. | string |
메타데이터 | 정책을 정의하는 규칙을 설명합니다. | object |
spec
이름 | 설명 | 스키마 |
---|---|---|
enableDownsampling |
downsample을 활성화하거나 비활성화합니다. 기본값은 | boolean |
imagePullPolicy |
MultiClusterObservability 이미지의 가져오기 정책입니다. 기본값은 | corev1.PullPolicy |
imagePullSecret |
MultiClusterObservability 이미지의 시크릿을 가져옵니다. 기본값은 | string |
nodeSelector | 노드 선택기의 사양입니다. | map[string]string |
observabilityAddonSpec | 관찰 기능 애드온이 설치된 모든 관리 클러스터에 대한 글로벌 설정입니다. | |
StorageConfig | 관찰 기능에서 사용할 스토리지 구성을 지정합니다. | StorageConfig |
허용 오차 | 모든 구성 요소가 모든 테인트를 허용할 수 있는 기능이 제공됨. | []corev1.Toleration |
고급 | 관찰을 위한 고급 구성 설정입니다. | |
리소스 | MultiClusterObservability에 필요한 컴퓨팅 리소스 | corev1.ResourceRequirements |
복제본 | MultiClusterObservability의 복제본입니다. | integer |
storageConfig
이름 | 설명 | 스키마 |
---|---|---|
alertmanagerStorageSize |
alertmanager stateful 세트에 적용되는 스토리지 양입니다. 기본값은 | string |
compactStorageSize |
thanos 컴팩트 상태 저장 세트에 적용되는 스토리지의 양입니다. 기본값은 | string |
metricObjectStorage | 메트릭에 대한 시크릿을 구성하는 오브젝트 저장소입니다. | |
receiveStorageSize |
thanos에 적용되는 스토리지 양은 상태 저장 세트를 수신합니다. 기본값은 | string |
ruleStorageSize |
thanos 규칙 상태 저장 세트에 적용되는 스토리지의 양입니다. 기본값은 | string |
storageClass |
| string |
storeStorageSize |
thanos 저장소 상태 저장 세트에 적용되는 스토리지의 양입니다. 기본값은 | string |
writeStorage | 엔드포인트 액세스 정보 목록입니다. | [ ]WriteStorage |
writeStorage
이름 | 설명 | 스키마 |
---|---|---|
이름 | 엔드포인트 액세스 정보가 포함된 시크릿의 이름입니다. | string |
키 | 선택할 시크릿의 키입니다. | string |
metricObjectStorage
이름 | 설명 | 스키마 |
---|---|---|
키 | 선택할 시크릿의 키입니다. 유효한 시크릿 키여야 합니다. Thanos 설명서를 참조하십시오. | string |
이름 |
| string |
observabilityAddonSpec
이름 | 설명 | 스키마 |
---|---|---|
enableMetrics |
관찰 기능 애드온이 허브 클러스터로 지표를 전송하는지 여부를 나타냅니다. 기본값은 | boolean |
간격 |
관찰 기능 애드온에서 허브 클러스터로 메트릭을 전송하는 때의 간격입니다. 기본값은 300초( | integer |
리소스 |
지표 수집기 리소스 요구 사항에 대한 리소스입니다. 기본 CPU 요청은 | corev1.ResourceRequirements |
고급
이름 | 설명 | 스키마 |
---|---|---|
retentionConfig | 관찰 기능에서 사용할 데이터 보존 구성을 지정합니다. |
|
rbacQueryProxy | rbac-query-proxy 배포의 복제본 및 리소스를 지정합니다. | CommonSpec |
Grafana | grafana 배포의 복제본 및 리소스를 지정합니다. | CommonSpec |
Alertmanager | alertmanager statefulset의 복제본 및 리소스를 지정합니다. | CommonSpec |
observatoriumAPI |
| CommonSpec |
queryFrontend | query-frontend 배포의 복제본 및 리소스를 지정합니다. | CommonSpec |
| 쿼리 배포에 대한 복제본 및 리소스를 지정합니다. | CommonSpec |
선택 사항 | 수신 상태 저장 세트의 복제본 및 리소스를 지정합니다. | CommonSpec |
규칙 | 규칙 상태 저장 세트의 복제본 및 리소스를 지정합니다. | CommonSpec |
저장 | 저장소 상태 저장 세트의 복제본 및 리소스를 지정합니다. | CommonSpec |
CompactSpec | 컴팩트한 상태 저장 세트의 리소스를 지정합니다. | |
StoreMemcached | store-memcached의 복제본, 리소스 등을 지정합니다. | |
queryFrontendMemcached | query-frontend-memcached의 replicas, resources 등을 지정합니다. | CacheConfig |
retentionConfig
이름 | 설명 | 스키마 |
---|---|---|
블록 기간 |
시계열 데이터베이스(TSDB) 블록의 기간을 차단하는 시간입니다. 기본값은 | string |
deleteDelay |
삭제로 표시된 블록이 버킷에서 삭제될 때까지의 시간입니다. 기본값은 | string |
retentionInLocal |
로컬 스토리지의 원시 샘플을 유지하는 시간입니다. 기본값은 | string |
retentionResolutionRaw |
버킷에서 원시 해상도 샘플을 유지하는 시간입니다. 기본값은 365일( | string |
retentionResolution5m |
버킷에서 해상도 1(5분)의 샘플을 유지하는 시간입니다. 기본값은 365일(24 | string |
retentionResolution1h |
버킷에서 해상도 2(1시간)의 샘플을 유지하는 시간입니다. 기본값은 365일(24 | string |
CompactSpec
이름 | 설명 | 스키마 |
---|---|---|
리소스 | thanos 컴팩트에 필요한 컴퓨팅 리소스. | corev1.ResourceRequirements |
serviceAccountAnnotations | 주석은 컴팩트 서비스 계정으로 저장된 구조화되지 않은 키 값 맵입니다. | map[string]string |
storeMemcached
이름 | 설명 | 스키마 |
---|---|---|
리소스 | MultiCLusterObservability에 필요한 컴퓨팅 리소스 | corev1.ResourceRequirements |
복제본 | MultiClusterObservability의 복제본입니다. | integer |
memoryLimitMb | Memcached 메가바이트의 메모리 제한입니다. | integer |
maxItemSize |
Memcached의 최대 항목 크기입니다. 기본값은 | string |
connectionLimit | Memcached의 최대 동시 연결입니다. 기본값은 | integer |
status
이름 | 설명 | 스키마 |
---|---|---|
상태 | 상태에는 MultiClusterObservability의 다른 조건 상태가 포함됩니다. | metav1.Condition |
CommonSpec
이름 | 설명 | 스키마 |
---|---|---|
리소스 | 구성 요소에 필요한 컴퓨팅 리소스입니다. | corev1.ResourceRequirements |
복제본 | 구성 요소의 복제본입니다. | integer |
QuerySpec
이름 | 설명 | 스키마 |
CommonSpec | 쿼리 배포에 대한 복제본 및 리소스를 지정합니다. | CommonSpec |
serviceAccountAnnotations | 주석은 쿼리 서비스 계정으로 저장된 구조화되지 않은 키 값 맵입니다. | map[string]string |
ReceiveSpec
이름 | 설명 | 스키마 |
CommonSpec | 쿼리 배포에 대한 복제본 및 리소스를 지정합니다. | CommonSpec |
serviceAccountAnnotations | 주석은 쿼리 서비스 계정으로 저장된 구조화되지 않은 키 값 맵입니다. | map[string]string |
StoreSpec
이름 | 설명 | 스키마 |
CommonSpec | 쿼리 배포에 대한 복제본 및 리소스를 지정합니다. | CommonSpec |
serviceAccountAnnotations | 주석은 쿼리 서비스 계정으로 저장된 구조화되지 않은 키 값 맵입니다. | map[string]string |
RuleSpec
이름 | 설명 | 스키마 |
CommonSpec | 쿼리 배포에 대한 복제본 및 리소스를 지정합니다. | CommonSpec |
evalInterval | 규칙의 평가 간격을 지정합니다. | string |
serviceAccountAnnotations | 주석은 쿼리 서비스 계정으로 저장된 구조화되지 않은 키 값 맵입니다. | map[string]string |
1.13. 검색 쿼리 API
검색 쿼리 API는 Kubernetes API가 아니므로 Red Hat OpenShift Container Platform API Explorer를 통해 표시되지 않습니다. 검색 쿼리 API 기능을 이해하기 위해 계속 읽습니다.
1.13.1. 개요
경로와 함께 검색 쿼리 API를 노출하고 API를 사용하여 검색 쿼리를 해결할 수 있습니다. API는 GraphQL 끝점입니다. curl 또는 Postman과 같은 모든 클라이언트를 사용할 수 있습니다.
1.13.1.1. 버전 정보
버전 : 2.10.0
1.13.1.2. URI 스키마
BasePath : /searchapi/graphql
Schemes : HTTPS
1.13.1.3. API 액세스 구성
다음 명령을 사용하여 클러스터 외부에서 Search API에 액세스할 경로를 생성합니다.
oc create route passthrough search-api --service=search-search-api -n open-cluster-management
중요: 환경을 보호하려면 경로를 구성해야 합니다. 자세한 내용은 OpenShift Container Platform 설명서의 경로 구성 을 참조하십시오.
1.13.2. 스키마 설계
input SearchFilter { property: String! values: [String]! } input SearchInput { keywords: [String] filters: [SearchFilter] limit: Int relatedKinds: [String] } type SearchResult { count: Int items: [Map] related: [SearchRelatedResult] } type SearchRelatedResult { kind: String! count: Int items: [Map] }
!
가 포함된 매개변수는 필드가 필요함을 나타냅니다.
1.13.2.1. 쿼리 입력 설명
유형 | 설명 | 속성 |
---|---|---|
SearchFilter | 결과를 필터링할 키와 값을 정의합니다. 속성에 많은 값을 제공할 때 API는 값을 "OR" 작업으로 해석합니다. 여러 필터를 제공하면 결과가 모든 필터와 일치하고 API는 "AND" 작업으로 해석됩니다. | string |
SearchInput | 리소스 목록을 받으려면 핵심 단어를 입력합니다. 많은 키워드를 제공하면 API는 이를 "AND" 작업으로 해석합니다. | 문자열 |
제한 |
쿼리를 입력한 후 반환되는 최대 결과 수를 확인합니다. 기본값은 | 정수 |
1.13.2.2. 스키마 예
{ "query": "type SearchResult {count: Intitems: [Map]related: [SearchRelatedResult]} type SearchRelatedResult {kind: String!count: Intitems: [Map]}", "variables": { "input": [ { "keywords": [], "filters": [ { "property": "kind", "values": [ "Deployment" ] } ], "limit": 10 } ] } }
1.13.3. 일반 스키마
type Query { search(input: [SearchInput]): [SearchResult] searchComplete(property: String!, query: SearchInput, limit: Int): [String] searchSchema: Map messages: [Message] }
1.13.4. 지원되는 쿼리
JSON 형식으로 지원되는 쿼리 유형을 확인하려면 계속 읽습니다.
1.13.4.1. 배포 검색
쿼리:
query mySearch($input: [SearchInput]) { search(input: $input) { items } }
변수:
{"input":[ { "keywords":[], "filters":[ {"property":"kind","values":["Deployment"]}], "limit":10 } ]}
1.13.4.2. Pod 검색
쿼리:
query mySearch($input: [SearchInput]) { search(input: $input) { items } }
변수:
{"input":[ { "keywords":[], "filters":[ {"property":"kind","values":["Pod"]}], "limit":10 } ]}
1.14. MultiClusterHub API
1.14.1. 개요
이 문서는 Red Hat Advanced Cluster Management for Kubernetes용 MultiClusterHub 리소스에 대한 것입니다. MultiClusterHub 리소스에는 생성, 쿼리, 삭제 및 업데이트의 네 가지 가능한 요청이 있습니다.
1.14.1.1. 버전 정보
버전 : 2.12.0
1.14.1.2. URI 스키마
BasePath : /kubernetes/apis
Schemes : HTTPS
1.14.1.3. 태그
- multiclusterhubs.operator.open-cluster-management.io : 다중 클러스터 허브 Operator 생성 및 관리
1.14.2. 경로
1.14.2.1. MultiClusterHub 리소스 생성
POST /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/mch
1.14.2.1.1. 설명
MultiClusterHub 리소스를 생성하여 다중 클러스터 허브 인스턴스의 구성을 정의합니다.
1.14.2.1.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
네임스페이스 | 사용할 네임스페이스(예: default)입니다. | string |
본문 |
본문 | 생성할 다중 클러스터 허브를 설명하는 매개변수입니다. |
1.14.2.1.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.14.2.1.4. 사용
-
multiclusterhubs/yaml
1.14.2.1.5. 태그
- multiclusterhubs.operator.open-cluster-management.io
1.14.2.1.6. HTTP 요청의 예
1.14.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, a central point for managing multiple Kubernetes-based clusters. The deployment of multicluster hub components is determined based on the configuration that is defined in this resource.", "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 Red Hat Advanced Cluster Management.", } "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.14.2.2. 모든 MultiClusterHubs 쿼리
GET /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/operator
1.14.2.2.1. 설명
자세한 내용은 다중 클러스터 허브 Operator를 쿼리합니다.
1.14.2.2.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
네임스페이스 | 사용할 네임스페이스(예: default)입니다. | string |
1.14.2.2.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.14.2.2.4. 사용
-
operator/yaml
1.14.2.2.5. 태그
- multiclusterhubs.operator.open-cluster-management.io
1.14.2.3. MultiClusterHub Operator 쿼리
GET /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/operator/{multiclusterhub_name}
1.14.2.3.1. 설명
자세한 내용은 단일 다중 클러스터 허브 Operator를 쿼리합니다.
1.14.2.3.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
application_name | 쿼리할 애플리케이션의 이름입니다. | string |
경로 |
네임스페이스 | 사용할 네임스페이스(예: default)입니다. | string |
1.14.2.3.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.14.2.3.4. 태그
- multiclusterhubs.operator.open-cluster-management.io
1.14.2.4. MultiClusterHub Operator 삭제
DELETE /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/operator/{multiclusterhub_name}
1.14.2.4.1. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
application_name | 삭제할 다중 클러스터 허브 Operator의 이름입니다. | string |
경로 |
네임스페이스 | 사용할 네임스페이스(예: default)입니다. | string |
1.14.2.4.2. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.14.2.4.3. 태그
- multiclusterhubs.operator.open-cluster-management.io
1.14.3. 정의
1.14.3.1. 다중 클러스터 허브 Operator
이름 | 설명 | 스키마 |
---|---|---|
apiVersion | MultiClusterHub의 버전이 지정된 스키마입니다. | string |
종류 | REST 리소스를 나타내는 문자열 값입니다. | string |
메타데이터 | 리소스를 정의하는 규칙을 설명합니다. | object |
사양 | 리소스 사양입니다. |
spec
availabilityConfig optional | 가용성 향상을 위해 배포 복제를 지정합니다. 기본값은 High 입니다. | string |
---|---|---|
customCAConfigmap | Red Hat Advanced Cluster Management에 사용자 지정 OpenShift 기본 수신 CA 인증서를 제공합니다. | string |
disableHubSelfManagement | 허브 클러스터 자동 가져오기를 관리 클러스터로 비활성화합니다. | boolean |
disableUpdateClusterImageSets | ClusterImageSets의 자동 업데이트를 비활성화합니다. | boolean |
Hive | (더 이상 사용되지 않음) 기본 HiveConfig 사양에 대해 재정의하는 오브젝트입니다. | |
imagePullSecret | MultiClusterHub 피연산자 및 끝점 이미지에 액세스하기 위해 풀 시크릿을 덮어씁니다. | string |
Ingress | 수신 관리를 위한 구성 옵션입니다. | |
nodeSelector | 노드 선택기를 설정합니다. | string |
separateCertificateManagement |
(더 이상 사용되지 않음) | boolean |
Hive
additionalCertificateAuthorities optional | (더 이상 사용되지 않음) 대상 클러스터와 통신할 때 사용할 추가 인증 기관이 포함된 hive 네임스페이스의 보안에 대한 참조 목록입니다. 이러한 인증 기관은 설치 시 각 클러스터에서 생성한 자체 서명된 CA 외에도 사용됩니다. | object |
---|---|---|
백업 | (더 이상 사용되지 않음) 백업 통합 구성을 지정합니다. 없는 경우 백업 통합이 비활성화됩니다. | |
externalDNS |
(더 이상 사용되지 않음) Hive에서 배포해야 하는 경우 | object |
failedProvisionConfig | (더 이상 사용되지 않음) 프로비저닝 실패 처리와 관련된 설정을 구성하는 데 사용됩니다. | |
globalPullSecret |
(더 이상 사용되지 않음) 모든 클러스터 배포에서 전역적으로 사용되는 풀 시크릿을 지정하는 데 사용됩니다. 각 클러스터 배포의 경우 | object |
maintenanceMode |
(더 이상 사용되지 않음) Hive 유형의 종료자를 추가하거나 작동하는 아무 것도 실행하지 않는 경우 하이브 컨트롤러를 비활성화하도록 true로 설정할 수 있습니다. 이는 거의 필요하지 않습니다. | boolean |
Ingress
sslCiphers optional | 관리 수신에 활성화된 SSL 암호 목록입니다. 기본값은 지원되는 암호의 전체 목록입니다. | string |
---|
Backup
minBackupPeriodSeconds optional | (더 이상 사용되지 않음) 각 백업 간에 최소 MinBackupPeriodSeconds 가 발생하도록 지정합니다. 이는 제한 백업을 평가하는 데 사용됩니다. 이로 인해 여러 변경 사항을 하나의 백업에 배치될 수 있습니다. 이 간격 동안 변경 사항이 대기열에 추가되면 백업이 손실되지 않으며 간격이 완료되면 백업이 발생합니다. | integer |
---|---|---|
Velero | (더 이상 사용되지 않는) Velero는 Velero 백업 통합을 위한 구성을 지정합니다. | object |
failedProvisionConfig
skipGatherLogs optional | (더 이상 사용되지 않음) 어떤 이유로든 설치 실패 시 클러스터에서 전체 로그를 수집하려고 하는 기능을 비활성화합니다. 로그는 최대 7일 동안 영구 볼륨에 저장됩니다. | boolean |
---|
status
구성 요소 선택 사항 | 상태 구성의 구성 요소입니다. | object |
---|---|---|
조건 | 다중 클러스터 허브에 대한 다양한 조건을 포함합니다. | |
desiredVersion | 원하는 버전을 나타냅니다. | string |
|
MultiClusterHub 리소스의 활성 단계를 나타냅니다. 이 매개변수에 사용되는 값은 | string |
conditions
lastTransitionTime optional | 조건이 한 상태에서 다른 상태로 마지막으로 변경된 경우입니다. | string |
---|---|---|
lastUpdateTime | 이 조건이 마지막으로 업데이트된 시간입니다. | string |
메시지 | message는 마지막 상태 변경에 대한 세부 정보를 나타내는 사람이 읽을 수 있는 메시지입니다. | string |
| 조건 상태가 변경된 이유에 대한 간략한 이유가 있습니다. | string |
상태 | 조건의 상태: | string |
유형 | 클러스터 조건 유형입니다. | string |
StatusConditions
종류 필요 | 이 상태를 나타내는 리소스 종류입니다 . | string |
---|---|---|
사용 가능한 | 이 구성 요소가 올바르게 실행되고 있는지 여부를 나타냅니다. | boolean |
lastTransitionTime | 조건이 한 상태에서 다른 상태로 마지막으로 변경된 경우입니다. | metav1.time |
lastUpdateTime | 이 조건이 마지막으로 업데이트된 시간입니다. | metav1.time |
메시지 | message는 마지막 상태 변경에 대한 세부 정보를 나타내는 사람이 읽을 수 있는 메시지입니다. | string |
이유 | 조건 상태가 변경된 이유에 대한 간략한 이유가 있습니다. | string |
상태 | 조건의 상태: | string |
유형 | 클러스터 조건 유형입니다. | string |
1.15. 배치 API (v1beta1)
1.15.1. 개요
이 문서는 Red Hat Advanced Cluster Management for Kubernetes의 배치 리소스에 대한 것입니다. 배치 리소스에는 생성, 쿼리, 삭제 및 업데이트의 네 가지 요청이 있습니다. placement는 배치 네임스페이스에 바인딩된 ManagedClusterSets에서 ManagedClusterSets 집합을 선택하는 규칙을 정의합니다. 이 배치에서 선택한 ManagedCluster를 나타내기 위해 cluster.open-cluster-management.io/placement={placement name}
레이블이 있는 PlacementDecisions 슬라이스가 생성됩니다.
1.15.1.1. 버전 정보
버전 : 2.12.0
1.15.1.2. URI 스키마
BasePath : /kubernetes/apis
Schemes : HTTPS
1.15.1.3. 태그
- cluster.open-cluster-management.io : 배치 생성 및 관리
1.15.2. 경로
1.15.2.1. 모든 배치 쿼리
GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placement
1.15.2.1.1. 설명
자세한 내용은 배치를 쿼리합니다.
1.15.2.1.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
1.15.2.1.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.15.2.1.4. 사용
-
placement/yaml
1.15.2.1.5. 태그
- cluster.open-cluster-management.io
1.15.2.2. 배치 생성
POST /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placements
1.15.2.2.1. 설명
배치를 생성합니다.
1.15.2.2.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
본문 |
본문 | 생성할 배치 바인딩을 설명하는 매개변수입니다. |
1.15.2.2.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.15.2.2.4. 사용
-
placement/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" : "Placement", "metadata" : { "name" : "placement1", "namespace": "ns1" }, "spec": { "predicates": [ { "requiredClusterSelector": { "labelSelector": { "matchLabels": { "vendor": "OpenShift" } } } } ] }, "status" : { } }
1.15.2.3. 단일 배치 쿼리
GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placements/{placement_name}
1.15.2.3.1. 설명
자세한 내용은 단일 배치를 쿼리합니다.
1.15.2.3.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
placement_name | 쿼리할 배치의 이름입니다. | 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. 배치 삭제
DELETE /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placements/{placement_name}
1.15.2.4.1. 설명
단일 배치를 삭제합니다.
1.15.2.4.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
placement_name | 삭제할 배치의 이름입니다. | 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. 배치
이름 | 설명 | 스키마 |
---|---|---|
apiVersion | 배치의 버전이 지정된 스키마입니다. | string |
종류 | REST 리소스를 나타내는 문자열 값입니다. | string |
메타데이터 | 배치의 메타데이터입니다. | object |
사양 | 배치의 사양입니다. |
spec
이름 | 설명 | 스키마 |
---|---|---|
clusterSets |
| 문자열 배열 |
numberOfClusters |
선택할 | 정수(int32) |
서술자 |
| |
prioritizerPolicy | 우선순위의 정책입니다. | |
허용 오차 | 허용하지만 필요하지 않은 값은 허용 오차가 일치하는 배치를 통해 특정 테인트가 있는 관리 클러스터를 선택할 수 있습니다. | 톨러레이션 어레이 |
clusterPredicate
이름 | 설명 | 스키마 |
---|---|---|
requiredClusterSelector |
레이블 및 클러스터 클레임이 있는 |
clusterSelector
이름 | 설명 | 스키마 |
---|---|---|
labelSelector |
라벨별 | object |
claimSelector |
클레임에 의한 |
clusterClaimSelector
이름 | 설명 | 스키마 |
---|---|---|
matchExpressions | 클러스터 클레임 선택기 요구 사항의 하위 집합입니다. 조건부 논리는 AND 입니다. | < object > array |
prioritizerPolicy
이름 | 설명 | 스키마 |
---|---|---|
모드 |
| string |
구성 | prioritizer의 구성입니다. |
prioritizerConfig
이름 | 설명 | 스키마 |
---|---|---|
scoreCoordinate | prioritizer 및 score 소스의 구성입니다. | |
가중치 | 우선 순위 점수의 가중치입니다. 값은 [-10,10] 범위 내에 있어야 합니다. | int32 |
scoreCoordinate
이름 | 설명 | 스키마 |
---|---|---|
유형 | 우선순위가 있는 점수의 유형입니다. 유효한 값은 "builtIn" 또는 "AddOn"입니다. | string |
builtIn |
다음 옵션의 | string |
addOn |
type이 | object |
톨러레이션
이름 | 설명 | 스키마 |
---|---|---|
키 | 허용 오차가 적용되는 테인트 키입니다. 비어있는 것은 모든 테인트 키와 일치함을 의미합니다. | string |
Operator |
값에 대한 키의 관계입니다. 유효한 연산자는 | string |
값 | 톨러레이션과 일치하는 테인트 값입니다. | string |
effect |
일치시킬 테인트 효과입니다. 비어있는 것은 모든 테인트 효과와 일치하는 것을 의미합니다. 지정된 경우 허용되는 값은 | string |
tolerationSeconds | 테인트가 허용되는 시간이며 그 후에는 테인트가 허용되지 않습니다. 기본값은 nil이며, 이는 테인트를 허용하는 기간에 대한 시간 제한이 없음을 나타냅니다. | int64 |
1.16. PlacementDecisions API (v1beta1)
1.16.1. 개요
이 문서는 Red Hat Advanced Cluster Management for Kubernetes용 PlacementDecision 리소스를 위한 것입니다. PlacementDecision 리소스에는 생성, 쿼리, 삭제 및 업데이트의 네 가지 요청이 있습니다. PlacementDecision은 배치에서 결정을 나타냅니다. PlacementDecision에서는 cluster.open-cluster-management.io/placement={placement name}
레이블을 사용하여 특정 배치를 참조합니다.
1.16.1.1. 버전 정보
버전 : 2.12.0
1.16.1.2. URI 스키마
BasePath : /kubernetes/apis
Schemes : HTTPS
1.16.1.3. 태그
- cluster.open-cluster-management.io : PlacementDecisions를 생성 및 관리합니다.
1.16.2. 경로
1.16.2.1. 모든 PlacementDecisions 쿼리
GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placementdecisions
1.16.2.1.1. 설명
자세한 내용은 PlacementDecisions를 쿼리합니다.
1.16.2.1.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
1.16.2.1.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.16.2.1.4. 사용
-
placementdecision/yaml
1.16.2.1.5. 태그
- cluster.open-cluster-management.io
1.16.2.2. PlacementDecision 생성
POST /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placementdecisions
1.16.2.2.1. 설명
PlacementDecision을 생성합니다.
1.16.2.2.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
본문 |
본문 | 생성할 PlacementDecision을 설명하는 매개변수입니다. |
1.16.2.2.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.16.2.2.4. 사용
-
placementdecision/yaml
1.16.2.2.5. 태그
- cluster.open-cluster-management.io
1.16.2.2.6. HTTP 요청의 예
1.16.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.16.2.3. 단일 PlacementDecision 쿼리
GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placementdecisions/{placementdecision_name}
1.16.2.3.1. 설명
자세한 내용은 단일 PlacementDecision을 쿼리합니다.
1.16.2.3.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
placementdecision_name | 쿼리할 PlacementDecision의 이름입니다. | string |
1.16.2.3.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.16.2.3.4. 태그
- cluster.open-cluster-management.io
1.16.2.4. PlacementDecision 삭제
DELETE /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placementdecisions/{placementdecision_name}
1.16.2.4.1. 설명
단일 PlacementDecision을 삭제합니다.
1.16.2.4.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
placementdecision_name | 삭제할 PlacementDecision의 이름입니다. | string |
1.16.2.4.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.16.2.4.4. 태그
- cluster.open-cluster-management.io
1.16.3. 정의
1.16.3.1. PlacementDecision
이름 | 설명 | 스키마 |
---|---|---|
apiVersion |
| string |
종류 | REST 리소스를 나타내는 문자열 값입니다. | string |
메타데이터 |
| object |
상태 |
|
PlacementStatus
이름 | 설명 | 스키마 |
---|---|---|
| 배치에 따른 결정 슬라이스. |
ClusterDecision
이름 | 설명 | 스키마 |
---|---|---|
클러스터 이름 |
| string |
|
| string |
1.17. DiscoveryConfig API
1.17.1. 개요
이 문서는 Red Hat Advanced Cluster Management for Kubernetes용 DiscoveryConfig 리소스에 대한 것입니다. DiscoveryConfig 리소스에는 생성, 쿼리, 삭제 및 업데이트의 네 가지 요청이 있습니다.
1.17.1.1. 버전 정보
버전 : 2.12.0
1.17.1.2. URI 스키마
BasePath : /kubernetes/apis
Schemes : HTTPS
1.17.1.3. 태그
- discoveryconfigs.discovery.open-cluster-management.io : DiscoveryConfigs 생성 및 관리
1.17.2. 경로
1.17.2.1. DiscoveryConfig 생성
POST /app.k8s.io/v1/namespaces/{namespace}/discoveryconfigs
1.17.2.1.1. 설명
DiscoveryConfig를 생성합니다.
1.17.2.1.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
네임스페이스 | 사용할 네임스페이스(예: default)입니다. | string |
본문 |
본문 | 생성할 DiscoveryConfig를 설명하는 매개변수입니다. | DiscoveryConfig |
1.17.2.1.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.17.2.1.4. 사용
-
discoveryconfigs/yaml
1.17.2.1.5. 태그
- discoveryconfigs.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": "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.15\"", "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.17.2.2. 모든 DiscoveryConfig 쿼리
GET /operator.open-cluster-management.io/v1/namespaces/{namespace}/operator
1.17.2.2.1. 설명
자세한 내용은 Discovery config Operator를 쿼리합니다.
1.17.2.2.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
네임스페이스 | 사용할 네임스페이스(예: default)입니다. | string |
1.17.2.2.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.17.2.2.4. 사용
-
operator/yaml
1.17.2.2.5. 태그
- discoveryconfigs.discovery.open-cluster-management.io
1.17.2.3. DiscoveryConfig Operator 삭제
DELETE /operator.open-cluster-management.io/v1/namespaces/{namespace}/operator/{discoveryconfigs_name}
1.17.2.3.1. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
application_name | 삭제할 Discovery Config Operator의 이름입니다. | string |
경로 |
네임스페이스 | 사용할 네임스페이스(예: default)입니다. | string |
1.17.2.3.2. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.17.2.3.3. 태그
- discoveryconfigs.operator.open-cluster-management.io
1.17.3. 정의
1.17.3.1. DiscoveryConfig
이름 | 설명 | 스키마 |
---|---|---|
apiVersion | discoveryconfigs의 버전이 지정된 스키마입니다. | string |
종류 | REST 리소스를 나타내는 문자열 값입니다. | string |
메타데이터 | 리소스를 정의하는 규칙을 설명합니다. | object |
사양 | DiscoveryConfig의 원하는 상태를 정의합니다. | 사양 목록을참조하십시오. |
1.17.3.2. 사양 목록
이름 | 설명 | 스키마 |
---|---|---|
인증 정보 | 인증 정보는 사용자를 대신하여 OCM API에 연결하기 위한 인증 정보가 포함된 시크릿입니다. | string |
필터 | 검색할 클러스터 유형에 대한 제한을 설정합니다. | 필터 목록보기 |
1.17.3.3. 필터 목록
이름 | 설명 | 스키마 |
---|---|---|
lastActive | LastActive는 활동 타임 스탬프에 의해 결정되는 검색 할 클러스터의 며칠 동안 마지막으로 활성 상태입니다. | integer |
openShiftVersions | OpenShiftVersions는 "<Major>.<Minor>" 형식의 OpenShift 릴리스 버전 목록입니다. | object |
1.18. DiscoveredCluster API
1.18.1. 개요
이 문서는 Red Hat Advanced Cluster Management for Kubernetes용 DiscoveredCluster 리소스에 대한 것입니다. DiscoveredCluster 리소스에는 생성, 쿼리, 삭제 및 업데이트의 네 가지 요청이 있습니다.
1.18.1.1. 버전 정보
버전 : 2.12.0
1.18.1.2. URI 스키마
BasePath : /kubernetes/apis
Schemes : HTTPS
1.18.1.3. 태그
- discoveredclusters.discovery.open-cluster-management.io : DiscoveredClusters 생성 및 관리
1.18.2. 경로
1.18.2.1. DiscoveredCluster 만들기
POST /app.k8s.io/v1/namespaces/{namespace}/discoveredclusters
1.18.2.1.1. 설명
DiscoveredCluster를 만듭니다.
1.18.2.1.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
네임스페이스 | 사용할 네임스페이스(예: default)입니다. | string |
본문 |
본문 | 생성할 DiscoveredCluster를 설명하는 매개변수입니다. | DiscoveredCluster |
1.18.2.1.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.18.2.1.4. 사용
-
discoveredclusters/yaml
1.18.2.1.5. 태그
- discoveredclusters.discovery.open-cluster-management.io
1.18.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.18.2.2. 모든 DiscoveredClusters 쿼리
GET /operator.open-cluster-management.io/v1/namespaces/{namespace}/operator
1.18.2.2.1. 설명
자세한 내용은 검색된 클러스터 Operator를 쿼리합니다.
1.18.2.2.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
네임스페이스 | 사용할 네임스페이스(예: default)입니다. | string |
1.18.2.2.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.18.2.2.4. 사용
-
operator/yaml
1.18.2.2.5. 태그
- discoveredclusters.discovery.open-cluster-management.io
1.18.2.3. DiscoveredCluster Operator 삭제
DELETE /operator.open-cluster-management.io/v1/namespaces/{namespace}/operator/{discoveredclusters_name}
1.18.2.3.1. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
application_name | 삭제할 Discovered Cluster Operator의 이름입니다. | string |
경로 |
네임스페이스 | 사용할 네임스페이스(예: default)입니다. | string |
1.18.2.3.2. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.18.2.3.3. 태그
- discoveredclusters.operator.open-cluster-management.io
1.18.3. 정의
1.18.3.1. DiscoveredCluster
이름 | 설명 | 스키마 |
---|---|---|
apiVersion | 검색된 클러스터의 버전이 지정된 스키마입니다. | string |
종류 | REST 리소스를 나타내는 문자열 값입니다. | string |
메타데이터 | 리소스를 정의하는 규칙을 설명합니다. | object |
사양 | DiscoveredClusterSpec은 원하는 상태를 DiscoveredCluster로 정의합니다. | 사양 목록을참조하십시오. |
1.18.3.2. 사양 목록
이름 | 설명 | 스키마 |
---|---|---|
activityTimestamp | 사용 가능한 마지막 활동 타임스탬프를 검색합니다. | metav1.time |
apiUrl | Discoveredclusters API URL 끝점. | string |
cloudProvider | 검색된 클러스터의 클라우드 공급자입니다. | string |
콘솔 | Discoveredclusters 콘솔 URL 끝점. | string |
creationTimestamp | Discoveredclusters 생성 타임스탬프. | metav1.time |
인증 정보 | 클러스터가 검색된 인증 정보에 대한 참조입니다. | corev1.ObjectReference |
displayName | 검색된 클러스터의 표시 이름입니다. | string |
isManagedCluster | true인 경우 클러스터는 ACM에 의해 관리됩니다. | boolean |
이름 | 검색된 클러스터의 이름입니다. | string |
openshiftVersion | 검색된 클러스터의 OpenShift 버전입니다. | string |
상태 | 검색된 클러스터의 상태입니다. | string |
유형 | OpenShift 플레이버(ex. OCP, ROSA 등). | string |
1.19. AddOnDeploymentConfig API (v1alpha1)
1.19.1. 개요
이 문서는 Red Hat Advanced Cluster Management for Kubernetes용 AddOnDeploymentConfig 리소스에 대한 것입니다. AddOnDeploymentConfig 리소스에는 생성, 쿼리, 삭제 및 업데이트의 네 가지 요청이 있습니다. AddOnDeploymentConfig는 애드온에 대한 배포 구성을 나타냅니다.
1.19.1.1. 버전 정보
버전 : 2.12.0
1.19.1.2. URI 스키마
BasePath : /kubernetes/apis
Schemes : HTTPS
1.19.1.3. 태그
- Addon.open-cluster-management.io : AddOnDeploymentConfigs 생성 및 관리
1.19.2. 경로
1.19.2.1. 모든 AddOnDeploymentConfigs 쿼리
GET /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/addondeploymentconfigs
1.19.2.1.1. 설명
자세한 내용은 AddOnDeploymentConfigs를 쿼리합니다.
1.19.2.1.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
1.19.2.1.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.19.2.1.4. 사용
-
addondeploymentconfig/yaml
1.19.2.1.5. 태그
- addon.open-cluster-management.io
1.19.2.2. AddOnDeploymentConfig 생성
POST /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/addondeploymentconfigs
1.19.2.2.1. 설명
AddOnDeploymentConfig를 생성합니다.
1.19.2.2.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
본문 |
본문 | 생성할 AddOnDeploymentConfig 바인딩을 설명하는 매개변수입니다. |
1.19.2.2.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.19.2.2.4. 사용
-
addondeploymentconfig/yaml
1.19.2.2.5. 태그
- addon.open-cluster-management.io
1.19.2.2.6. HTTP 요청의 예
1.19.2.2.6.1. 요청 본문
{ "apiVersion": "addon.open-cluster-management.io/v1alpha1", "kind": "AddOnDeploymentConfig", "metadata": { "name": "deploy-config", "namespace": "open-cluster-management-hub" }, "spec": { "nodePlacement": { "nodeSelector": { "node-dedicated": "acm-addon" }, "tolerations": [ { "effect": "NoSchedule", "key": "node-dedicated", "operator": "Equal", "value": "acm-addon" } ] } } }
1.19.2.3. 단일 AddOnDeploymentConfig 쿼리
GET /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/addondeploymentconfigs/{addondeploymentconfig_name}
1.19.2.3.1. 설명
자세한 내용은 단일 AddOnDeploymentConfig를 쿼리합니다.
1.19.2.3.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
addondeploymentconfig_name | 쿼리할 AddOnDeploymentConfig의 이름입니다. | string |
1.19.2.3.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.19.2.3.4. 태그
- addon.open-cluster-management.io
1.19.2.4. AddOnDeploymentConfig 삭제
DELETE /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/addondeploymentconfigs/{addondeploymentconfig_name}
1.19.2.4.1. 설명
단일 AddOnDeploymentConfig를 삭제합니다.
1.19.2.4.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
addondeploymentconfig_name | 삭제할 AddOnDeploymentConfig의 이름입니다. | string |
1.19.2.4.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.19.2.4.4. 태그
- addon.open-cluster-management.io
1.19.3. 정의
1.19.3.1. AddOnDeploymentConfig
이름 | 설명 | 스키마 |
---|---|---|
apiVersion | AddOnDeploymentConfig의 버전이 지정된 스키마입니다. | string |
종류 | REST 리소스를 나타내는 문자열 값입니다. | string |
메타데이터 | AddOnDeploymentConfig의 메타데이터입니다. | object |
사양 | AddOnDeploymentConfig의 사양입니다. |
spec
이름 | 설명 | 스키마 |
---|---|---|
customizedVariables | 현재 애드온 배포의 이름-값 변수 목록입니다. 애드온 구현에서는 이러한 변수를 사용하여 애드온 배포를 렌더링할 수 있습니다. | |
nodePlacement | 관리 클러스터에서 애드온 에이전트의 스케줄링을 명시적으로 제어할 수 있습니다. |
customizedVariable
이름 | 설명 | 스키마 |
---|---|---|
이름 | 이 변수의 이름입니다. | string |
값 | 이 변수의 값입니다. | string |
nodePlacement
이름 | 설명 | 스키마 |
---|---|---|
nodeSelector |
Pod가 실행되도록 예약되는 노드를 정의합니다. | map[string]string |
허용 오차 |
Pod에 적용되고 일치하는 Operator(<operator>)를 사용하여 < | []corev1.Toleration |
1.20. ClusterManagementAddOn API (v1alpha1)
1.20.1. 개요
이 문서는 Red Hat Advanced Cluster Management for Kubernetes용 ClusterManagementAddOn 리소스에 대한 것입니다. ClusterManagementAddOn 리소스에는 생성, 쿼리, 삭제 및 업데이트의 네 가지 요청이 있습니다.
ClusterManagementAddOn은 클러스터 관리자에게 애드온 등록을 나타냅니다. 이 리소스를 사용하면 클러스터 관리자가 사용할 수 있는 애드온을 검색하고 애드온에 대한 메타데이터 정보도 제공할 수 있습니다. 이 리소스는 네임스페이스 범위 ManagedClusterAddOn 리소스에 사용되는 ClusterManagementAddOn 리소스의 이름인 ManagedClusterAddOn에 대한 참조도 제공합니다. ClusterManagementAddOn은 클러스터 범위 리소스입니다.
1.20.1.1. 버전 정보
버전 : 2.12.0
1.20.1.2. URI 스키마
BasePath : /kubernetes/apis
Schemes : HTTPS
1.20.1.3. 태그
- Addon.open-cluster-management.io : ClusterManagementAddOns 생성 및 관리
1.20.2. 경로
1.20.2.1. 모든 ClusterManagementAddOns 쿼리
GET /addon.open-cluster-management.io/v1alpha1/clustermanagementaddons
1.20.2.1.1. 설명
자세한 내용은 ClusterManagementAddOns를 쿼리합니다.
1.20.2.1.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
1.20.2.1.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.20.2.1.4. 사용
-
clustermanagementaddon/yaml
1.20.2.1.5. 태그
- addon.open-cluster-management.io
1.20.2.2. ClusterManagementAddOn 생성
POST /addon.open-cluster-management.io/v1alpha1/clustermanagementaddons
1.20.2.2.1. 설명
Create a ClusterManagementAddOn.
1.20.2.2.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
본문 |
본문 | 생성할 ClusterManagementAddon 바인딩을 설명하는 매개변수입니다. |
1.20.2.2.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.20.2.2.4. 사용
-
clustermanagementaddon/yaml
1.20.2.2.5. 태그
- addon.open-cluster-management.io
1.20.2.2.6. HTTP 요청의 예
1.20.2.2.6.1. 요청 본문
{ "apiVersion": "addon.open-cluster-management.io/v1alpha1", "kind": "ClusterManagementAddOn", "metadata": { "name": "helloworld" }, "spec": { "supportedConfigs": [ { "defaultConfig": { "name": "deploy-config", "namespace": "open-cluster-management-hub" }, "group": "addon.open-cluster-management.io", "resource": "addondeploymentconfigs" } ] }, "status" : { } }
1.20.2.3. 단일 ClusterManagementAddOn 쿼리
GET /addon.open-cluster-management.io/v1alpha1/clustermanagementaddons/{clustermanagementaddon_name}
1.20.2.3.1. 설명
자세한 내용은 단일 ClusterManagementAddOn을 쿼리합니다.
1.20.2.3.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
clustermanagementaddon_name | 쿼리할 ClusterManagementAddOn의 이름입니다. | string |
1.20.2.3.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.20.2.3.4. 태그
- addon.open-cluster-management.io
1.20.2.4. Delete a ClusterManagementAddOn
DELETE /addon.open-cluster-management.io/v1alpha1/clustermanagementaddons/{clustermanagementaddon_name}
1.20.2.4.1. 설명
Delete a single ClusterManagementAddOn.
1.20.2.4.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
clustermanagementaddon_name | 삭제할 ClusterManagementAddOn의 이름입니다. | string |
1.20.2.4.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.20.2.4.4. 태그
- addon.open-cluster-management.io
1.20.3. 정의
1.20.3.1. ClusterManagementAddOn
이름 | 설명 | 스키마 |
---|---|---|
apiVersion | ClusterManagementAddOn의 버전이 지정된 스키마입니다. | string |
종류 | REST 리소스를 나타내는 문자열 값입니다. | string |
메타데이터 | ClusterManagementAddOn의 메타데이터입니다. | object |
사양 | ClusterManagementAddOn의 사양입니다. |
spec
이름 | 설명 | 스키마 |
---|---|---|
addOnMeta | AddOnMeta는 애드온의 메타데이터 정보에 대한 참조입니다. | |
supportedConfigs | SupportedConfigs는 애드온에서 지원하는 구성 유형 목록입니다. | configMeta array |
addOnMeta
이름 | 설명 | 스키마 |
---|---|---|
displayName | 표시되는 애드온의 이름을 나타냅니다. | string |
설명 | 애드온에 대한 자세한 설명을 나타냅니다. | string |
configMeta
이름 | 설명 | 스키마 |
---|---|---|
그룹 | 애드온 구성 그룹입니다. | string |
리소스 | 애드온 구성의 리소스입니다. | string |
defaultConfig | 기본 애드온 구성의 네임스페이스와 이름을 나타냅니다. 여기에서 모든 애드온에 동일한 구성이 있습니다. |
configReferent
이름 | 설명 | 스키마 |
---|---|---|
네임스페이스 | 애드온 구성의 네임스페이스입니다. 이 필드가 설정되지 않은 경우 구성은 클러스터 범위입니다. | string |
이름 | 애드온 구성의 이름입니다. | string |
1.21. ManagedClusterAddOn API (v1alpha1)
1.21.1. 개요
이 문서는 Red Hat Advanced Cluster Management for Kubernetes용 ManagedClusterAddOn 리소스에 대한 것입니다. ManagedClusterAddOn 리소스에는 생성, 쿼리, 삭제 및 업데이트의 네 가지 요청이 있습니다. ManagedClusterAddOn은 애드온의 현재 상태를 보유한 사용자 정의 리소스 오브젝트입니다. 이 리소스는 ManagedCluster 네임스페이스에서 생성해야 합니다.
1.21.1.1. 버전 정보
버전 : 2.12.0
1.21.1.2. URI 스키마
BasePath : /kubernetes/apis
Schemes : HTTPS
1.21.1.3. 태그
- Addon.open-cluster-management.io : ManagedClusterAddOns 생성 및 관리
1.21.2. 경로
1.21.2.1. 모든 ManagedClusterAddOns 쿼리
GET /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/managedclusteraddons
1.21.2.1.1. 설명
자세한 내용은 ManagedClusterAddOns를 쿼리합니다.
1.21.2.1.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
1.21.2.1.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.21.2.1.4. 사용
-
managedclusteraddon/yaml
1.21.2.1.5. 태그
- addon.open-cluster-management.io
1.21.2.2. ManagedClusterAddOn 생성
POST /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/managedclusteraddons
1.21.2.2.1. 설명
ManagedClusterAddOn을 생성합니다.
1.21.2.2.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
본문 |
본문 | 생성할 ManagedClusterAddOn 바인딩을 설명하는 매개변수입니다. |
1.21.2.2.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.21.2.2.4. 사용
-
managedclusteraddon/yaml
1.21.2.2.5. 태그
- addon.open-cluster-management.io
1.21.2.2.6. HTTP 요청의 예
1.21.2.2.6.1. 요청 본문
{ "apiVersion": "addon.open-cluster-management.io/v1alpha1", "kind": "ManagedClusterAddOn", "metadata": { "name": "helloworld", "namespace": "cluster1" }, "spec": { "configs": [ { "group": "addon.open-cluster-management.io", "name": "cluster-deploy-config", "namespace": "open-cluster-management-hub", "resource": "addondeploymentconfigs" } ], "installNamespace": "default" }, "status" : { } }
1.21.2.3. 단일 ManagedClusterAddOn 쿼리
GET /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/managedclusteraddons/{managedclusteraddon_name}
1.21.2.3.1. 설명
자세한 내용은 단일 ManagedClusterAddOn을 쿼리합니다.
1.21.2.3.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
managedclusteraddon_name | 쿼리할 ManagedClusterAddOn의 이름입니다. | string |
1.21.2.3.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.21.2.3.4. 태그
- addon.open-cluster-management.io
1.21.2.4. Delete a ManagedClusterAddOn
DELETE /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/managedclusteraddons/{managedclusteraddon_name}
1.21.2.4.1. 설명
단일 ManagedClusterAddOn을 삭제합니다.
1.21.2.4.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
managedclusteraddon_name | 삭제할 ManagedClusterAddOn의 이름입니다. | string |
1.21.2.4.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.21.2.4.4. 태그
- addon.open-cluster-management.io
1.21.3. 정의
1.21.3.1. ManagedClusterAddOn
이름 | 설명 | 스키마 |
---|---|---|
apiVersion | ManagedClusterAddOn의 버전이 지정된 스키마입니다. | string |
종류 | REST 리소스를 나타내는 문자열 값입니다. | string |
메타데이터 | ManagedClusterAddOn의 메타데이터입니다. | object |
사양 | ManagedClusterAddOn의 사양입니다. |
spec
이름 | 설명 | 스키마 |
---|---|---|
installNamespace | 애드온 에이전트를 설치할 관리형 클러스터의 네임스페이스입니다. 설정되지 않은 경우 add-on 에이전트를 설치하는 데 open-cluster-management-agent-addon 네임스페이스가 사용됩니다. | string |
구성 | 현재 애드온에 자체 구성이 있는 애드온 구성 목록입니다. | addOnConfig array |
addOnConfig
이름 | 설명 | 스키마 |
---|---|---|
그룹 | 애드온 구성 그룹입니다. | string |
리소스 | 애드온 구성의 리소스입니다. | string |
네임스페이스 | 애드온 구성의 네임스페이스입니다. 이 필드가 설정되지 않은 경우 구성은 클러스터 범위입니다. | string |
이름 | 애드온 구성의 이름입니다. | string |
1.22. ManagedClusterSet API (v1beta2)
1.22.1. 개요
이 문서는 Red Hat Advanced Cluster Management for Kubernetes용 ManagedClusterSet 리소스에 대한 것입니다. ManagedClusterSet 리소스에는 생성, 쿼리, 삭제 및 업데이트의 네 가지 요청이 있습니다. ManagedClusterSet은 두 개 이상의 관리 클러스터를 함께 작동할 수 있는 세트로 그룹화합니다. 세트에 속하는 관리형 클러스터는 공유 사용 목적 또는 동일한 배포 리전과 같은 유사한 속성을 가질 수 있습니다.
1.22.1.1. 버전 정보
버전 : 2.12.0
1.22.1.2. URI 스키마
BasePath : /kubernetes/apis
Schemes : HTTPS
1.22.1.3. 태그
- cluster.open-cluster-management.io : ManagedClusterSets 생성 및 관리
1.22.2. 경로
1.22.2.1. 모든 managedclustersets 쿼리
GET /cluster.open-cluster-management.io/v1beta2/namespaces/{namespace}/managedclustersets
1.22.2.1.1. 설명
자세한 내용은 managedclustersets를 쿼리합니다.
1.22.2.1.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
네임스페이스 | 사용할 네임스페이스(예: default)입니다. | string |
1.22.2.1.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.22.2.1.4. 사용
-
managedclusterset/yaml
1.22.2.1.5. 태그
- cluster.open-cluster-management.io
1.22.2.2. 관리 클러스터 세트 생성
POST /cluster.open-cluster-management.io/v1beta2/namespaces/{namespace}/managedclustersets
1.22.2.2.1. 설명
관리 클러스터 세트를 생성합니다.
1.22.2.2.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
네임스페이스 |
사용할 네임스페이스(예: | string |
본문 |
본문 | 생성할 managedclusterset을 설명하는 매개변수입니다. |
1.22.2.2.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.22.2.2.4. 사용
-
managedclusterset/yaml
1.22.2.2.5. 태그
- cluster.open-cluster-management.io
1.22.2.2.6. HTTP 요청의 예
1.22.2.2.6.1. 요청 본문
{ "apiVersion" : "cluster.open-cluster-management.io/v1beta2", "kind" : "ManagedClusterSet", "metadata" : { "name" : "example-clusterset", }, "spec": { }, "status" : { } }
1.22.2.3. 단일 관리 클러스터 세트 쿼리
GET /cluster.open-cluster-management.io/v1beta2/namespaces/{namespace}/managedclustersets/{managedclusterset_name}
1.22.2.3.1. 설명
자세한 내용은 단일 관리 클러스터 세트를 쿼리합니다.
1.22.2.3.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
네임스페이스 |
사용할 네임스페이스(예: | string |
경로 |
managedclusterset_name | 쿼리할 관리 클러스터 세트의 이름입니다. | string |
1.22.2.3.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.22.2.3.4. 태그
- cluster.open-cluster-management.io
1.22.2.4. 관리 클러스터 세트 삭제
DELETE /cluster.open-cluster-management.io/v1beta2/managedclustersets/{managedclusterset_name}
1.22.2.4.1. 설명
단일 관리 클러스터 세트를 삭제합니다.
1.22.2.4.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
네임스페이스 |
사용할 네임스페이스(예: | string |
경로 |
managedclusterset_name | 삭제할 관리 클러스터 세트의 이름입니다. | string |
1.22.2.4.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.22.2.4.4. 태그
- cluster.open-cluster-management.io
1.22.3. 정의
1.22.3.1. ManagedClusterSet
이름 | 설명 | 스키마 |
---|---|---|
apiVersion |
| string |
종류 | REST 리소스를 나타내는 문자열 값입니다. | string |
메타데이터 |
| object |
specrequired |
| spec |
1.23. KlusterletConfig API (v1alpha1)
1.23.1. 개요
이 문서는 Red Hat Advanced Cluster Management for Kubernetes용 KlusterletConfig 리소스에 대한 것입니다. KlusterletConfig 리소스에는 생성, 쿼리, 삭제 및 업데이트의 네 가지 요청이 있습니다. KlusterletConfig에는 nodeSelector
,tolerations
및 pullSecret
과 같은 klusterlet에 대한 구성 정보가 포함되어 있습니다. KlusterletConfig는 클러스터 범위 리소스이며 open-cluster-managemnet-agent
네임스페이스의 klusterlet Pod에서만 작동합니다. KlusterletConfig는 애드온 배포 구성에 영향을 미치지 않습니다.
1.23.1.1. 버전 정보
버전 : 2.12.0
1.23.1.2. URI 스키마
BasePath : /kubernetes/apis
Schemes : HTTPS
1.23.1.3. 태그
- config.open-cluster-management.io : KlusterletConfig 생성 및 관리
1.23.2. 경로
1.23.2.1. 모든 KlusterletConfig 쿼리
GET /config.open-cluster-management.io/v1alpha1/namespaces/{namespace}/klusterletconfigs
1.23.2.1.1. 설명
자세한 내용은 KlusterletConfigs를 쿼리합니다.
1.23.2.1.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
1.23.2.1.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.23.2.1.4. 사용
-
klusterletconfig/yaml
1.23.2.1.5. 태그
- config.open-cluster-management.io
1.23.2.2. KlusterletConfig 생성
POST /config.open-cluster-management.io/v1alpha1/namespaces/{namespace}/klusterletconfigs
1.23.2.2.1. 설명
KlusterletConfig를 생성합니다.
1.23.2.2.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
본문 |
본문 | 생성할 KlusterletConfig 바인딩을 설명하는 매개변수입니다. |
1.23.2.2.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.23.2.2.4. 사용
-
klusterletconfig/yaml
1.23.2.2.5. 태그
- config.open-cluster-management.io
1.23.2.2.6. HTTP 요청의 예
1.23.2.2.6.1. 요청 본문
{ "apiVersion": "apiextensions.k8s.io/v1", "kind": "CustomResourceDefinition", "metadata": { "annotations": { "controller-gen.kubebuilder.io/version": "v0.7.0" }, "creationTimestamp": null, "name": "klusterletconfigs.config.open-cluster-management.io" }, "spec": { "group": "config.open-cluster-management.io", "names": { "kind": "KlusterletConfig", "listKind": "KlusterletConfigList", "plural": "klusterletconfigs", "singular": "klusterletconfig" }, "preserveUnknownFields": false, "scope": "Cluster", "versions": [ { "name": "v1alpha1", "schema": { "openAPIV3Schema": { "description": "KlusterletConfig contains the configuration of a klusterlet including the upgrade strategy, config overrides, proxy configurations etc.", "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": "Spec defines the desired state of KlusterletConfig", "properties": { "hubKubeAPIServerProxyConfig": { "description": "HubKubeAPIServerProxyConfig holds proxy settings for connections between klusterlet/add-on agents on the managed cluster and the kube-apiserver on the hub cluster. Empty means no proxy settings is available.", "properties": { "caBundle": { "description": "CABundle is a CA certificate bundle to verify the proxy server. It will be ignored if only HTTPProxy is set; And it is required when HTTPSProxy is set and self signed CA certificate is used by the proxy server.", "format": "byte", "type": "string" }, "httpProxy": { "description": "HTTPProxy is the URL of the proxy for HTTP requests", "type": "string" }, "httpsProxy": { "description": "HTTPSProxy is the URL of the proxy for HTTPS requests HTTPSProxy will be chosen if both HTTPProxy and HTTPSProxy are set.", "type": "string" } }, "type": "object" }, "nodePlacement": { "description": "NodePlacement enables explicit control over the scheduling of the agent components. If the placement is nil, the placement is not specified, it will be omitted. If the placement is an empty object, the placement will match all nodes and tolerate nothing.", "properties": { "nodeSelector": { "additionalProperties": { "type": "string" }, "description": "NodeSelector defines which Nodes the Pods are scheduled on. The default is an empty list.", "type": "object" }, "tolerations": { "description": "Tolerations is attached by pods to tolerate any taint that matches the triple <key,value,effect> using the matching operator <operator>. The default is an empty list.", "items": { "description": "The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.", "properties": { "effect": { "description": "Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.", "type": "string" }, "key": { "description": "Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.", "type": "string" }, "operator": { "description": "Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.", "type": "string" }, "tolerationSeconds": { "description": "TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.", "format": "int64", "type": "integer" }, "value": { "description": "Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "pullSecret": { "description": "PullSecret is the name of image pull secret.", "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" }, "registries": { "description": "Registries includes the mirror and source registries. The source registry will be replaced by the Mirror.", "items": { "properties": { "mirror": { "description": "Mirror is the mirrored registry of the Source. Will be ignored if Mirror is empty.", "type": "string" }, "source": { "description": "Source is the source registry. All image registries will be replaced by Mirror if Source is empty.", "type": "string" } }, "required": [ "mirror" ], "type": "object" }, "type": "array" } }, "type": "object" }, "status": { "description": "Status defines the observed state of KlusterletConfig", "type": "object" } }, "type": "object" } }, "served": true, "storage": true, "subresources": { "status": {} } } ] }, "status": { "acceptedNames": { "kind": "", "plural": "" }, "conditions": [], "storedVersions": [] } }
1.23.2.3. 단일 KlusterletConfig 쿼리
GET /config.open-cluster-management.io/v1alpha1/namespaces/{namespace}/klusterletconfigs/{klusterletconfig_name}
1.23.2.3.1. 설명
자세한 내용은 단일 KlusterletConfig를 쿼리합니다.
1.23.2.3.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
klusterletconfig_name | 쿼리할 KlusterletConfig의 이름입니다. | string |
1.23.2.3.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.23.2.3.4. 태그
- config.open-cluster-management.io
1.23.2.4. KlusterletConfig 삭제
DELETE /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/klusterletconfigs/{klusterletconfig_name}
1.23.2.4.1. 설명
단일 klusterletconfig를 삭제합니다.
1.23.2.4.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
klusterletconfig_name | 삭제할 KlusterletConfig의 이름입니다. | string |
1.23.2.4.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.23.2.4.4. 태그
- config.open-cluster-management.io
1.23.3. 정의
1.23.3.1. KlusterletConfig
이름 | 설명 | 스키마 |
---|---|---|
apiVersion | KlusterletConfig의 버전이 지정된 스키마입니다. | string |
종류 | REST 리소스를 나타내는 문자열 값입니다. | string |
메타데이터 | KlusterletConfig의 메타데이터입니다. | object |
사양 | KlusterletConfig의 사양입니다. |
spec
이름 | 설명 | 스키마 |
---|---|---|
레지스트리 | 미러 및 소스 레지스트리를 포함합니다. 소스 레지스트리는 미러로 교체됩니다. | 레지스트리 |
pullSecret | 이미지 풀 시크릿의 이름입니다. | object |
nodePlacement | 관리 클러스터에서 애드온 에이전트의 스케줄링 제어를 활성화합니다. | |
hubKubeAPIServerProxyConfig | 관리 클러스터에서 klusterlet 또는 애드온 에이전트 간 연결에 대한 프록시 설정을 포함하고 hub 클러스터의 kube-apiserver가 있습니다. 비어있는 것은 프록시 설정을 사용할 수 없음을 의미합니다. |
nodePlacement
이름 | 설명 | 스키마 |
---|---|---|
nodeSelector |
Pod가 실행되도록 예약되는 노드를 정의합니다. | map[string]string |
허용 오차 |
Pod에 적용되고 일치하는 Operator(<operator>)를 사용하여 < | []corev1.Toleration |
kubeAPIServerProxyConfig
이름 | 설명 | 스키마 |
---|---|---|
cabundle | 프록시 서버를 확인하는 CA 인증서 번들입니다. HTTPProxy만 설정된 경우 번들은 무시됩니다. HTTPSProxy가 설정되고 자체 서명된 CA 인증서를 프록시 서버에서 사용하는 경우 번들이 필요합니다. | map[string]string |
httpProxy | HTTP 요청에 대한 프록시의 URL | map[string]string |
httpsProxy | HTTPS 요청에 대한 프록시의 URL입니다. HTTPProxy 및 HTTPSProxy가 모두 설정된 경우 httpsProxy가 선택됩니다. | map[string]string |
1.24. 정책 규정 준수 내역 (기술 프리뷰) (더 이상 사용되지 않음)
1.24.1. 개요
정책 준수 기록 API는 쿼리 가능한 형식으로 Red Hat Advanced Cluster Management for Kubernetes 정책 준수 이벤트의 장기 스토리지를 원하는 경우 선택적 기술 프리뷰 기능입니다. API를 사용하여 spec
필드와 같은 추가 세부 정보를 가져와서 정책을 감사하고 문제를 해결하고 클러스터에서 정책을 비활성화하거나 제거할 때 규정 준수 이벤트를 가져올 수 있습니다. 정책 준수 기록 API는 또한 감사 및 문제 해결에 도움이 되도록 CSV(콤마로 구분된 값) 정책 준수 이벤트의 요약을 생성할 수도 있습니다.
1.24.1.1. 버전 정보
버전 : 2.12.0
1.24.2. API 끝점
1.24.2.1. 정책 규정 준수 이벤트 나열
/api/v1/compliance-events
이렇게 하면 기본적으로 액세스할 수 있는 모든 정책 준수 이벤트가 나열됩니다. 응답 형식은 다음과 같으며 기본적으로 내림차순으로 event.timestamp
에 따라 정렬됩니다.
{ "data": [ { "id": 2, "cluster": { "name": "cluster1", "cluster_id": "215ce184-8dee-4cab-b99b-1f8f29dff611" }, "parent_policy": { "id": 3, "name": "configure-custom-app", "namespace": "policies", "catageories": ["CM Configuration Management"], "controls": ["CM-2 Baseline Configuration"], "standards": ["NIST SP 800-53"] }, "policy": { "apiGroup": "policy.open-cluster-management.io", "id": 2, "kind": "ConfigurationPolicy", "name": "configure-custom-app", "namespace": "", // Only shown with `?include_spec` "spec": {} }, "event": { "compliance": "NonCompliant", "message": "configmaps [app-data] not found in namespace default", "timestamp": "2023-07-19T18:25:43.511Z", "metadata": {} } }, { "id": 1, "cluster": { "name": "cluster2", "cluster_id": "415ce234-8dee-4cab-b99b-1f8f29dff461" }, "parent_policy": { "id": 3, "name": "configure-custom-app", "namespace": "policies", "catageories": ["CM Configuration Management"], "controls": ["CM-2 Baseline Configuration"], "standards": ["NIST SP 800-53"] }, "policy": { "apiGroup": "policy.open-cluster-management.io", "id": 4, "kind": "ConfigurationPolicy", "name": "configure-custom-app", "namespace": "", // Only shown with `?include_spec` "spec": {} }, "event": { "compliance": "Compliant", "message": "configmaps [app-data] found as specified in namespace default", "timestamp": "2023-07-19T18:25:41.523Z", "metadata": {} } } ], "metadata": { "page": 1, "pages": 7, "per_page": 20, "total": 123 } }
다음과 같은 선택적 쿼리 매개변수가 허용됩니다. 설명이 없는 사용자는 참조하는 필드에만 필터링합니다. 매개변수 값 null
은 값을 나타내지 않습니다. 또한 쉼표로 여러 값을 지정할 수 있습니다. 예를 들어 ?cluster.name=cluster1,cluster2
는 "또는" 필터링입니다. 필요한 경우 쉼표를 \
로 이스케이프할 수 있습니다.
쿼리 인수 | 설명 |
---|---|
cluster.cluster_id | |
cluster.name | |
방향 |
정렬할 방향입니다. 기본값은 |
event.compliance | |
event.message_includes | 입력 문자열이 포함된 규정 준수 메시지에 대한 필터입니다. 단일 값만 지원됩니다. |
event.message_like |
SQL |
event.reported_by | |
event.timestamp | |
event.timestamp_after |
이 시간 이후의 규정 준수 이벤트만 나타내는 RFC 3339 타임스탬프가 표시됩니다. 예를 들면 |
event.timestamp_before |
이 시간 이전에 규정 준수 이벤트만 나타내는 RFC 3339 타임스탬프입니다. 예를 들면 |
id | |
include_spec |
정책의 |
page |
쿼리의 페이지 번호입니다. 기본값은 |
parent_policy.categories | |
parent_policy.controls | |
parent_policy.id | |
parent_policy.name | |
parent_policy.namespace | |
parent_policy.standards | |
per_page |
페이지당 반환된 규정 준수 이벤트 수입니다. 기본값은 |
policy.apiGroup | |
policy.id | |
policy.kind | |
policy.name | |
policy.namespace | |
policy.severity | |
sort |
정렬할 필드입니다. 기본값은 |
1.24.2.2. 단일 정책 준수 이벤트 선택
/api/v1/compliance-events/<id>
데이터베이스 ID를 지정하여 단일 정책 규정 준수 이벤트를 선택할 수 있습니다. 예를 들어 /api/v1/compliance-events/1
은 ID가 1인 규정 준수 이벤트를 선택합니다. 반환 값의 형식은 다음 JSON입니다.
{ "id": 1, "cluster": { "name": "cluster2", "cluster_id": "415ce234-8dee-4cab-b99b-1f8f29dff461" }, "parent_policy": { "id": 2, "name": "etcd-encryption", "namespace": "policies", "catageories": ["CM Configuration Management"], "controls": ["CM-2 Baseline Configuration"], "standards": ["NIST SP 800-53"] }, "policy": { "apiGroup": "policy.open-cluster-management.io", "id": 4, "kind": "ConfigurationPolicy", "name": "etcd-encryption", "namespace": "", "spec": {} }, "event": { "compliance": "Compliant", "message": "configmaps [app-data] found as specified in namespace default", "timestamp": "2023-07-19T18:25:41.523Z", "metadata": {} } }
1.24.2.3. 기술 자료 생성
/api/v1/reports/compliance-events
감사 및 문제 해결을 위해 쉼표로 구분된 값(CSV)의 규정 준수 이벤트 기록을 생성할 수 있습니다. 동일한 쿼리 인수를 출력하고 /api/v1/compliance-events
API 끝점과 동일한 쿼리 인수를 허용합니다. 기본적으로 per_page
제한은 설정되어 있지 않으며 per_page
쿼리 인수에는 최대값이 없습니다. 모든 CSV 헤더는 /api/v1/compliance-events
API 끝점과 JSON 오브젝트를 분리하는 밑줄과 동일합니다. 예를 들어 이벤트 타임스탬프에는 event_timestamp
의 헤더가 있습니다.
1.24.3. 인증 및 권한 부여
정책 규정 준수 기록 API는 인증 및 권한 부여를 위해 Red Hat Advanced Cluster Management Hub 클러스터에서 사용하는 OpenShift 인스턴스를 사용합니다. HTTPS 요청의 인증
헤더에 OpenShift 토큰을 제공해야 합니다.
토큰을 찾으려면 다음 명령을 실행합니다.
oc whoami --show-token
1.24.3.1. 규정 준수 이벤트 보기
관리형 클러스터에 대한 규정 준수 이벤트를 보려면 Red Hat Advanced Cluster Management Hub 클러스터에서 ManagedCluster
오브젝트에 대한 get
동사
를 완료하려면 액세스할 수 있어야 합니다. 예를 들어 local-cluster
클러스터의 규정 준수 이벤트를 보려면 open-cluster-management:view:local-cluster
ClusterRole
을 사용하거나 다음 예와 같이 자체 리소스를 생성할 수 있습니다.
apiVersion: rbac.authorization.k8s.io/v1 kind: ClusterRole metadata: name: local-cluster-view rules: - apiGroups: - cluster.open-cluster-management.io resources: - managedclusters resourceNames: - local-cluster verbs: - get
특정 관리 클러스터에 대한 액세스를 확인하려면 oc auth can-i
명령을 사용합니다. 예를 들어 local-cluster
관리 클러스터에 액세스할 수 있는지 확인하려면 다음 명령을 실행합니다.
oc auth can-i get managedclusters.cluster.open-cluster-management.io/local-cluster
1.24.3.2. 컴플라이언스 이벤트 기록
해당 관리 클러스터 네임스페이스의 policies.policy.open-cluster-management.io/status
리소스에서 패치
동사
액세스 권한이 있는 사용자 또는 서비스 계정은 정책 준수 이벤트를 기록할 수 있습니다. 관리형 클러스터의 governance-policy-framework
Pod는 Red Hat Advanced Cluster Management Hub 클러스터의 해당 관리형 클러스터 네임스페이스의 open-cluster-management-compliance-history-api-recorder
서비스 계정을 사용하여 규정 준수 이벤트를 기록합니다. 각 서비스 계정에는 open-cluster-management:compliance-history-api-recorder
ClusterRole
이 관리 클러스터 네임스페이스에 바인딩되어 있습니다. 정책 준수 기록 API에 저장된 데이터의 신뢰성을 보장하기 위해 정책 상태에
대한 사용자 및 서비스 계정 패치
동사 액세스를 제한합니다.