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를 설명하는 매개변수입니다.	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
리포지토리 필요	repo
사양 필요	object
상태 필요	status

repo

이름	스키마
chartName optional	string
configMapRef optional	configMapRef
secretRef optional	secretRef
소스 선택 사항	소스
버전 선택 사항	string

configMapRef

이름	스키마
apiVersion 선택 사항	string
fieldPath optional	string
종류 선택 사항	string
이름 선택 사항	string
네임스페이스 선택 사항	string
resourceVersion 선택 사항	string
UID 선택 사항	string

secretRef

이름	스키마
apiVersion 선택 사항	string
fieldPath optional	string
종류 선택 사항	string
이름 선택 사항	string
네임스페이스 선택 사항	string
resourceVersion 선택 사항	string
UID 선택 사항	string

소스

이름	스키마
GitHub 선택 사항	github
helmRepo 선택 사항	helmRepo
유형 선택 사항	string

github

이름	스키마
분기 선택 사항	string
chartPath optional	string
URL 선택 사항	문자열 배열

helmRepo

이름	스키마
URL 선택 사항	문자열 배열

status

이름	스키마
필수 조건	conditions 배열
deployedRelease optional	deployedRelease

conditions

이름	스키마
lastTransitionTime optional	문자열 (date-time)
메시지 선택 사항	string
이유 선택 사항	string
상태 필요	string
유형 필수	string

deployedRelease

이름	스키마
매니페스트 선택 사항	string
이름 선택 사항	string