1.19. ClusterManagementAddOn API (v1alpha1)

1.19.1. 概要

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

Clustermanagementaddon は、クラスターマネージャーへのアドオンの登録を表します。このリソースを使用すると、ユーザーはクラスターマネージャーで使用できるアドオンを見つけ、アドオンに関するメタデータ情報を取得できます。このリソースは、namespace のスコープが指定された ManagedClusterAddOn リソースに使用される ClusterManagementAddOn リソースの名前である ManagedClusterAddOn への参照も指定します。Clustermanagementaddon はクラスターのスコープが指定されたリソースです。

1.19.1.1. バージョン情報

Version: 2.8.0

1.19.1.2. URI スキーム

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

1.19.1.3. タグ

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

1.19.2. パス

1.19.2.1. Query all ClusterManagementAddOns

GET /addon.open-cluster-management.io/v1alpha1/clustermanagementaddons

1.19.2.1.1. 説明

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

1.19.2.1.2. パラメーター

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

1.19.2.1.3. レスポンス

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

1.19.2.1.4. 消費されるアイテム

clustermanagementaddon/yaml

1.19.2.1.5. タグ

addon.open-cluster-management.io

1.19.2.2. Create a ClusterManagementAddOn

POST /addon.open-cluster-management.io/v1alpha1/clustermanagementaddons

1.19.2.2.1. 説明

ClusterManagementAddOn を作成します。

1.19.2.2.2. パラメーター

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

1.19.2.2.3. レスポンス

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

1.19.2.2.4. 消費されるアイテム

clustermanagementaddon/yaml

1.19.2.2.5. タグ

addon.open-cluster-management.io

1.19.2.2.6. HTTP リクエストの例

1.19.2.2.6.1. 要求の body

{
  "apiVersion": "addon.open-cluster-management.io/v1alpha1",
  "kind": "ClusterManagementAddOn",
  "metadata": {
    "name": "helloworld"
  },
  "spec": {
    "supportedConfigs": [
      {
        "defaultConfig": {
          "name": "deploy-config",
          "namespace": "open-cluster-management-hub"
        },
        "group": "addon.open-cluster-management.io",
        "resource": "addondeploymentconfigs"
      }
    ]
  },
  "status" : { }
}

1.19.2.3. Query a single ClusterManagementAddOn

GET /addon.open-cluster-management.io/v1alpha1/clustermanagementaddons/{clustermanagementaddon_name}

1.19.2.3.1. 説明

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

1.19.2.3.2. パラメーター

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

1.19.2.3.3. レスポンス

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

1.19.2.3.4. タグ

addon.open-cluster-management.io

1.19.2.4. ClusterManagementAddOn の削除

DELETE /addon.open-cluster-management.io/v1alpha1/clustermanagementaddons/{clustermanagementaddon_name}

1.19.2.4.1. 説明

1 つの ClusterManagementAddOn を削除します。

1.19.2.4.2. パラメーター

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

1.19.2.4.3. レスポンス

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

1.19.2.4.4. タグ

addon.open-cluster-management.io

1.19.3. 定義

1.19.3.1. ClusterManagementAddOn

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

spec

名前	説明	スキーマ
addOnMeta 任意	AddOnMeta は、アドオンのメタデータ情報への参照です。	addOnMeta
supportedConfigs 任意	supportedConfigs は、アドオンでサポートされる設定タイプのリストです。	configMeta array

addOnMeta

Name	説明	スキーマ
displayName 任意	表示されるアドオンの名前を表します。	string
description 任意	アドオンの詳細な説明を表します。	string

configMeta

Name	説明	スキーマ
group 任意	アドオン設定のグループ。	string
resource 必須	アドオン設定のリソース。	string
defaultConfig 必須	デフォルトのアドオン設定の namespace と名前を表します。すべてのアドオンで同じ設定になります。	configReferent

configReferent

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