1.9. Helm API
1.9.1. 개요
이 문서는 Red Hat Advanced Cluster Management for Kubernetes의 HelmRelease 리소스에 대한 것입니다. HelmRelease 리소스에는 생성, 쿼리, 삭제 및 업데이트의 네 가지 요청이 있습니다.
1.9.1.1. 버전 정보
버전 : 2.10.0
1.9.1.2. URI 스키마
BasePath : /kubernetes/apis
Schemes : HTTPS
1.9.1.3. 태그
- helmreleases.apps.open-cluster-management.io : helmreleases 생성 및 관리
1.9.2. 경로
1.9.2.1. helmrelease 생성
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases
1.9.2.1.1. 설명
helmrelease를 생성합니다.
1.9.2.1.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
네임스페이스 | 사용할 네임스페이스(예: default)입니다. | string |
본문 |
본문 | 생성할 helmrelease를 설명하는 매개변수입니다. |
1.9.2.1.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.9.2.1.4. 사용
-
application/yaml
1.9.2.1.5. 태그
- helmreleases.apps.open-cluster-management.io
1.9.2.1.6. HTTP 요청의 예
1.9.2.1.6.1. 요청 본문
{ "apiVersion" : "apps.open-cluster-management.io/v1", "kind" : "HelmRelease", "metadata" : { "name" : "nginx-ingress", "namespace" : "default" }, "repo" : { "chartName" : "nginx-ingress", "source" : { "helmRepo" : { "urls" : [ "https://kubernetes-charts.storage.googleapis.com/nginx-ingress-1.26.0.tgz" ] }, "type" : "helmrepo" }, "version" : "1.26.0" }, "spec" : { "defaultBackend" : { "replicaCount" : 3 } } }
1.9.2.2. 모든 helmrelease 쿼리
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases
1.9.2.2.1. 설명
자세한 내용은 helmreleases를 쿼리합니다.
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. 태그
- helmreleases.apps.open-cluster-management.io
1.9.2.3. 단일 helmrelease 쿼리
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases/{helmrelease_name}
1.9.2.3.1. 설명
자세한 내용은 단일 helmrelease를 쿼리합니다.
1.9.2.3.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
helmrelease_name | 쿼리하려는 helmrelease의 이름입니다. | string |
경로 |
네임스페이스 | 사용할 네임스페이스(예: default)입니다. | string |
1.9.2.3.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.9.2.3.4. 태그
- helmreleases.apps.open-cluster-management.io
1.9.2.4. helmrelease 삭제
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases/{helmrelease_name}
1.9.2.4.1. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
helmrelease_name | 삭제할 helmrelease의 이름입니다. | string |
경로 |
네임스페이스 | 사용할 네임스페이스(예: default)입니다. | string |
1.9.2.4.2. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.9.2.4.3. 태그
- helmreleases.apps.open-cluster-management.io
1.9.3. 정의
1.9.3.1. HelmRelease
이름 | 스키마 |
---|---|
apiVersion | string |
종류 | string |
메타데이터 | object |
리포지토리 | |
사양 | object |
상태 |
repo
이름 | 스키마 |
---|---|
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 배열 |
deployedRelease |
conditions
이름 | 스키마 |
---|---|
lastTransitionTime | 문자열 (date-time) |
메시지 | string |
이유 | string |
상태 | string |
유형 | string |
deployedRelease
이름 | 스키마 |
---|---|
매니페스트 | string |
이름 | string |