1.9. Helm API

1.9.1. 概要

このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes の HelmRelease リソースについて説明します。HelmRelease リソースには、create、query、delete、update の 4 つの要求を使用できます。

1.9.1.1. バージョン情報

バージョン: 2.9.0

1.9.1.2. URI スキーム

ベースパス: /kubernetes/apis
スキーム: HTTPS

1.9.1.3. タグ

helmreleases.apps.open-cluster-management.io: helmreleases を作成して管理します。

1.9.2. パス

1.9.2.1. helmrelease の作成

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

1.9.2.1.1. 説明

helmrelease を作成します。

1.9.2.1.2. パラメーター

型	名前	説明	スキーマ
Header	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	string
パス	namespace 必須	使用する namespace (例: default)	string
Body	body 必須	作成する 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. 要求の body

{
  "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. 説明

helmrelease に対してクエリーを実行して詳細を確認します。

1.9.2.2.2. パラメーター

型	名前	説明	スキーマ
Header	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	string
パス	namespace 必須	使用する namespace (例: 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. 説明

1 つの helmrelease に対してクエリーを実行して詳細を確認します。

1.9.2.3.2. パラメーター

型	名前	説明	スキーマ
Header	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	string
パス	helmrelease_name 必須	問い合わせる helmrelease の名前	string
パス	namespace 必須	使用する namespace (例: default)	string

1.9.2.3.3. レスポンス

HTTP コード	説明	スキーマ
200	成功	コンテンツなし
403	アクセス禁止	コンテンツなし
404	リソースが見つからない	コンテンツなし
500	内部サービスエラー	コンテンツなし
503	サービスが利用できない	コンテンツなし

1.9.2.3.4. タグ

helmreleases.apps.open-cluster-management.io

1.9.2.4. helmrelease の削除

DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases/{helmrelease_name}

1.9.2.4.1. パラメーター

型	名前	説明	スキーマ
Header	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	string
パス	helmrelease_name 必須	削除する helmrelease の名前	string
パス	namespace 必須	使用する namespace (例: 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

Name	スキーマ
apiVersion 必須	string
kind 必須	string
metadata 必須	object
repo 必須	repo
spec 必須	object
status 必須	status

repo

Name	スキーマ
chartName 任意	string
configMapRef 任意	configMapRef
secretRef 任意	secretRef
source 任意	比較元
version 任意	string

configMapRef

Name	スキーマ
apiVersion 任意	string
fieldPath 任意	string
kind 任意	string
name 任意	string
namespace 任意	string
resourceVersion 任意	string
uid 任意	string

secretRef

Name	スキーマ
apiVersion 任意	string
fieldPath 任意	string
kind 任意	string
name 任意	string
namespace 任意	string
resourceVersion 任意	string
uid 任意	string

source

Name	スキーマ
github 任意	github
helmRepo 任意	helmRepo
type 任意	string

github

Name	スキーマ
branch 任意	string
chartPath 任意	string
urls 任意	string array

helmRepo

Name	スキーマ
urls 任意	string array

status

Name	スキーマ
conditions 必須	conditions array
deployedRelease 任意	deployedRelease

conditions

Name	スキーマ
lastTransitionTime 任意	string (date-time)
message 任意	string
reason 任意	string
status 必須	string
type 必須	string

deployedRelease

Name	スキーマ
manifest 任意	string
name 任意	string