1.5. 채널 API

PDF

1.5.1. 개요

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

1.5.1.1. 버전 정보

버전 : 2.10.0

1.5.1.2. URI 스키마

BasePath : /kubernetes/apis
Schemes : HTTPS

1.5.1.3. 태그

channels.apps.open-cluster-management.io : deployables 생성 및 관리

1.5.2. 경로

1.5.2.1. 채널 생성

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

1.5.2.1.1. 설명

채널을 생성합니다.

1.5.2.1.2. 매개 변수

유형	이름	설명	스키마
헤더	COOKIE 필요	권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다.	string
경로	네임스페이스 필요	사용할 네임스페이스(예: default)입니다.	string
본문	본문 필요	생성할 배포를 설명하는 매개변수입니다.	채널

1.5.2.1.3. 응답

HTTP 코드	설명	스키마
200	성공	콘텐츠 없음
403	액세스 금지	콘텐츠 없음
404	리소스를 찾을 수 없음	콘텐츠 없음
500	내부 서비스 오류	콘텐츠 없음
503	서비스를 사용할 수 없음	콘텐츠 없음

1.5.2.1.4. 사용

application/yaml

1.5.2.1.5. 태그

channels.apps.open-cluster-management.io

1.5.2.1.6. HTTP 요청의 예

1.5.2.1.6.1. 요청 본문

{
  "apiVersion": "apps.open-cluster-management.io/v1",
  "kind": "Channel",
  "metadata": {
    "name": "sample-channel",
    "namespace": "default"
  },
  "spec": {
    "configMapRef": {
      "kind": "configmap",
      "name": "info-resource-filter-configmap"
    },
    "pathname": "https://charts.helm.sh/stable",
    "type": "HelmRepo"
  }
}

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

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

1.5.2.2.1. 설명

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

1.5.2.2.2. 매개 변수

유형	이름	설명	스키마
헤더	COOKIE 필요	권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다.	string
경로	네임스페이스 필요	사용할 네임스페이스(예: default)입니다.	string

1.5.2.2.3. 응답

HTTP 코드	설명	스키마
200	성공	콘텐츠 없음
403	액세스 금지	콘텐츠 없음
404	리소스를 찾을 수 없음	콘텐츠 없음
500	내부 서비스 오류	콘텐츠 없음
503	서비스를 사용할 수 없음	콘텐츠 없음

1.5.2.2.4. 사용

application/yaml

1.5.2.2.5. 태그

channels.apps.open-cluster-management.io

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

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

1.5.2.3.1. 설명

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

1.5.2.3.2. 매개 변수

유형	이름	설명	스키마
헤더	COOKIE 필요	권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다.	string
경로	channel_name 필요	쿼리할 배포 가능의 이름입니다.	string
경로	네임스페이스 필요	사용할 네임스페이스(예: default)입니다.	string

1.5.2.3.3. 응답

HTTP 코드	설명	스키마
200	성공	콘텐츠 없음
403	액세스 금지	콘텐츠 없음
404	리소스를 찾을 수 없음	콘텐츠 없음
500	내부 서비스 오류	콘텐츠 없음
503	서비스를 사용할 수 없음	콘텐츠 없음

1.5.2.3.4. 태그

channels.apps.open-cluster-management.io

1.5.2.4. 채널 삭제

DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels/{channel_name}

1.5.2.4.1. 매개 변수

유형	이름	설명	스키마
헤더	COOKIE 필요	권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다.	string
경로	channel_name 필요	삭제할 채널의 이름입니다.	string
경로	네임스페이스 필요	사용할 네임스페이스(예: default)입니다.	string

1.5.2.4.2. 응답

HTTP 코드	설명	스키마
200	성공	콘텐츠 없음
403	액세스 금지	콘텐츠 없음
404	리소스를 찾을 수 없음	콘텐츠 없음
500	내부 서비스 오류	콘텐츠 없음
503	서비스를 사용할 수 없음	콘텐츠 없음

1.5.2.4.3. 태그

channels.apps.open-cluster-management.io

1.5.3. 정의

1.5.3.1. 채널

이름	스키마
apiVersion 필요	string
종류 필요	string
메타데이터 필요	object
사양 필요	spec

spec

이름	설명	스키마
configMapRef optional	ObjectReference에는 참조된 오브젝트를 검사하거나 수정할 수 있는 충분한 정보가 포함되어 있습니다.	configMapRef
선택 사항	ChannelGate는 채널 승격 기준을 정의합니다.	Gates
경로 이름 필요		string
secretRef optional	ObjectReference에는 참조된 오브젝트를 검사하거나 수정할 수 있는 충분한 정보가 포함되어 있습니다.	secretRef
sourceNamespaces optional		enum (Namespace, HelmRepo, ObjectBucket, Git, namespace, helmrepo, objectbucket, github) 배열

configMapRef

이름	설명	스키마
apiVersion 선택 사항	참조의 API 버전입니다.	string
fieldPath optional	전체 오브젝트 대신 오브젝트 조각을 참조하는 경우 이 문자열에는 desiredState.manifest.containers[2]와 같은 유효한 JSON/Go 필드 액세스 문이 포함되어야 합니다. 예를 들어 오브젝트 참조가 Pod 내의 컨테이너에 대한 경우 "spec.containers{name}"과 같은 값을 사용합니다(여기서 "name"은 이벤트를 트리거한 컨테이너 이름을 참조하거나 컨테이너 이름이 "spec.containers[2]"이 Pod에서 인덱스 2가 있는 컨테이너를 참조하는 경우). 이 구문은 오브젝트의 일부를 참조하는 잘 정의된 방법을 사용하는 경우에만 선택됩니다. TODO: 이 설계는 최종적이지 않으며 이 필드는 향후 변경될 수 있습니다.	string
종류 선택 사항	일종의 추천입니다. 자세한 내용은 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의 일반적인 주석	annotations
labelSelector 선택 사항	레이블 선택기는 리소스 집합에 대한 레이블 쿼리입니다. matchLabels 및 matchExpressions의 결과는 ANDed입니다. 빈 라벨 선택기는 모든 오브젝트와 일치합니다. null 라벨 선택기는 오브젝트와 일치하지 않습니다.	labelSelector
이름 선택 사항		string

annotations

이름	스키마
키 선택 사항	string
값 선택 사항	string

labelSelector

이름	설명	스키마
matchExpressions optional	matchExpressions는 라벨 선택기 요구 사항 목록입니다. 요구 사항은 AND로 설정됩니다.	matchExpressions 배열
matchLabels optional	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 optional	전체 오브젝트 대신 오브젝트 조각을 참조하는 경우 이 문자열에는 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