1.20. ManagedClusterAddOn API (v1alpha1)

1.20.1. 概要

このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes の ManagedClusterAddOn リソースについて説明します。ManagedClusterAddOn リソースには、create、query、delete、update の 4 つの要求を使用できます。ManagedClusterAddOn は、アドオンの現在の状態を保持するカスタムリソースオブジェクトです。このリソースは ManagedCluster namespace で作成する必要があります。

1.20.1.1. バージョン情報

バージョン: 2.9.0

1.20.1.2. URI スキーム

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

1.20.1.3. タグ

addon.open-cluster-management.io: ManagedClusterAddOns の作成と管理

1.20.2. パス

1.20.2.1. Query all ManagedClusterAddOns

GET /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/managedclusteraddons

1.20.2.1.1. 説明

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

1.20.2.1.2. パラメーター

型	名前	説明	スキーマ
Header	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	string

1.20.2.1.3. レスポンス

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

1.20.2.1.4. 消費されるアイテム

ManagedClusterAddOn/yaml

1.20.2.1.5. タグ

addon.open-cluster-management.io

1.20.2.2. Create a ManagedClusterAddOn

POST /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/managedclusteraddons

1.20.2.2.1. 説明

ManagedClusterAddOn を作成します。

1.20.2.2.2. パラメーター

型	名前	説明	スキーマ
Header	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	string
Body	body 必須	作成される ManagedClusterAddOn バインディングを記述するパラメーター。	ManagedClusterAddOn

1.20.2.2.3. レスポンス

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

1.20.2.2.4. 消費されるアイテム

ManagedClusterAddOn/yaml

1.20.2.2.5. タグ

addon.open-cluster-management.io

1.20.2.2.6. HTTP リクエストの例

1.20.2.2.6.1. 要求の body

{
  "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.20.2.3. Query a single ManagedClusterAddOn

GET /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/managedclusteraddons/{managedclusteraddon_name}

1.20.2.3.1. 説明

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

1.20.2.3.2. パラメーター

型	名前	説明	スキーマ
Header	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	string
パス	managedclusteraddon_name 必須	クエリーを実行する ManagedClusterAddOn の名前。	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 ManagedClusterAddOn

DELETE /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/managedclusteraddons/{managedclusteraddon_name}

1.20.2.4.1. 説明

1 つの ManagedClusterAddOn を削除します。

1.20.2.4.2. パラメーター

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

Name	説明	スキーマ
apiVersion 必須	ManagedClusterAddOn のバージョン管理されたスキーマ。	string
kind 必須	REST リソースを表す文字列の値	string
metadata 必須	ManagedClusterAddOn のメタデータ。	object
spec 必須	ManagedClusterAddOn の仕様。	spec

spec

名前	説明	スキーマ
installNamespace 任意	アドオンエージェントをインストールするためのマネージドクラスター上の namespace。設定されていない場合は、open-cluster-management-agent-addon namespace を使用してアドオンエージェントをインストールします。	string
configs 任意	現在のアドオンに独自の設定があるアドオン設定のリスト。	addOnConfig array

addOnConfig

Name	説明	スキーマ
group 任意	アドオン設定のグループ。	string
resource 必須	アドオン設定のリソース。	string
namespace 任意	アドオン設定の namespace。このフィールドが設定されていない場合、設定は cluster-scope になります。	string
name 必須	アドオン設定の名前。	string