1.3. Clustersets API (v1beta2)

1.3.1. 概要

このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes の ClusterSet リソースを説明します。ClusterSet リソースには、create、query、delete、update の 4 つのリクエストを使用できます。ManagedClusterSet は、ManagedClusters のグループを定義します。ManagedClusterSet を参照する ManagedCluster に cluster.open-cluster-management.io/clusterset という名前のラベルを追加することで、ManagedCluster を特定の ManagedClusterSet に割り当てることができます。managedclustersets/join の仮想サブリソースに対する create 権限を許可する RBAC ルールがある場合にのみ、ManagedCluster でこのラベルを追加または削除できます。このラベルを更新するには、ソースとターゲットの両方の ManagedClusterSets でこの権限が必要です。

1.3.1.1. バージョン情報

バージョン: 2.12.0

1.3.1.2. URI スキーム

BasePath: /kubernetes/apis
Schemes: HTTPS

1.3.1.3. タグ

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

1.3.2. パス

1.3.2.1. 全 clusterset のクエリー

GET /cluster.open-cluster-management.io/v1beta2/managedclustersets

1.3.2.1.1. 詳細

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

1.3.2.1.2. パラメーター

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

1.3.2.1.3. レスポンス

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

1.3.2.1.4. 消費されるアイテム

clusterset/yaml

1.3.2.1.5. タグ

cluster.open-cluster-management.io

1.3.2.2. clusterset の作成

POST /cluster.open-cluster-management.io/v1beta2/managedclustersets

1.3.2.2.1. 詳細

Clusterset を作成します。

1.3.2.2.2. パラメーター

型	名前	詳細	スキーマ
Header	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	string
Body	body 必須	作成する clusterset を記述するパラメーター	Clusterset

1.3.2.2.3. レスポンス

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

1.3.2.2.4. 消費されるアイテム

clusterset/yaml

1.3.2.2.5. タグ

cluster.open-cluster-management.io

1.3.2.2.6. HTTP リクエストの例

1.3.2.2.6.1. 要求の body

{
  "apiVersion": "cluster.open-cluster-management.io/v1beta2",
  "kind": "ManagedClusterSet",
  "metadata": {
    "name": "clusterset1"
  },
  "spec": {
    "clusterSelector": {
      "selectorType": "ExclusiveClusterSetLabel"
    }
  },
  "status": {}
}

1.3.2.3. 単一 clusterset のクエリー

GET /cluster.open-cluster-management.io/v1beta2/managedclustersets/{clusterset_name}

1.3.2.3.1. 詳細

単一の clusterset に対してクエリーを実行して詳細を確認します。

1.3.2.3.2. パラメーター

型	名前	詳細	スキーマ
Header	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	string
Path	clusterset_name 必須	問い合わせる clusterset の名前。	string

1.3.2.3.3. レスポンス

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

1.3.2.3.4. タグ

cluster.open-cluster-management.io

1.3.2.4. clusterset の削除

DELETE /cluster.open-cluster-management.io/v1beta2/managedclustersets/{clusterset_name}

1.3.2.4.1. 詳細

単一 clusterset を削除します。

1.3.2.4.2. パラメーター

型	名前	詳細	スキーマ
Header	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	string
Path	clusterset_name 必須	削除する clusterset の名前。	string

1.3.2.4.3. レスポンス

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

1.3.2.4.4. タグ

cluster.open-cluster-management.io

1.3.3. 定義

1.3.3.1. Clusterset

名前	スキーマ
apiVersion 必須	string
kind 必須	string
metadata 必須	object