1.18. AddOnDeploymentConfig API (v1alpha1)

1.18.1. 概要

このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes の AddOnDeploymentConfig リソースについて説明します。AddOnDeploymentConfig リソースでは、create、query、delete、update の 4 つの要求を使用できます。AddOnDeploymentConfig は、アドオンのデプロイメント設定を表します。

1.18.1.1. バージョン情報

Version: 2.8.0

1.18.1.2. URI スキーム

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

1.18.1.3. タグ

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

1.18.2. パス

1.18.2.1. Query all AddOnDeploymentConfigs

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

1.18.2.1.1. 説明

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

1.18.2.1.2. パラメーター

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

1.18.2.1.3. レスポンス

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

1.18.2.1.4. 消費されるアイテム

addondeploymentconfig/yaml

1.18.2.1.5. タグ

addon.open-cluster-management.io

1.18.2.2. Create a AddOnDeploymentConfig

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

1.18.2.2.1. 説明

AddOnDeploymentConfig を作成します。

1.18.2.2.2. パラメーター

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

1.18.2.2.3. レスポンス

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

1.18.2.2.4. 消費されるアイテム

addondeploymentconfig/yaml

1.18.2.2.5. タグ

addon.open-cluster-management.io

1.18.2.2.6. HTTP リクエストの例

1.18.2.2.6.1. 要求の body

{
  "apiVersion": "addon.open-cluster-management.io/v1alpha1",
  "kind": "AddOnDeploymentConfig",
  "metadata": {
    "name": "deploy-config",
    "namespace": "open-cluster-management-hub"
  },
  "spec": {
    "nodePlacement": {
      "nodeSelector": {
        "node-dedicated": "acm-addon"
      },
      "tolerations": [
        {
          "effect": "NoSchedule",
          "key": "node-dedicated",
          "operator": "Equal",
          "value": "acm-addon"
        }
      ]
    }
  }
}

1.18.2.3. Query a single AddOnDeploymentConfig

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

1.18.2.3.1. 説明

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

1.18.2.3.2. パラメーター

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

1.18.2.3.3. レスポンス

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

1.18.2.3.4. タグ

addon.open-cluster-management.io

1.18.2.4. AddOnDeploymentConfig を削除する

DELETE /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/addondeploymentconfigs/{addondeploymentconfig_name}

1.18.2.4.1. 説明

1 つの AddOnDeploymentConfig を削除します。

1.18.2.4.2. パラメーター

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

1.18.2.4.3. レスポンス

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

1.18.2.4.4. タグ

addon.open-cluster-management.io

1.18.3. 定義

1.18.3.1. AddOnDeploymentConfig

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

spec

名前	説明	スキーマ
customizedVariables 任意	現在のアドオンデプロイメントの name-value 変数のリスト。アドオン実装では、これらの変数を使用してアドオンのデプロイメントをレンダリングできます。	customizedVariable array
nodePlacement 必須	マネージドクラスターのアドオンエージェントに対するスケジューリングの明示的な制御を有効にします。	nodePlacement

customizedVariable

Name	説明	スキーマ
name 必須	この変数の名前。	string
value 任意	この変数の値。	string

nodePlacement

Name	説明	スキーマ
nodeSelector 任意	Pod の実行がスケジュールされるノードを定義します。`nodeSelector` が空の場合、`nodeSelector` はすべてのノードを選択します。	map[string]string
tolerations 任意	Pod に適用され、一致するマシン Operator (`<operator>`) を使用して `<key,value,effect>` 容認に一致するテイントに Pod をスケジュールするために使用されます。	[]corev1.Toleration