API

1.1. Clusters API

1.1.1. 概要

このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes のクラスターリソースについて説明します。クラスターリソースには、create、query、delete、update の 4 つの要求を使用できます。ManagedCluster はマネージドクラスターの望ましい状態と現在の状態を表します。ManagedCluster はクラスタースコープのリソースです。

1.1.1.1. バージョン情報

バージョン: 2.10.0

1.1.1.2. URI スキーム

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

1.1.1.3. タグ

cluster.open-cluster-management.io: クラスターを作成して管理します。

1.1.2. パス

1.1.2.1. 全クラスターのクエリー

GET /cluster.open-cluster-management.io/v1/managedclusters

1.1.2.1.1. 説明

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

1.1.2.1.2. パラメーター

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

1.1.2.1.3. レスポンス

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

1.1.2.1.4. 消費されるアイテム

cluster/yaml

1.1.2.1.5. タグ

cluster.open-cluster-management.io

1.1.2.2. クラスターの作成

POST /cluster.open-cluster-management.io/v1/managedclusters

1.1.2.2.1. 説明

クラスターの作成

1.1.2.2.2. パラメーター

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

1.1.2.2.3. レスポンス

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

1.1.2.2.4. 消費されるアイテム

cluster/yaml

1.1.2.2.5. タグ

cluster.open-cluster-management.io

1.1.2.2.6. HTTP リクエストの例

1.1.2.2.6.1. 要求の body

{
  "apiVersion" : "cluster.open-cluster-management.io/v1",
  "kind" : "ManagedCluster",
  "metadata" : {
    "labels" : {
      "vendor" : "OpenShift"
    },
    "name" : "cluster1"
  },
  "spec": {
    "hubAcceptsClient": true,
    "managedClusterClientConfigs": [
      {
        "caBundle": "test",
        "url": "https://test.com"
      }
    ]
  },
  "status" : { }
}

1.1.2.3. 単一クラスターのクエリー

GET /cluster.open-cluster-management.io/v1/managedclusters/{cluster_name}

1.1.2.3.1. 説明

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

1.1.2.3.2. パラメーター

型	名前	説明	スキーマ
Header	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	string
パス	cluster_name 必須	問い合わせるクラスターの名前。	string

1.1.2.3.3. レスポンス

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

1.1.2.3.4. タグ

cluster.open-cluster-management.io

1.1.2.4. クラスターの削除

DELETE /cluster.open-cluster-management.io/v1/managedclusters/{cluster_name}

DELETE /hive.openshift.io/v1/{cluster_name}/clusterdeployments/{cluster_name}

1.1.2.4.1. 説明

単一クラスターを削除します。

1.1.2.4.2. パラメーター

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

1.1.2.4.3. レスポンス

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

1.1.2.4.4. タグ

cluster.open-cluster-management.io

1.1.3. 定義

1.1.3.1. クラスター

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

spec

名前	説明	スキーマ
hubAcceptsClient 必須	ハブがマネージドクラスター上の klusterlet エージェントとの接続を確立できるかどうかを指定します。デフォルト値は `false` で、ハブクラスターに RBAC ルールが設定されている場合にのみ `true` に変更できます。これにより、`managedclusters/accept` の仮想サブリソースを更新できます。	bool
managedClusterClientConfigs 任意	マネージドクラスターの apiserver アドレスを一覧表示します。	managedClusterClientConfigs array
leaseDurationSeconds 任意	マネージドクラスター上の klusterlet エージェントのリース更新時間間隔を指定します。デフォルトでは、klusterlet エージェントはそのリースを 60 秒ごとに更新します。	integer (int32)
taints 任意	スケジューリング中にマネージドクラスターが 1 つ以上のマネージドクラスターセットに割り当てられないようにします。	Taint array

managedClusterClientConfigs

名前	説明	スキーマ
URL 必須		string
CABundle 任意	Pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$"	string (バイト)

名前

説明

スキーマ

URL
必須

string

CABundle
任意

Pattern:

"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"

string (バイト)

Taint

名前	説明	スキーマ
key 必須	クラスターに適用される Taint キー。	string
value 任意	テイントキーに対応する Taint 値。	string
effect 任意	Taint を許容しない配置に対する Taint の影響。有効な値は `NoSelect`、`PreferNoSelect`、および `NoSelectIfNew` です。	string

1.2. Clustersets API (v1beta2)

1.2.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.2.1.1. バージョン情報

バージョン: 2.10.0

1.2.1.2. URI スキーム

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

1.2.1.3. タグ

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

1.2.2. パス

1.2.2.1. 全 clusterset のクエリー

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

1.2.2.1.1. 説明

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

1.2.2.1.2. パラメーター

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

1.2.2.1.3. レスポンス

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

1.2.2.1.4. 消費されるアイテム

clusterset/yaml

1.2.2.1.5. タグ

cluster.open-cluster-management.io

1.2.2.2. clusterset の作成

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

1.2.2.2.1. 説明

Clusterset を作成します。

1.2.2.2.2. パラメーター

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

1.2.2.2.3. レスポンス

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

1.2.2.2.4. 消費されるアイテム

clusterset/yaml

1.2.2.2.5. タグ

cluster.open-cluster-management.io

1.2.2.2.6. HTTP リクエストの例

1.2.2.2.6.1. 要求の body

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

1.2.2.3. 単一 clusterset のクエリー

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

1.2.2.3.1. 説明

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

1.2.2.3.2. パラメーター

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

1.2.2.3.3. レスポンス

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

1.2.2.3.4. タグ

cluster.open-cluster-management.io

1.2.2.4. clusterset の削除

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

1.2.2.4.1. 説明

単一 clusterset を削除します。

1.2.2.4.2. パラメーター

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

1.2.2.4.3. レスポンス

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

1.2.2.4.4. タグ

cluster.open-cluster-management.io

1.2.3. 定義

1.2.3.1. Clusterset

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

1.3. Clustersetbindings API (v1beta2)

1.3.1. 概要

このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes の ClusterSetBinding リソースについて説明します。ClusterSetBinding リソースには、create、query、delete、update の 4 つのリクエストを使用できます。ManagedClusterSetBinding は、ManagedClusterSet を特定の namespace に投影します。managedclustersets/bind の仮想サブリソースでの create を許可する RBAC ルールがある場合は、namespace で ManagedClusterSetBinding を作成し、ManagedClusterSet にバインドできます。

1.3.1.1. バージョン情報

バージョン: 2.10.0

1.3.1.2. URI スキーム

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

1.3.1.3. タグ

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

1.3.2. パス

1.3.2.1. 全 clustersetbinding のクエリー

GET /cluster.open-cluster-management.io/v1beta2/namespaces/{namespace}/managedclustersetbindings

1.3.2.1.1. 説明

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

1.3.2.1.2. パラメーター

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

1.3.2.1.3. レスポンス

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

1.3.2.1.4. 消費されるアイテム

clustersetbinding/yaml

1.3.2.1.5. タグ

cluster.open-cluster-management.io

1.3.2.2. clustersetbinding の作成

POST /cluster.open-cluster-management.io/v1beta2/namespaces/{namespace}/managedclustersetbindings

1.3.2.2.1. 説明

clustersetbinding を作成します。

1.3.2.2.2. パラメーター

型	名前	説明	スキーマ
Header	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	string
パス	namespace 必須	使用する namespace (例: `default`)	string
Body	body 必須	作成する clustersetbinding を記述するパラメーター	Clustersetbinding

1.3.2.2.3. レスポンス

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

1.3.2.2.4. 消費されるアイテム

clustersetbinding/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" : "ManagedClusterSetBinding",
  "metadata" : {
    "name" : "clusterset1",
    "namespace" : "ns1"
  },
 "spec": {
    "clusterSet": "clusterset1"
  },
  "status" : { }
}

1.3.2.3. 単一 clustersetbinding のクエリー

GET /cluster.open-cluster-management.io/v1beta2/namespaces/{namespace}/managedclustersetbindings/{clustersetbinding_name}

1.3.2.3.1. 説明

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

1.3.2.3.2. パラメーター

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

DELETE /cluster.open-cluster-management.io/v1beta2/managedclustersetbindings/{clustersetbinding_name}

1.3.2.4.1. 説明

単一 clustersetbinding を削除します。

1.3.2.4.2. パラメーター

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

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

spec

名前	説明	スキーマ
clusterSet 必須	バインドする `ManagedClusterSet` の名前。`ManagedClusterSetBinding` のインスタンス名と一致する必要があり、作成後に変更することはできません。	string

1.4. Clusterview API (v1alpha1)

1.4.1. 概要

このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes の clusterview リソースについて説明します。clusterview リソースには、アクセス可能なマネージドクラスターおよびマネージドクラスターセットのリストを表示できる CLI コマンドが含まれます。使用できる要求は、list、get、および watch の 3 つです。

1.4.1.1. バージョン情報

バージョン: 2.10.0

1.4.1.2. URI スキーム

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

1.4.1.3. タグ

clusterview.open-cluster-management.io: お使いの ID がアクセスできるマネージドクラスターのリストを表示します。

1.4.2. パス

1.4.2.1. マネージドクラスターの取得

GET /managedclusters.clusterview.open-cluster-management.io

1.4.2.1.1. 説明

アクセス可能なマネージドクラスターのリストを表示します。

1.4.2.1.2. パラメーター

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

1.4.2.1.3. レスポンス

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

1.4.2.1.4. 消費されるアイテム

managedcluster/yaml

1.4.2.1.5. タグ

clusterview.open-cluster-management.io

1.4.2.2. マネージドクラスターのリスト表示

LIST /managedclusters.clusterview.open-cluster-management.io

1.4.2.2.1. 説明

アクセス可能なマネージドクラスターのリストを表示します。

1.4.2.2.2. パラメーター

型	名前	説明	スキーマ
Header	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	string
Body	body 任意	マネージドクラスターをリスト表示するユーザー ID の名前	string

1.4.2.2.3. レスポンス

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

1.4.2.2.4. 消費されるアイテム

managedcluster/yaml

1.4.2.2.5. タグ

clusterview.open-cluster-management.io

1.4.2.2.6. HTTP リクエストの例

1.4.2.2.6.1. 要求の body

{
  "apiVersion" : "clusterview.open-cluster-management.io/v1alpha1",
  "kind" : "ClusterView",
  "metadata" : {
    "name" : "<user_ID>"
  },
  "spec": { },
  "status" : { }
}

1.4.2.3. マネージドクラスターセットの監視

WATCH /managedclusters.clusterview.open-cluster-management.io

1.4.2.3.1. 説明

アクセス可能なマネージドクラスターを確認します。

1.4.2.3.2. パラメーター

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

1.4.2.3.3. レスポンス

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

1.4.2.4. マネージドクラスターセットのリスト表示

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

1.4.2.4.1. 説明

アクセス可能なマネージドクラスターをリスト表示します。

1.4.2.4.2. パラメーター

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

1.4.2.4.3. レスポンス

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

1.4.2.5. マネージドクラスターセットのリスト表示

LIST /managedclustersets.clusterview.open-cluster-management.io

1.4.2.5.1. 説明

アクセス可能なマネージドクラスターをリスト表示します。

1.4.2.5.2. パラメーター

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

1.4.2.5.3. レスポンス

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

1.4.2.6. マネージドクラスターセットの監視

WATCH /managedclustersets.clusterview.open-cluster-management.io

1.4.2.6.1. 説明

アクセス可能なマネージドクラスターを確認します。

1.4.2.6.2. パラメーター

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

1.4.2.6.3. レスポンス

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

1.5. Channels API

1.5.1. 概要

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

1.5.1.1. バージョン情報

バージョン: 2.10.0

1.5.1.2. URI スキーム

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

1.5.1.3. タグ

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

1.5.2. パス

1.5.2.1. チャネルの作成

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

1.5.2.1.1. 説明

チャネルを作成します。

1.5.2.1.2. パラメーター

型	名前	説明	スキーマ
Header	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	string
パス	namespace 必須	使用する namespace (例: default)	string
Body	body 必須	作成する deployable を記述するパラメーター	Channel

1.5.2.1.3. レスポンス

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

1.5.2.1.4. 消費されるアイテム

application/yaml

1.5.2.1.5. タグ

channels.apps.open-cluster-management.io

1.5.2.1.6. HTTP リクエストの例

1.5.2.1.6.1. 要求の body

{
  "apiVersion": "apps.open-cluster-management.io/v1",
  "kind": "Channel",
  "metadata": {
    "name": "sample-channel",
    "namespace": "default"
  },
  "spec": {
    "configMapRef": {
      "kind": "configmap",
      "name": "info-resource-filter-configmap"
    },
    "pathname": "https://charts.helm.sh/stable",
    "type": "HelmRepo"
  }
}

1.5.2.2. ターゲット namespace の全チャネルのクエリー

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels

1.5.2.2.1. 説明

チャネルに対してクエリーを実行して詳細を確認します。

1.5.2.2.2. パラメーター

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

1.5.2.2.3. レスポンス

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

1.5.2.2.4. 消費されるアイテム

application/yaml

1.5.2.2.5. タグ

channels.apps.open-cluster-management.io

1.5.2.3. namespace の単一チャネルのクエリー

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels/{channel_name}

1.5.2.3.1. 説明

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

1.5.2.3.2. パラメーター

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

1.5.2.3.3. レスポンス

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

1.5.2.3.4. タグ

channels.apps.open-cluster-management.io

1.5.2.4. Channel の削除

DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels/{channel_name}

1.5.2.4.1. パラメーター

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

1.5.2.4.2. レスポンス

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

1.5.2.4.3. タグ

channels.apps.open-cluster-management.io

1.5.3. 定義

1.5.3.1. チャネル

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

spec

名前	説明	スキーマ
configMapRef 任意	ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。	configMapRef
gates 任意	ChannelGate はチャネルにプロモートする基準を定義します。	gates
pathname 必須		string
secretRef 任意	ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。	secretRef
sourceNamespaces 任意		enum (Namespace、HelmRepo、ObjectBucket、Git、namespace、helmrepo、objectbucket、github) array

configMapRef

名前	説明	スキーマ
apiVersion 任意	参照先の API バージョン。	string
fieldPath 任意	オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、"spec.containers{name}" などの値に設定されます ("name" はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、"spec.containers[2]" の値に設定されます (この Pod 内でインデックスが 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部の参照を明確に定義するためです。TODO: この設計は最終版ではないため、このフィールドは今後変更になる場合があります。	string
kind 任意	参照先の種類。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/	name 任意
参照先の名前。詳細: Names	string	namespace 任意
参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/	string	resourceVersion 任意
この参照が作成される特定の resourceVersion (ある場合)。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency	string	uid 任意

gates

名前	説明	スキーマ
annotations 任意	k8s の典型的なアノテーション	annotations
labelSelector 任意	ラベルセレクターとは、一連のリソースに対するラベルクエリー機能です。matchLabels と matchExpressions の結果は AND を使用して結合されます。ラベルセレクターが空の場合は、全オブジェクトをマッチします。ラベルセレクターが null の場合は、どのオブジェクトもマッチしません。	labelSelector
name 任意		string

annotations

名前	スキーマ
key 任意	string
value 任意	string

labelSelector

名前	説明	スキーマ
matchExpressions 任意	matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。	matchExpressions array
matchLabels 任意	matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。	string、string map

matchExpressions

名前	説明	スキーマ
key 必須	key は、セレクターの適用先のラベルキーです。	string
operator 必須	operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。	string
values 任意	values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。	string array

secretRef

名前	説明	スキーマ
apiVersion 任意	参照先の API バージョン。	string
fieldPath 任意	オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、"spec.containers{name}" などの値に設定されます ("name" はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、"spec.containers[2]" の値に設定されます (この Pod 内でインデックスが 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部の参照を明確に定義するためです。TODO: この設計は最終版ではないため、このフィールドは今後変更になる場合があります。	string
kind 任意	参照先の種類。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。	string
name 任意	参照先の名前。詳細: Names	string
namespace 任意	参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/	string
resourceVersion 任意	この参照が作成される特定の resourceVersion (ある場合)。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency	string
uid 任意	参照先の UID。詳細: UIIDs	string

1.6. Subscriptions API

1.6.1. 概要

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

1.6.1.1. バージョン情報

バージョン: 2.10.0

1.6.1.2. URI スキーム

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

1.6.1.3. タグ

subscriptions.apps.open-cluster-management.io: サブスクリプションを作成して管理します。

1.6.2. パス

1.6.2.1. サブスクリプションの作成

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

1.6.2.1.1. 説明

サブスクリプションを作成します。

1.6.2.1.2. パラメーター

型	名前	説明	スキーマ
Header	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	string
パス	namespace 必須	使用する namespace (例: default)	string
Body	body 必須	作成するサブスクリプションを記述するパラメーター	Subscription

1.6.2.1.3. レスポンス

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

1.6.2.1.4. 消費されるアイテム

subscription/yaml

1.6.2.1.5. タグ

subscriptions.apps.open-cluster-management.io

1.6.2.1.6. HTTP リクエストの例

1.6.2.1.6.1. 要求の body

{
  "apiVersion" : "apps.open-cluster-management.io/v1",
  "kind" : "Subscription",
  "metadata" : {
    "name" : "sample_subscription",
    "namespace" : "default",
    "labels" : {
      "app" : "sample_subscription-app"
    },
    "annotations" : {
      "apps.open-cluster-management.io/git-path" : "apps/sample/",
      "apps.open-cluster-management.io/git-branch" : "sample_branch"
    }
  },
  "spec" : {
    "channel" : "channel_namespace/sample_channel",
    "packageOverrides" : [ {
      "packageName" : "my-sample-application",
      "packageAlias" : "the-sample-app",
      "packageOverrides" : [ {
        "path" : "spec",
        "value" : {
          "persistence" : {
            "enabled" : false,
            "useDynamicProvisioning" : false
          },
          "license" : "accept",
          "tls" : {
            "hostname" : "my-mcm-cluster.icp"
          },
          "sso" : {
            "registrationImage" : {
              "pullSecret" : "hub-repo-docker-secret"
            }
          }
        }
      } ]
    } ],
    "placement" : {
      "placementRef" : {
        "kind" : "PlacementRule",
        "name" : "demo-clusters"
      }
    }
  }
}

1.6.2.2. 全サブスクリプションのクエリー

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions

1.6.2.2.1. 説明

サブスクリプションにクエリーを行い、詳細を確認します。

1.6.2.2.2. パラメーター

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

1.6.2.2.3. レスポンス

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

1.6.2.2.4. 消費されるアイテム

subscription/yaml

1.6.2.2.5. タグ

subscriptions.apps.open-cluster-management.io

1.6.2.3. 単一サブスクリプションのクエリー

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}

1.6.2.3.1. 説明

1 つのサブスクリプションにクエリーを行い、詳細を確認します。

1.6.2.3.2. パラメーター

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

1.6.2.3.3. レスポンス

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

1.6.2.3.4. タグ

subscriptions.apps.open-cluster-management.io

1.6.2.4. サブスクリプションの削除

DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}

1.6.2.4.1. パラメーター

型	名前	説明	スキーマ
Header	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	string
パス	namespace 必須	使用する namespace (例: default)	string
パス	subscription_name 必須	削除するサブスクリプションの名前	string

1.6.2.4.2. レスポンス

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

1.6.2.4.3. タグ

subscriptions.apps.open-cluster-management.io

1.6.3. 定義

1.6.3.1. サブスクリプション

名前	スキーマ
apiVersion 必須	string
kind 必須	string
metadata 必須	metadata
spec 必須	spec
status 任意	status

metadata

名前	スキーマ
annotations 任意	object
labels 任意	object
name 任意	string
namespace 任意	string

spec

名前	スキーマ
channel 必須	string
name 任意	string
overrides 任意	overrides array
packageFilter 任意	packageFilter
packageOverrides 任意	packageOverrides array
placement 任意	placement
timewindow 任意	timewindow

overrides

名前	スキーマ
clusterName 必須	string
clusterOverrides 必須	object array

packageFilter

名前	説明	スキーマ
annotations 任意		string、string map
filterRef 任意		filterRef
labelSelector 任意		labelSelector
version 任意	Pattern : `"()((\\.[0-9])(\\.)\|(\\.[0-9])?(\\.[xX]))$"`	string

filterRef

名前	スキーマ
name 任意	string

labelSelector

名前	スキーマ
matchExpressions 任意	matchExpressions array
matchLabels 任意	string、string map

matchExpressions

名前	スキーマ
key 必須	string
operator 必須	string
values 任意	string array

packageOverrides

名前	スキーマ
packageAlias 任意	string
packageName 必須	string
packageOverrides 任意	object array

placement

名前	スキーマ
clusterSelector 任意	clusterSelector
clusters 任意	clusters array
local 任意	boolean
placementRef 任意	placementRef

clusterSelector

名前	スキーマ
matchExpressions 任意	matchExpressions array
matchLabels 任意	string、string map

matchExpressions

名前	スキーマ
key 必須	string
operator 必須	string
values 任意	string array

clusters

名前	スキーマ
name 必須	string

placementRef

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

timewindow

名前	スキーマ
daysofweek 任意	string array
hours 任意	hours array
location 任意	string
windowtype 任意	列挙 (active、blocked、Active、Blocked)

hours

名前	スキーマ
end 任意	string
start 任意	string

status

名前	スキーマ
lastUpdateTime 任意	string (date-time)
message 任意	string
phase 任意	string
reason 任意	string
statuses 任意	object

1.7. PlacementRules API (非推奨)

1.7.1. 概要

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

1.7.1.1. バージョン情報

バージョン: 2.10.0

1.7.1.2. URI スキーム

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

1.7.1.3. タグ

placementrules.apps.open-cluster-management.io: 配置ルールを作成して管理します。

1.7.2. パス

1.7.2.1. 配置ルールの作成

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

1.7.2.1.1. 説明

配置ルールを作成します。

1.7.2.1.2. パラメーター

型	名前	説明	スキーマ
Header	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	string
パス	namespace 必須	使用する namespace (例: default)	string
Body	body 必須	作成する配置ルールを記述するパラメーター	PlacementRule

1.7.2.1.3. レスポンス

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

1.7.2.1.4. 消費されるアイテム

application/yaml

1.7.2.1.5. タグ

placementrules.apps.open-cluster-management.io

1.7.2.1.6. HTTP リクエストの例

1.7.2.1.6.1. 要求の body

{
  "apiVersion" : "apps.open-cluster-management.io/v1",
  "kind" : "PlacementRule",
  "metadata" : {
    "name" : "towhichcluster",
    "namespace" : "ns-sub-1"
  },
  "spec" : {
    "clusterConditions" : [ {
      "type": "ManagedClusterConditionAvailable",
      "status": "True"
    } ],
    "clusterSelector" : { }
  }
}

1.7.2.2. 全配置ルールのクエリー

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules

1.7.2.2.1. 説明

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

1.7.2.2.2. パラメーター

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

1.7.2.2.3. レスポンス

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

1.7.2.2.4. 消費されるアイテム

application/yaml

1.7.2.2.5. タグ

placementrules.apps.open-cluster-management.io

1.7.2.3. 単一の placementrule のクエリー

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules/{placementrule_name}

1.7.2.3.1. 説明

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

1.7.2.3.2. パラメーター

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

1.7.2.3.3. レスポンス

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

1.7.2.3.4. タグ

placementrules.apps.open-cluster-management.io

1.7.2.4. placementrule の削除

DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules/{placementrule_name}

1.7.2.4.1. パラメーター

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

1.7.2.4.2. レスポンス

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

1.7.2.4.3. タグ

placementrules.apps.open-cluster-management.io

1.7.3. 定義

1.7.3.1. Placementrule

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

spec

名前	スキーマ
clusterConditions 任意	clusterConditions array
clusterReplicas 任意	integer
clusterSelector 任意	clusterSelector
clusters 任意	clusters array
policies 任意	policies array
resourceHint 任意	resourceHint
schedulerName 任意	string

clusterConditions

名前	スキーマ
status 任意	string
type 任意	string

clusterSelector

名前	スキーマ
matchExpressions 任意	matchExpressions array
matchLabels 任意	string、string map

matchExpressions

名前	スキーマ
key 任意	string
operator 任意	string
values 任意	string array

clusters

名前	スキーマ
name 任意	string

policies

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

resourceHint

名前	スキーマ
order 任意	string
type 任意	string

1.8. Applications API

1.8.1. 概要

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

1.8.1.1. バージョン情報

バージョン: 2.10.0

1.8.1.2. URI スキーム

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

1.8.1.3. タグ

applications.app.k8s.io: アプリケーションを作成して管理します。

1.8.2. パス

1.8.2.1. アプリケーションの作成

POST /app.k8s.io/v1beta1/namespaces/{namespace}/applications

1.8.2.1.1. 説明

アプリケーションを作成します。

1.8.2.1.2. パラメーター

型	名前	説明	スキーマ
Header	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	string
パス	namespace 必須	使用する namespace (例: default)	string
Body	body 必須	作成するアプリケーションを記述するパラメーター	アプリケーション

1.8.2.1.3. レスポンス

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

1.8.2.1.4. 消費されるアイテム

application/yaml

1.8.2.1.5. タグ

applications.app.k8s.io

1.8.2.1.6. HTTP リクエストの例

1.8.2.1.6.1. 要求の body

{
  "apiVersion" : "app.k8s.io/v1beta1",
  "kind" : "Application",
  "metadata" : {
    "labels" : {
      "app" : "nginx-app-details"
    },
    "name" : "nginx-app-3",
    "namespace" : "ns-sub-1"
  },
  "spec" : {
    "componentKinds" : [ {
      "group" : "apps.open-cluster-management.io",
      "kind" : "Subscription"
    } ]
  },
  "selector" : {
    "matchLabels" : {
      "app" : "nginx-app-details"
    }
  },
  "status" : { }
}

1.8.2.2. 全アプリケーションのクエリー

GET /app.k8s.io/v1beta1/namespaces/{namespace}/applications

1.8.2.2.1. 説明

アプリケーションにクエリーを行い、詳細を確認します。

1.8.2.2.2. パラメーター

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

1.8.2.2.3. レスポンス

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

1.8.2.2.4. 消費されるアイテム

application/yaml

1.8.2.2.5. タグ

applications.app.k8s.io

1.8.2.3. 単一アプリケーションのクエリー

GET /app.k8s.io/v1beta1/namespaces/{namespace}/applications/{application_name}

1.8.2.3.1. 説明

1 つのアプリケーションに対してクエリーを行い、詳細を確認します。

1.8.2.3.2. パラメーター

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

1.8.2.3.3. レスポンス

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

1.8.2.3.4. タグ

applications.app.k8s.io

1.8.2.4. アプリケーションの削除

DELETE /app.k8s.io/v1beta1/namespaces/{namespace}/applications/{application_name}

1.8.2.4.1. パラメーター

型	名前	説明	スキーマ
Header	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	string
パス	application_name 必須	削除するアプリケーションの名前	string
パス	namespace 必須	使用する namespace (例: default)	string

1.8.2.4.2. レスポンス

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

1.8.2.4.3. タグ

applications.app.k8s.io

1.8.3. 定義

1.8.3.1. アプリケーション

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

spec

名前	スキーマ
assemblyPhase 任意	string
componentKinds 任意	object array
descriptor 任意	記述子
info 任意	info array
selector 任意	object

記述子

名前	スキーマ
description 任意	string
icons 任意	icons array
keywords 任意	string array
links 任意	links array
maintainers 任意	maintainers array
notes 任意	string
owners 任意	owners array
type 任意	string
version 任意	string

icons

名前	スキーマ
size 任意	string
src 必須	string
type 任意	string

links

名前	スキーマ
description 任意	string
url 任意	string

maintainers

名前	スキーマ
email 任意	string
name 任意	string
url 任意	string

owners

名前	スキーマ
email 任意	string
name 任意	string
url 任意	string

info

名前	スキーマ
name 任意	string
type 任意	string
value 任意	string
valueFrom 任意	valueFrom

valueFrom

名前	スキーマ
configMapKeyRef 任意	configMapKeyRef
ingressRef 任意	ingressRef
secretKeyRef 任意	secretKeyRef
serviceRef 任意	serviceRef
type 任意	string

configMapKeyRef

名前	スキーマ
apiVersion 任意	string
fieldPath 任意	string
key 任意	string
kind 任意	string
name 任意	string
namespace 任意	string
resourceVersion 任意	string
uid 任意	string

ingressRef

名前	スキーマ
apiVersion 任意	string
fieldPath 任意	string
host 任意	string
kind 任意	string
name 任意	string
namespace 任意	string
path 任意	string
resourceVersion 任意	string
uid 任意	string

secretKeyRef

名前	スキーマ
apiVersion 任意	string
fieldPath 任意	string
key 任意	string
kind 任意	string
name 任意	string
namespace 任意	string
resourceVersion 任意	string
uid 任意	string

serviceRef

名前	スキーマ
apiVersion 任意	string
fieldPath 任意	string
kind 任意	string
name 任意	string
namespace 任意	string
path 任意	string
port 任意	integer (int32)
resourceVersion 任意	string
uid 任意	string

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.10.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

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

repo

名前	スキーマ
chartName 任意	string
configMapRef 任意	configMapRef
secretRef 任意	secretRef
source 任意	source
version 任意	string

configMapRef

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

secretRef

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

source

名前	スキーマ
github 任意	github
helmRepo 任意	helmRepo
type 任意	string

github

名前	スキーマ
branch 任意	string
chartPath 任意	string
urls 任意	string array

helmRepo

名前	スキーマ
urls 任意	string array

status

名前	スキーマ
conditions 必須	conditions array
deployedRelease 任意	deployedRelease

conditions

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

deployedRelease

名前	スキーマ
manifest 任意	string
name 任意	string

1.10. Policy API

1.10.1. 概要

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

1.10.1.1. バージョン情報

バージョン: 2.10.0

1.10.1.2. URI スキーム

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

1.10.1.3. タグ

policy.open-cluster-management.io/v1: ポリシーを作成して管理します。

1.10.2. パス

1.10.2.1. ポリシーの作成

POST /policy.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}

1.10.2.1.1. 説明

ポリシーを作成します。

1.10.2.1.2. パラメーター

型	名前	説明	スキーマ
Header	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	string
パス	namespace 必須	使用する namespace (例: default)	string
Body	body 必須	作成するポリシーを記述するパラメーター	ポリシー

1.10.2.1.3. レスポンス

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

1.10.2.1.4. 消費されるアイテム

application/json

1.10.2.1.5. タグ

policy.open-cluster-management.io

1.10.2.1.6. HTTP リクエストの例

1.10.2.1.6.1. 要求の body

{
  "apiVersion": "policy.open-cluster-management.io/v1",
  "kind": "Policy",
  "metadata": {
    "name": "test-policy-swagger",
    "description": "Example body for Policy API Swagger docs"
  },
  "spec": {
    "remediationAction": "enforce",
    "namespaces": {
      "include": [
        "default"
      ],
      "exclude": [
        "kube*"
      ]
    },
    "policy-templates": {
    "kind": "ConfigurationPolicy",
    "apiVersion": "policy.open-cluster-management.io/v1",
    "complianceType": "musthave",
    "metadataComplianceType": "musthave",
    "metadata": {
      "namespace": null,
      "name": "test-role"
    },
    "selector": {
      "matchLabels": {
        "cloud": "IBM"
      }
    },
    "spec" : {
      "object-templates": {
        "complianceType": "musthave",
        "metadataComplianceType": "musthave",
        "objectDefinition": {
          "apiVersion": "rbac.authorization.k8s.io/v1",
          "kind": "Role",
          "metadata": {
            "name": "role-policy",
          },
          "rules": [
            {
              "apiGroups": [
                "extensions",
                "apps"
              ],
              "resources": [
                "deployments"
              ],
              "verbs": [
                "get",
                "list",
                "watch",
                "delete"
              ]
            },
            {
              "apiGroups": [
                "core"
              ],
              "resources": [
                "pods"
              ],
              "verbs": [
                "create",
                "update",
                "patch"
              ]
            },
            {
              "apiGroups": [
                "core"
              ],
              "resources": [
                "secrets"
              ],
              "verbs": [
                "get",
                "watch",
                "list",
                "create",
                "delete",
                "update",
                "patch"
              ],
            },
          ],
        },
      },
    },
  },

1.10.2.2. 全ポリシーのクエリー

GET /policy.open-cluster-management.io/v1/namespaces/{namespace}/policies/{policy_name}

1.10.2.2.1. 説明

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

1.10.2.2.2. パラメーター

型	名前	説明	スキーマ
Header	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	string
パス	namespace 必須	ポリシーを適用する namespace (例: default)	string

1.10.2.2.3. レスポンス

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

1.10.2.2.4. 消費されるアイテム

application/json

1.10.2.2.5. タグ

policy.open-cluster-management.io

1.10.2.3. 単一ポリシーのクエリー

GET /policy.open-cluster-management.io/v1/namespaces/{namespace}/policies/{policy_name}

1.10.2.3.1. 説明

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

1.10.2.3.2. パラメーター

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

1.10.2.3.3. レスポンス

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

1.10.2.3.4. タグ

policy.open-cluster-management.io

1.10.2.4. ポリシーの削除

DELETE /policy.open-cluster-management.io/v1/namespaces/{namespace}/policies/{policy_name}

1.10.2.4.1. パラメーター

型	名前	説明	スキーマ
Header	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	string
パス	policy_name 必須	削除するポリシーの名前	string
パス	namespace 必須	使用する namespace (例: default)	string

1.10.2.4.2. レスポンス

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

1.10.2.4.3. タグ

policy.open-cluster-management.io

1.10.3. 定義

1.10.3.1. Policy

名前	説明	スキーマ
apiVersion 必須	Policy のバージョンスキーマ	string
kind 必須	REST リソースを表す文字列の値	string
metadata 必須	ポリシーを定義するルールを記述します。	object

spec

名前	説明	スキーマ
remediationAction 任意	リソースで定義されているように違反をどのように処理するかを表す値	string
namespaceSelector 必須	ポリシーが適用される namespace を表す値	string

policy-templates

名前	説明	スキーマ
apiVersion 必須	Policy のバージョンスキーマ	string
kind 任意	REST リソースを表す文字列の値	string
metadata 必須	ポリシーを定義するルールを記述します。	object
complianceType	マネージドクラスターに評価または適用する必要のあるロールおよび他の Kubernetes オブジェクトの予想される動作をリスト表示するのに使用されます。	string
metadataComplianceType 任意	ユーザーがオブジェクトのラベルおよびアノテーションを他のフィールドとは異なる方法で処理する方法を提供します。パラメーター値は、デフォルトで `ComplianceType` パラメーターと同じ値になります。	string
clusterConditions 任意	ラベルを定義するセクション	string
rules 任意		string

clusterConditions

名前	説明	スキーマ
matchLabels 任意	ポリシーを namespace に適用するのに必要なラベル	object
cloud 任意	ポリシーをクラウドプロバイダーに適用するのに必要なラベル	string

rules

名前	説明	スキーマ
apiGroups 必須	このルールが適用される API のリスト	string
resources 必須	リソースタイプのリスト	object
verbs 必須	動詞のリスト	string

1.11. Observability API

1.11.1. 概要

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

1.11.1.1. バージョン情報

バージョン: 2.10.0

1.11.1.2. URI スキーム

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

1.11.1.3. タグ

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

1.11.2. パス

1.11.2.1. multiclusterobservability リソースの作成

POST /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities

1.11.2.1.1. 説明

MultiClusterObservability リソースを作成します。

1.11.2.1.2. パラメーター

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

1.11.2.1.3. レスポンス

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

1.11.2.1.4. 消費されるアイテム

application/yaml

1.11.2.1.5. タグ

observability.apps.open-cluster-management.io

1.11.2.1.6. HTTP リクエストの例

1.11.2.1.6.1. 要求の body

{
  "apiVersion": "observability.open-cluster-management.io/v1beta2",
  "kind": "MultiClusterObservability",
  "metadata": {
    "name": "example"
  },
  "spec": {
    "observabilityAddonSpec": {}
    "storageConfig": {
      "metricObjectStorage": {
        "name": "thanos-object-storage",
        "key": "thanos.yaml"
      "writeStorage": {
        - "key": " ",
          "name" : " "
        - "key": " ",
          "name" : " "
         }
       }
   }
}

1.11.2.2. すべての multiclusterobservability のクエリー

GET /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities

1.11.2.2.1. 説明

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

1.11.2.2.2. パラメーター

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

1.11.2.2.3. レスポンス

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

1.11.2.2.4. 消費されるアイテム

application/yaml

1.11.2.2.5. タグ

observability.apps.open-cluster-management.io

1.11.2.3. 単一の multiclusterobservability のクエリー

GET /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities/{multiclusterobservability_name}

1.11.2.3.1. 説明

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

1.11.2.3.2. パラメーター

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

1.11.2.3.3. レスポンス

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

1.11.2.3.4. タグ

observability.apps.open-cluster-management.io

1.11.2.4. multiclusterobservability リソースの削除

DELETE /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities/{multiclusterobservability_name}

1.11.2.4.1. パラメーター

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

1.11.2.4.2. レスポンス

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

1.11.2.4.3. タグ

observability.apps.open-cluster-management.io

1.11.3. 定義

1.11.3.1. MultiClusterObservability

名前	説明	スキーマ
apiVersion 必須	MultiClusterObservability のバージョンスキーマ	string
kind 必須	REST リソース (MultiClusterObservability) を表す文字列の値	string
metadata 必須	ポリシーを定義するルールを記述します。	object

spec

名前	説明	スキーマ
enableDownsampling 任意	downsample を有効または無効にします。デフォルト値は `true` です。downsample データがない場合は、クエリーを利用できません。	boolean
imagePullPolicy 任意	MultiClusterObservability イメージのプルポリシー。デフォルト値は `Always` です。	corev1.PullPolicy
imagePullSecret 任意	MultiClusterObservability イメージのプルシークレット。デフォルト値は `multiclusterhub-operator-pull-secret` です。	string
nodeSelector 任意	ノードセレクターの仕様	map[string]string
observabilityAddonSpec 必須	可観測性アドオンがインストール済みの全マネージドクラスターのグローバル設定	observabilityAddonSpec
storageConfig 必須	可観測性が使用するストレージ設定を指定します。	StorageConfig
tolerations 任意	すべてのコンポーネントがテイントを容認する機能を提供します。	[]corev1.Toleration
advanced 任意	可観測性の詳細設定	advanced
resources 任意	MultiClusterObservability で必要なコンピュートリソース	corev1.ResourceRequirements
replicas 任意	MultiClusterObservability のレプリカ	integer

storageConfig

名前	説明	スキーマ
alertmanagerStorageSize 任意	alertmanager ステートフルセットに適用されるストレージの量。デフォルト値は `1Gi` です。	string
compactStorageSize 任意	thanos のコンパクトなステートフルセットに適用されるストレージの量。デフォルト値は `100Gi` です。	string
metricObjectStorage 必須	メトリックのシークレットを設定するオブジェクトストア	metricObjectStorage
receiveStorageSize 任意	thanos 受信ステートフルセットに適用されるストレージの量。デフォルト値は `100Gi` です。	string
ruleStorageSize 任意	thanos ルールのステートフルセットに適用されるストレージの量。デフォルト値は `1Gi` です。	string
storageClass 任意	`storageClass` ステートフルセットを指定します。このストレージは、オペレーティングシステムでストレージを作成するように `metricObjectStorage` が設定されている場合に、オブジェクトストレージに使用します。デフォルト値は `gp2` です。	string
storeStorageSize 任意	thanos ストアステートフルセットに適用されるストレージの量。デフォルト値は `10Gi` です。	string
writeStorage 任意	エンドポイントアクセス情報のリスト。	[ ]WriteStorage

writeStorage

名前	説明	スキーマ
name 必須	エンドポイントアクセス情報を持つシークレットの名前。	string
key 必須	選択するシークレットのキー。	string

metricObjectStorage

名前	説明	スキーマ
key 必須	選択するシークレットのキー。有効な秘密鍵でなければなりません。Thanos のドキュメントを参照してください。	string
name 必須	`metricObjectStorage` の名前。詳細は、Kubernetes Names を参照してください。	string

observabilityAddonSpec

名前	説明	スキーマ
enableMetrics 任意	可観測性アドオンがメトリックをハブクラスターに送信するかどうかを指定します。デフォルト値は `true` です。	boolean
interval 任意	可観測性アドオンがメトリックをハブクラスターに送信する間隔。デフォルト値は 300 秒 (`300s`) です。	integer
resources 任意	メトリックコレクターリソース要件のリソースデフォルトの CPU 要求は `100m` で、メモリー要求は `100Mi` です。	corev1.ResourceRequirements

advanced

名前	説明	スキーマ
retentionConfig 任意	可観測性によって使用されるデータ保持設定を指定します。	`RetentionConfig`
rbacQueryProxy 任意	rbac-query-proxy デプロイメントのレプリカおよびリソースを指定します。	CommonSpec
grafana 任意	grafana デプロイメントのレプリカおよびリソースを指定します。	CommonSpec
alertmanager 任意	alertmanager ステートフルセットのレプリカおよびリソースを指定します。	CommonSpec
observatoriumAPI 任意	`observatorium-api` デプロイメントのレプリカおよびリソースを指定します。	CommonSpec
queryFrontend 任意	query-frontend デプロイメントのレプリカおよびリソースを指定します。	CommonSpec
query 任意	クエリーデプロイメントのレプリカおよびリソースを指定します。	CommonSpec
receive 任意	受信ステートフルセットのレプリカおよびリソースを指定します。	CommonSpec
rule 任意	ルールのステートフルセットのレプリカおよびリソースを指定します。	CommonSpec
store 任意	ストアステートフルセットのレプリカおよびリソースを指定します。	CommonSpec
CompactSpec 任意	コンパクトなステートフルセットのリソースを指定します。	compact
storeMemcached 任意	store-memcached のレプリカ、リソースなどを指定します。	storeMemcached
queryFrontendMemcached 任意	query-frontend-memcached のレプリカ、リソースなどを指定します。	CacheConfig

retentionConfig

名前	説明	スキーマ
blockDuration 任意	時系列データベース (TSDB) ブロックを停止する時間。デフォルト値は `2h` です。	string
cleanupInterval 任意	部分的にアップロードされたブロックが消去される頻度および、`--wait` が有効な削除マークの付いたブロックが消去される頻度。デフォルト値は `5m` です。	string
deleteDelay 任意	削除対象のブロックがバケットから削除されるまでの期間。デフォルト値は `48h` です。	string
retentionInLocal 任意	ローカルストレージからの未加工のサンプルを保持する時間。デフォルト値は `24h` です。	string
retentionResolutionRaw 任意	バスケットで未加工の解像度サンプルを保持する時間。デフォルト値は 365 日 (`365d`) です。	string
retentionResolution5m 任意	バスケットに解像度 1 (5 分) のサンプルを保持する時間。デフォルト値は 365 日 (`365d`) です。	string
retentionResolution1h 任意	バスケットに解像度 2 (1 時間) のサンプルを保持する時間。デフォルト値は 365 日 (`365d`) です。	string

CompactSpec

名前	説明	スキーマ
resources 任意	thanos compact に必要なリソースを計算します。	corev1.ResourceRequirements
serviceAccountAnnotations 任意	アノテーションは、コンパクトサービスアカウントに保存されている非構造化キーバリューマップです。	map[string]string

storeMemcached

名前	説明	スキーマ
resources 任意	MultiCLusterObservability で必要なコンピュートリソース	corev1.ResourceRequirements
replicas 任意	MultiClusterObservability のレプリカ	integer
memoryLimitMb 任意	メガバイト単位の Memcached のメモリー制限	integer
maxItemSize 任意	Memcached の最大項目サイズ。デフォルト値は `1m, min:1k, max:1024m` です。	string
connectionLimit 任意	Memcached の同時接続の最大数。デフォルト値:	integer

status

名前	説明	スキーマ
status 任意	ステータスには、MultiClusterObservability のさまざまな条件のステータスが含まれます。	metav1.Condition

CommonSpec

名前	説明	スキーマ
resources 任意	コンポーネントに必要なリソースを計算します。	corev1.ResourceRequirements
replicas 任意	コンポーネントのレプリカ。	integer

QuerySpec

名前	説明	スキーマ
CommonSpec 任意	クエリーデプロイメントのレプリカおよびリソースを指定します。	CommonSpec
serviceAccountAnnotations 任意	アノテーションは、クエリーサービスアカウントとともに保存される非構造化キー値マップです。	map[string]string

ReceiveSpec

名前	説明	スキーマ
CommonSpec 任意	クエリーデプロイメントのレプリカおよびリソースを指定します。	CommonSpec
serviceAccountAnnotations 任意	アノテーションは、クエリーサービスアカウントとともに保存される非構造化キー値マップです。	map[string]string

StoreSpec

名前	説明	スキーマ
CommonSpec 任意	クエリーデプロイメントのレプリカおよびリソースを指定します。	CommonSpec
serviceAccountAnnotations 任意	アノテーションは、クエリーサービスアカウントとともに保存される非構造化キー値マップです。	map[string]string

RuleSpec

名前	説明	スキーマ
CommonSpec 任意	クエリーデプロイメントのレプリカおよびリソースを指定します。	CommonSpec
evalInterval 任意	ルールの評価間隔を指定します。	string
serviceAccountAnnotations 任意	アノテーションは、クエリーサービスアカウントとともに保存される非構造化キー値マップです。	map[string]string

1.12. 検索クエリー API

検索クエリー API は Kubernetes API ではないため、Red Hat OpenShift Container Platform API Explorer では表示されません。検索クエリー API の機能を理解するには、本書の続きもご確認ください。

1.12.1. 概要

検索クエリー API をルートで公開し、API を使用して検索クエリーを解決できます。API は GraphQL エンドポイントです。curl や Postman などの任意のクライアントを使用できます。

1.12.1.1. バージョン情報

バージョン: 2.10.0

1.12.1.2. URI スキーム

ベースパス: /searchapi/graphql
スキーム: HTTPS

1.12.1.3. API アクセスの設定

以下のコマンドを使用して、クラスターの外部から Search API にアクセスするためのルートを作成します。

oc create route passthrough search-api --service=search-search-api -n open-cluster-management

重要: 環境を保護するには、ルートを設定する必要があります。詳細は、OpenShift Container Platform ドキュメントのルート設定を参照してください。

1.12.2. スキーマ設計

input SearchFilter {
  property: String!
  values: [String]!
}
input SearchInput {
  keywords: [String]
  filters: [SearchFilter]
  limit: Int
  relatedKinds: [String]
}
type SearchResult {
count: Int
items: [Map]
related: [SearchRelatedResult]
}
type SearchRelatedResult {
kind: String!
count: Int
items: [Map]
}

! を使用したパラメーターは、フィールドが必要であることを示します。

1.12.2.1. クエリー入力の説明表

型	説明	プロパティー
SearchFilter	結果をフィルタリングするキーと値を定義します。プロパティーに多くの値を指定すると、API は値を "OR" 操作として解釈します。多くのフィルターを指定すると、結果はすべてのフィルターに一致し、API は "AND" 操作として解釈します。	string
SearchInput	リソースの一覧を表示するには、主要な用語を入力します。多くのキーワードを指定すると、API はそれを "AND" 操作として解釈します。	String
limit	クエリーを入力した後に返される結果の最大数を決定します。デフォルト値は `10,000` です。`-1` の値は、制限が削除されることを意味します。	整数

1.12.2.2. スキーマの例

{
  "query": "type SearchResult {count: Intitems: [Map]related: [SearchRelatedResult]} type SearchRelatedResult {kind: String!count: Intitems: [Map]}",
  "variables": {
    "input": [
      {
        "keywords": [],
        "filters": [
          {
            "property": "kind",
            "values": [
              "Deployment"
            ]
          }
        ],
        "limit": 10
      }
    ]
  }
}

1.12.3. 汎用スキーマ

type Query {
  search(input: [SearchInput]): [SearchResult]
  searchComplete(property: String!, query: SearchInput, limit: Int): [String]
  searchSchema: Map
  messages: [Message]
}

1.12.4. サポートされているクエリー

JSON 形式でサポートされているクエリータイプを確認するには、このまま読み進めてください。

1.12.4.1. デプロイメントの検索

クエリー:

query mySearch($input: [SearchInput]) {
    search(input: $input) {
    		items
        }
}

変数:

{"input":[
    {
        "keywords":[],
        "filters":[
            {"property":"kind","values":["Deployment"]}],
        "limit":10
    }
]}

1.12.4.2. Pod の検索

クエリー:

query mySearch($input: [SearchInput]) {
    search(input: $input) {
    		items
        }
}

変数:

{"input":[
    {
        "keywords":[],
        "filters":[
            {"property":"kind","values":["Pod"]}],
        "limit":10
    }
]}

1.13. MultiClusterHub API

1.13.1. 概要

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

1.13.1.1. バージョン情報

バージョン: 2.10.0

1.13.1.2. URI スキーム

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

1.13.1.3. タグ

multiclusterhubs.operator.open-cluster-management.io: マルチクラスターハブ演算子を作成して管理します。

1.13.2. パス

1.13.2.1. MultiClusterHub リソースの作成

POST /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/mch

1.13.2.1.1. 説明

MultiClusterHub リソースを作成し、multicluster hub のインスタンスの設定を定義します。

1.13.2.1.2. パラメーター

型	名前	説明	スキーマ
Header	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	string
パス	namespace 必須	使用する namespace (例: default)	string
Body	body 必須	作成する multicluster hub を記述するパラメーター	定義

1.13.2.1.3. レスポンス

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

1.13.2.1.4. 消費されるアイテム

multiclusterhubs/yaml

1.13.2.1.5. タグ

multiclusterhubs.operator.open-cluster-management.io

1.13.2.1.6. HTTP リクエストの例

1.13.2.1.6.1. 要求の body

{
  "apiVersion": "apiextensions.k8s.io/v1",
  "kind": "CustomResourceDefinition",
  "metadata": {
    "name": "multiclusterhubs.operator.open-cluster-management.io"
    },
  "spec": {
    "group": "operator.open-cluster-management.io",
    "names": {
      "kind": "MultiClusterHub",
      "listKind": "MultiClusterHubList",
      "plural": "multiclusterhubs",
      "shortNames": [
          "mch"
	  ],
     "singular": "multiclusterhub"
     },
    "scope": "Namespaced",
    "versions": [
        {
	    "additionalPrinterColumns": [
                {
		   "description": "The overall status of the multicluster hub.",
                   "jsonPath": ".status.phase",
                   "name": "Status",
                   "type": "string"
		   },
               {
	           "jsonPath": ".metadata.creationTimestamp",
                   "name": "Age",
                   "type": "date"
		   }
            ],
            "name": "v1",
            "schema": {
                "openAPIV3Schema": {
                    "description": "MultiClusterHub defines the configuration for an instance of
          the multiCluster hub, a central point for managing multiple Kubernetes-based
          clusters. The deployment of multicluster hub components is determined based
          on the configuration that is defined in this resource.",
        "properties": {
            "apiVersion": {
                "description": "APIVersion defines the versioned schema of this representation
              of an object. Servers should convert recognized schemas to the latest
              internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
                "type": "string"
            },
            "kind": {
                "description": "Kind is a string value representing the REST resource this
              object represents. Servers may infer this from the endpoint the client
              submits requests to. Cannot be updated. The value is in CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
                "type": "string"
            },
            "metadata": {
                "type": "object"
            },
            "spec": {
                "description": "MultiClusterHubSpec defines the desired state of MultiClusterHub.",
                "properties": {
                    "availabilityConfig": {
                        "description": "Specifies deployment replication for improved availability.
                  Options are: Basic and High (default).",
                        "type": "string"
                },
                "customCAConfigmap": {
                    "description": "Provide the customized OpenShift default ingress CA certificate
                  to {acm-short}.",
                  }
                    "type": "string"
                },
        "disableHubSelfManagement": {
                    "description": "Disable automatic import of the hub cluster as a managed
                  cluster.",
                    "type": "boolean"
                },
        "disableUpdateClusterImageSets": {
                    "description": "Disable automatic update of ClusterImageSets.",
                    "type": "boolean"
                },
                "hive": {
                    "description": "(Deprecated) Overrides for the default HiveConfig specification.",
                    "properties": {
        "additionalCertificateAuthorities": {
        "description": "(Deprecated) AdditionalCertificateAuthorities is
                      a list of references to secrets in the 'hive' namespace that
                      contain an additional Certificate Authority to use when communicating
                      with target clusters. These certificate authorities are
                      used in addition to any self-signed CA generated by each cluster
                      on installation.",
                           "items": {
                    "description": "LocalObjectReference contains the information
                        to let you locate the referenced object inside the same namespace.",
                    "properties": {
                    "name": {
                        "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
                        "type": "string"
                     }
		             },
                    "type": "object"
                      },
                           "type": "array"
                    },
                       "backup": {
                    "description": "(Deprecated) Backup specifies configuration for backup
                      integration. If absent, backup integration is disabled.",
                    "properties": {
                    "minBackupPeriodSeconds": {
                    "description": "(Deprecated) MinBackupPeriodSeconds specifies
                          that a minimum of MinBackupPeriodSeconds occurs in between
                          each backup. This is used to rate limit backups. This potentially
                          batches together multiple changes into one backup. No backups
                          are lost for changes that happen during the interval
                          that is queued up, and results in a backup once
                          the interval has been completed.",
                    "type": "integer"
                        },
                    "velero": {
                    "description": "(Deprecated) Velero specifies configuration for the Velero backup integration.",
		    "properties": {
			"enabled": {
			    "description": "(Deprecated) Enabled dictates if the Velero backup integration is enabled. If not specified, the default is disabled.",
			    "type": "boolean"
			}
		   },
		    "type": "object"
				        }
				  },
				        "type": "object"
				     },
		    "externalDNS": {
		    "description": "(Deprecated) ExternalDNS specifies configuration for external-dns if it is to be deployed by Hive. If absent, external-dns is not deployed.",
		    "properties": {
		    "aws": {
		    "description": "(Deprecated) AWS contains AWS-specific settings for external DNS.",
		    "properties": {
		        "credentials": {
			    "description": "(Deprecated) Credentials reference a secret that is used to authenticate with AWS Route53. It needs permission to manage entries in each of the managed domains for this cluster. Secret should have AWS keys named 'aws_access_key_id' and 'aws_secret_access_key'.",
			    "properties": {
				"name": {
																		            "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
																		                             "type": "string"
						    }
					},
			    "type": "object"
			}
		},
		   "type": "object"
					},
		   "gcp": {
		   "description": "(Deprecated) GCP contains Google Cloud Platform specific settings for external DNS.",
		   "properties": {
		       "credentials": {
			   "description": "(Deprecated) Credentials reference a secret that is used to authenticate with GCP DNS. It needs permission to manage entries in each of the managed domains for this cluster. Secret should have a key names 'osServiceAccount.json'. The credentials must specify the project to use.",
			   "properties": {
			       "name": {
		   "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
				   "type": "string"
							}
						},
			   "type": "object"
			}
		},
		"type": "object"
					}
				},
				      "type": "object"
					},
		"failedProvisionConfig": {
		"description": "(Deprecated) FailedProvisionConfig is used to configure settings related to handling provision failures.",
		"properties": {
		"skipGatherLogs": {
		"description": "(Deprecated) SkipGatherLogs disables functionality that attempts to gather full logs from the cluster if an installation fails for any reason. The logs are stored in a persistent volume for up to seven days.",
	        "type": "boolean"
				   }
				},
				  "type": "object"
				  },
		"globalPullSecret": {
		"description": "(Deprecated) GlobalPullSecret is used to specify a pull secret that is used globally by all of the cluster deployments. For each cluster deployment, the contents of GlobalPullSecret are merged with the specific pull secret for a cluster deployment(if specified), with precedence given to the contents of the pull secret for the cluster deployment.",
		"properties": {
		"name": {
		"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
		"type": "string"
			                }
				},
				  "type": "object"
							},
		"maintenanceMode": {
	        "description": "(Deprecated) MaintenanceMode can be set to true to disable the Hive controllers in situations where you need to ensure nothing is running that adds or act upon finalizers on Hive types. This should rarely be needed. Sets replicas to zero for the 'hive-controllers' deployment to accomplish this.",
				  "type": "boolean"
							}
						},
			  "required": [
				         "failedProvisionConfig"
						     ],
			  "type": "object"
						 },
		"imagePullSecret": {
		    "description": "Override pull secret for accessing MultiClusterHub operand and endpoint images.",
		    "type": "string"
					},
		"ingress": {
		    "description": "Configuration options for ingress management.",
		    "properties": {
			"sslCiphers": {
	"description": "List of SSL ciphers enabled for management ingress. Defaults to full list of supported ciphers.",
			    "items": {
		    "type": "string"
					},
			    "type": "array"
						}
					},
			       "type": "object"
						},
			   "nodeSelector": {
		   "additionalProperties": {
				   "type": "string"
						},
			       "description": "Set the node selectors..",
			       "type": "object"
			},
			   "overrides": {
			       "description": "Developer overrides.",
			       "properties": {
		   "imagePullPolicy": {
		   "description": "Pull policy of the multicluster hub images.",
			               "type": "string"
							}
						},
			      "type": "object"
									},
		   "separateCertificateManagement": {
				     "description": "(Deprecated) Install cert-manager into its own namespace.",
				     "type": "boolean"
						    }
					   },
			   "type": "object"
		       },
		       "status": {
			 "description": "MulticlusterHubStatus defines the observed state of MultiClusterHub.",
			 "properties": {
			     "components": {
		      "additionalProperties": {
		      "description": "StatusCondition contains condition information.",
				      "properties": {
		      "lastTransitionTime": {
		      "description": "LastTransitionTime is the last time the condition changed from one status to another.",
		      "format": "date-time",
		      "type": "string"
					},
		      "message": {
		      "description": "Message is a human-readable message indicating\ndetails about the last status change.",
		      "type": "string"
						},
				          "reason": {
		      "description": "Reason is a (brief) reason for the last status change of the condition.",
		      "type": "string"
						},
					  "status": {
		      "description": "Status is the status of the condition. One of True, False, Unknown.",
		      "type": "string"
					},
					  "type": {
		      "description": "Type is the type of the cluster condition.",
		      "type": "string"
					}
				},
				     "type": "object"
						      },
				  "description": "Components []ComponentCondition `json:\"manifests,omitempty\"`",
				  "type": "object"
							},
			      "conditions": {
				  "description": "Conditions contain the different condition statuses for the MultiClusterHub.",
				  "items": {
		      "description": "StatusCondition contains condition information.",
				      "properties": {
		      "lastTransitionTime": {
		      "description": "LastTransitionTime is the last time the condition changed from one status to another.",
		      "format": "date-time",
		      "type": "string"
					},
		      "lastUpdateTime": {
		      "description": "The last time this condition was updated.",
		      "format": "date-time",
		      "type": "string"
					},
		      "message": {
		      "description": "Message is a human-readable message indicating details about the last status change.",
		      "type": "string"
						},
				          "reason": {
		      "description": "Reason is a (brief) reason for the last status change of the condition.",
		      "type": "string"
					},
					  "status": {
		      "description": "Status is the status of the condition. One of True, False, Unknown.",
		      "type": "string"
						},
					  "type": {
		      "description": "Type is the type of the cluster condition.",
		      "type": "string"
					}
				},
				     "type": "object"
						      },
				 "type": "array"
					},
			     "currentVersion": {
				 "description": "CurrentVersion indicates the current version..",
				 "type": "string"
						},
			     "desiredVersion": {
				 "description": "DesiredVersion indicates the desired version.",
				 "type": "string"
						 },
			     "phase": {
				 "description": "Represents the running phase of the MultiClusterHub",
				 "type": "string"
							}
						},
	                 "type": "object"
					   }
				   },
                "type": "object"
			        }
		         },
        "served": true,
        "storage": true,
        "subresources": {
	    "status": {}
	    }
	}
    ]
  }
}

1.13.2.2. 全 MultiClusterHubs のクエリー

GET /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/operator

1.13.2.2.1. 説明

multicluster hub 演算子に対してクエリーを実行して詳細を確認します。

1.13.2.2.2. パラメーター

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

1.13.2.2.3. レスポンス

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

1.13.2.2.4. 消費されるアイテム

operator/yaml

1.13.2.2.5. タグ

multiclusterhubs.operator.open-cluster-management.io

1.13.2.3. MultiClusterHub 演算子のクエリー

GET /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/operator/{multiclusterhub_name}

1.13.2.3.1. 説明

単一の multicluster hub 演算子に対してクエリーを実行して詳細を確認します。

1.13.2.3.2. パラメーター

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

1.13.2.3.3. レスポンス

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

1.13.2.3.4. タグ

multiclusterhubs.operator.open-cluster-management.io

1.13.2.4. MultiClusterHub 演算子の削除

DELETE /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/operator/{multiclusterhub_name}

1.13.2.4.1. パラメーター

型	名前	説明	スキーマ
Header	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	string
パス	application_name 必須	削除する multicluster hub 演算子の名前	string
パス	namespace 必須	使用する namespace (例: default)	string

1.13.2.4.2. レスポンス

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

1.13.2.4.3. タグ

multiclusterhubs.operator.open-cluster-management.io

1.13.3. 定義

1.13.3.1. Multicluster hub operator

名前	説明	スキーマ
apiVersion 必須	MultiClusterHub のバージョンスキーマ。	string
kind 必須	REST リソースを表す文字列の値	string
metadata 必須	リソースを定義するルールを記述します。	object
spec 必須	リソース仕様	spec

spec

availabilityConfig 任意	デプロイメントレプリケーションを指定して可用性を向上させます。デフォルト値は `High` です。	string
customCAConfigmap 任意	カスタマイズされた OpenShift デフォルト Ingress CA 証明書を Red Hat Advanced Cluster Management に提供します。	string
disableHubSelfManagement 任意	マネージドクラスターとしてハブクラスターの自動インポートを無効にします。	boolean
disableUpdateClusterImageSets 任意	ClusterImageSets の自動更新を無効にします。	boolean
hive 任意	(非推奨) デフォルトの HiveConfig 仕様を上書きするオブジェクト。	hive
imagePullSecret 任意	MultiClusterHub オペランドおよびエンドポイントイメージにアクセスするためのプルシークレットを上書きします。	string
ingress 任意	Ingress 管理の設定オプション。	ingress
nodeSelector 任意	ノードセレクターを設定します。	string
separateCertificateManagement 任意	(非推奨) `cert-manager` を独自の namespace にインストールします。	boolean

hive

additionalCertificateAuthorities 任意	(非推奨) ターゲットクラスターとの通信時に使用する追加の認証局が含まれる `hive` namespace のシークレットへの参照リスト。インストール時に各クラスターが生成する自己署名の CA のほかに、この認証局が使用されます。	object
backup 任意	(非推奨) バックアップ統合の設定を指定します。存在しない場合、バックアップ統合は無効になります。	backup
externalDNS 任意	(非推奨) Hive でデプロイする場合は `external-dns` の設定を指定します。存在しない場合、`external-dns` はデプロイされません。	object
failedProvisionConfig 必須	(非推奨) プロビジョニングの失敗の処理に関連する設定に使用します。	failedProvisionConfig
globalPullSecret 任意	(非推奨) 全クラスターデプロイメントがグローバルで使用するプルシークレットを指定するのに使用します。クラスターデプロイメントごとに、`globalPullSecret` の内容はクラスターデプロイメントの特定のプルシークレットにマージされます (指定されている場合)。これはクラスターデプロイメントのプルシークレットの内容よりも優先されます。	object
maintenanceMode 任意	(非推奨) true に設定して、Hive タイプのファイナライザーに対して追加したり、実行したりするような操作が行われないようにする必要がある場合など、hive コントローラーを無効にできます。このような状況はほぼ発生しないはずです。`hive-controllers` デプロイメントの場合にはレプリカを `0` に設定してこれを実行します。	boolean

ingress

sslCiphers 任意	管理 Ingress 向けに有効になっている SSL 暗号のリスト。デフォルトは、対応している暗号の全リストです。	string

backup

minBackupPeriodSeconds 任意	(非推奨) 次のバックアップが発生するまでの最小の `MinBackupPeriodSeconds` を指定します。これは、レート制限バックアップに使用します。これにより、1 つのバックアップに複数の変更がまとめられる可能性があります。この期間に加えられた変更がキューに格納され、この期間が終了したらバックアップが行われるので、バックアップは失われません。	integer
velero 任意	(非推奨) Velero は Velero バックアップ統合の設定を指定します。	object

failedProvisionConfig

skipGatherLogs 任意	(非推奨) インストールに失敗した場合に、クラスターから全ログの収集を試行する機能を無効にします。ログは最長 7 日間永続ボリュームに保存されます。	boolean

status

components 任意	ステータス設定のコンポーネント。	object
conditions 任意	multicluster hub のさまざまな条件が含まれます。	conditions
desiredVersion 任意	必要なバージョンを指定します。	string
phase 任意	MultiClusterHub リソースのアクティブなフェーズを表します。このパラメーターに使用される値は、`Pending`、`Running`、`Installing`、`Updating`、`Uninstalling` です。	string

conditions

lastTransitionTime 任意	状態が別のステータスに最後に変わった時刻	string
lastUpdateTime 任意	この状態が最後に更新された時刻。	string
message 必須	メッセージは人間が判読できるメッセージで、最後にステータスが変更されたときの情報を指定します。	string
reason 必須	状態のステータスが変更された理由の簡単な説明	string
status 必須	状態のテータス。	string
type 必須	クラスターの状態のタイプ	string

StatusConditions

kind 必須	このステータスを表すリソースの `kind`	string
available 必須	このコンポーネントが適切に実行されているかどうかを示します。	boolean
lastTransitionTime 任意	状態が別のステータスに最後に変わった時刻	metav1.time
lastUpdateTime 任意	この状態が最後に更新された時刻。	metav1.time
message 必須	メッセージは人間が判読できるメッセージで、最後にステータスが変更されたときの情報を指定します。	string
reason 任意	状態のステータスが変更された理由の簡単な説明	string
status 任意	状態のテータス。	string
type 任意	クラスターの状態のタイプ	string

1.14. Placement API (v1beta1)

1.14.1. 概要

このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes の Placement リソースについて説明します。Placement リソースには、create、query、delete、update の 4 つのリクエストを使用できます。Placement は、placement namespace にバインドされている ManagedClusterSets から一連の ManagedClusters を選択するルールを定義します。ラベル cluster.open-cluster-management.io/placement={placement name} を持つ PlacementDecisions のスライスが作成され、この配置によって選択される ManagedClusters が表されます。

1.14.1.1. バージョン情報

バージョン: 2.10.0

1.14.1.2. URI スキーム

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

1.14.1.3. タグ

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

1.14.2. パス

1.14.2.1. 全 Placement のクエリー

GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placement

1.14.2.1.1. 説明

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

1.14.2.1.2. パラメーター

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

1.14.2.1.3. レスポンス

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

1.14.2.1.4. 消費されるアイテム

placement/yaml

1.14.2.1.5. タグ

cluster.open-cluster-management.io

1.14.2.2. Placement の作成

POST /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placements

1.14.2.2.1. 説明

Placement を作成します。

1.14.2.2.2. パラメーター

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

1.14.2.2.3. レスポンス

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

1.14.2.2.4. 消費されるアイテム

placement/yaml

1.14.2.2.5. タグ

cluster.open-cluster-management.io

1.14.2.2.6. HTTP リクエストの例

1.14.2.2.6.1. 要求の body

{
  "apiVersion" : "cluster.open-cluster-management.io/v1beta1",
  "kind" : "Placement",
  "metadata" : {
    "name" : "placement1",
    "namespace": "ns1"
  },
  "spec": {
    "predicates": [
      {
        "requiredClusterSelector": {
          "labelSelector": {
            "matchLabels": {
              "vendor": "OpenShift"
            }
          }
        }
      }
    ]
  },
  "status" : { }
}

1.14.2.3. 単一の Placement のクエリー

GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placements/{placement_name}

1.14.2.3.1. 説明

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

1.14.2.3.2. パラメーター

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

1.14.2.3.3. レスポンス

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

1.14.2.3.4. タグ

cluster.open-cluster-management.io

1.14.2.4. Placement の削除

DELETE /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placements/{placement_name}

1.14.2.4.1. 説明

単一の Placement を削除します。

1.14.2.4.2. パラメーター

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

1.14.2.4.3. レスポンス

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

1.14.2.4.4. タグ

cluster.open-cluster-management.io

1.14.3. 定義

1.14.3.1. Placement

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

spec

名前	説明	スキーマ
clusterSets 任意	`ManagedClusters` の選択元となる `ManagedClusterSets` のサブセット。`ManagedClusterSet` が空の場合、`ManagedClusters` は Placement namespace にバインドされている `ManagedClusterSets` から選択されます。`ManagedClusterSet` に `ManagedClusters` が含まれている場合、`ManagedClusters` はこのサブセットの交差部分から選択されます。選択された `ManagedClusterSets` は placement namespace にバインドされます。	string array
numberOfClusters 任意	選択する `ManagedClusters` の数。	integer (int32)
predicates 任意	`ManagedClusters` を選択するクラスター述語のサブセット。条件ロジックは OR です。	clusterPredicate アレイ
prioritizerPolicy 任意	プライオリタイザーのポリシー。	prioritizerPolicy
tolerations 任意	特定の Taint を持つマネージドクラスターが、一致する許容範囲を持つプレースメントによって選択されることを許可するが、必須ではない値。	toleration array

clusterPredicate

名前	説明	スキーマ
requiredClusterSelector 任意	ラベルおよびクラスター要求のある `ManagedClusters` を選択するクラスターセレクター。	clusterSelector

clusterSelector

名前	説明	スキーマ
labelSelector 任意	ラベル別の `ManagedClusters` のセレクター。	object
claimSelector 任意	要求別の `ManagedClusters` のセレクター。	clusterClaimSelector

clusterClaimSelector

名前	説明	スキーマ
matchExpressions 任意	クラスター要求セレクター要件のサブセット。条件ロジックは AND です。	< object > array

prioritizerPolicy

名前	説明	スキーマ
mode 任意	`Exact`、`Additive`、または "" のいずれか。"" のデフォルト値は `Additive` です。	string
configurations 任意	プライオリタイザーの設定。	prioritizerConfig array

prioritizerConfig

名前	説明	スキーマ
scoreCoordinate 必須	プライオリタイザーおよびスコアソースの設定。	scoreCoordinate
weight 任意	プライオリタイザースコアの重み。値は [-10,10] の範囲内である必要があります。	int32

scoreCoordinate

名前	説明	スキーマ
type 必須	プライオリタイザースコアのタイプ。有効な値は "BuiltIn" または "AddOn" です。	string
builtIn 任意	次のオプションからの `BuiltIn` プライオリタイザーの名前: 1) バランス: クラスター間の決定のバランスをとります。2) 安定: 既存の決定が安定していることを確認します。3) ResourceAllocatableCPU & ResourceAllocatableMemory: 割り当て可能なリソースに基づいてクラスターを分類します。4) 分散: ワークロードをトポロジーに均等に分散します。	string
addOn 任意	type が `AddOn` の場合、`AddOn` はリソース名とスコア名を定義します。	object

容認

名前	説明	スキーマ
key 任意	Toleration が適用される Taint キー。空は、すべての Taint キーに一致することを意味します。	string
operator 任意	キーと値の関係。有効な Operator は `Exists` および `Equal` です。デフォルト値は `Equal` です。	string
value 任意	Toleration に一致する Taint 値。	string
effect 任意	一致する Taint 効果。空は、すべての Taint 効果に一致することを意味します。指定した場合、許可される値は `NoSelect`、`PreferNoSelect`、および `NoSelectIfNew` です。	string
tolerationSeconds 任意	Taint が許容される時間の長さ。その後、Taint は許容されません。デフォルト値は nil です。これは、Taint が許容される期間に時間制限がないことを示します。	int64

1.15. PlacementDecisions API (v1beta1)

1.15.1. 概要

このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes の PlacementDecision リソースについて説明します。PlacementDecision リソースには、create、query、delete、update の 4 つのリクエストを使用できます。PlacementDecision は、プレースメントからの決定を示します。PlacementDecision は、ラベル cluster.open-cluster-management.io/placement={placement name} を使用して特定の配置を参照します。

1.15.1.1. バージョン情報

バージョン: 2.10.0

1.15.1.2. URI スキーム

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

1.15.1.3. タグ

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

1.15.2. パス

1.15.2.1. 全 PlacementDecision のクエリー

GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placementdecisions

1.15.2.1.1. 説明

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

1.15.2.1.2. パラメーター

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

1.15.2.1.3. レスポンス

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

1.15.2.1.4. 消費されるアイテム

placementdecision/yaml

1.15.2.1.5. タグ

cluster.open-cluster-management.io

1.15.2.2. PlacementDecision の作成

POST /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placementdecisions

1.15.2.2.1. 説明

PlacementDecision を作成します。

1.15.2.2.2. パラメーター

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

1.15.2.2.3. レスポンス

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

1.15.2.2.4. 消費されるアイテム

placementdecision/yaml

1.15.2.2.5. タグ

cluster.open-cluster-management.io

1.15.2.2.6. HTTP リクエストの例

1.15.2.2.6.1. 要求の body

{
  "apiVersion" : "cluster.open-cluster-management.io/v1beta1",
  "kind" : "PlacementDecision",
  "metadata" : {
    "labels" : {
      "cluster.open-cluster-management.io/placement" : "placement1"
    },
    "name" : "placement1-decision1",
    "namespace": "ns1"
  },
  "status" : { }
}

1.15.2.3. 単一の PlacementDecision のクエリー

GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placementdecisions/{placementdecision_name}

1.15.2.3.1. 説明

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

1.15.2.3.2. パラメーター

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

1.15.2.3.3. レスポンス

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

1.15.2.3.4. タグ

cluster.open-cluster-management.io

1.15.2.4. PlacementDecision の削除

DELETE /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placementdecisions/{placementdecision_name}

1.15.2.4.1. 説明

単一の PlacementDecision を削除します。

1.15.2.4.2. パラメーター

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

1.15.2.4.3. レスポンス

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

1.15.2.4.4. タグ

cluster.open-cluster-management.io

1.15.3. 定義

1.15.3.1. PlacementDecision

名前	説明	スキーマ
apiVersion 必須	`PlacementDecision` のバージョン管理されたスキーマ。	string
kind 必須	REST リソースを表す文字列の値	string
metadata 必須	`PlacementDecision` のメタデータ。	object
status 任意	`PlacementDecision` の現在のステータス。	PlacementStatus

PlacementStatus

名前	説明	スキーマ
Decisions 必須	プレースメントに応じた決定のスライス。	ClusterDecision array

ClusterDecision

名前	説明	スキーマ
clusterName 必須	`ManagedCluster` の名前。	string
reason 必須	`ManagedCluster` が選択されている理由。	string

1.16. DiscoveryConfig API

1.16.1. 概要

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

1.16.1.1. バージョン情報

バージョン: 2.10.0

1.16.1.2. URI スキーム

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

1.16.1.3. タグ

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

1.16.2. パス

1.16.2.1. DiscoveryConfig の作成

POST /app.k8s.io/v1/namespaces/{namespace}/discoveryconfigs

1.16.2.1.1. 説明

DiscoveryConfig を作成します。

1.16.2.1.2. パラメーター

型	名前	説明	スキーマ
Header	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	string
パス	namespace 必須	使用する namespace (例: default)	string
Body	body 必須	作成する DiscoveryConfig を記述するパラメーター。	DiscoveryConfig

1.16.2.1.3. レスポンス

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

1.16.2.1.4. 消費されるアイテム

discoveryconfigs/yaml

1.16.2.1.5. タグ

discoveryconfigs.discovery.open-cluster-management.io

1.16.2.1.5.1. 要求の body

{
  "apiVersion": "apiextensions.k8s.io/v1",
  "kind": "CustomResourceDefinition",
  "metadata": {
    "annotations": {
      "controller-gen.kubebuilder.io/version": "v0.4.1",
    },
    "creationTimestamp": null,
    "name": "discoveryconfigs.discovery.open-cluster-management.io",
  },
  "spec": {
    "group": "discovery.open-cluster-management.io",
    "names": {
      "kind": "DiscoveryConfig",
      "listKind": "DiscoveryConfigList",
      "plural": "discoveryconfigs",
      "singular": "discoveryconfig"
    },
    "scope": "Namespaced",
    "versions": [
      {
        "name": "v1",
        "schema": {
          "openAPIV3Schema": {
            "description": "DiscoveryConfig is the Schema for the discoveryconfigs API",
            "properties": {
              "apiVersion": {
                "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
                "type": "string"
              },
              "kind": {
                "description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
                "type": "string"
              },
              "metadata": {
                "type": "object"
              },
              "spec": {
                "description": "DiscoveryConfigSpec defines the desired state of DiscoveryConfig",
                "properties": {
                  "credential": {
                    "description": "Credential is the secret containing credentials to connect to the OCM api on behalf of a user",
                    "type": "string"
                  },
                  "filters": {
                    "description": "Sets restrictions on what kind of clusters to discover",
                    "properties": {
                      "lastActive": {
                        "description": "LastActive is the last active in days of clusters to discover, determined by activity timestamp",
                        "type": "integer"
                      },
                      "openShiftVersions": {
                        "description": "OpenShiftVersions is the list of release versions of OpenShift of the form \"<Major>.<Minor>\"",
                        "items": {
                          "description": "Semver represents a partial semver string with the major and minor version in the form \"<Major>.<Minor>\". For example: \"4.13\"",
                          "pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
                          "type": "string"
                        },
                        "type": "array"
                      }
                    },
                    "type": "object"
                  }
                },
                "required": [
                  "credential"
                ],
                "type": "object"
              },
              "status": {
                "description": "DiscoveryConfigStatus defines the observed state of DiscoveryConfig",
                "type": "object"
              }
            },
            "type": "object"
          }
        },
        "served": true,
        "storage": true,
        "subresources": {
          "status": {}
        }
      }
    ]
  },
  "status": {
    "acceptedNames": {
      "kind": "",
      "plural": ""
    },
    "conditions": [],
    "storedVersions": []
  }
}

1.16.2.2. すべての DiscoveryConfigs のクエリー

GET /operator.open-cluster-management.io/v1/namespaces/{namespace}/operator

1.16.2.2.1. 説明

discovery config 演算子に対してクエリーを実行して詳細を確認します。

1.16.2.2.2. パラメーター

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

1.16.2.2.3. レスポンス

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

1.16.2.2.4. 消費されるアイテム

operator/yaml

1.16.2.2.5. タグ

discoveryconfigs.discovery.open-cluster-management.io

1.16.2.3. DiscoveryConfig 演算子の削除

DELETE /operator.open-cluster-management.io/v1/namespaces/{namespace}/operator/{discoveryconfigs_name}

1.16.2.3.1. パラメーター

型	名前	説明	スキーマ
Header	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	string
パス	application_name 必須	削除する Discovery Config 演算子の名前。	string
パス	namespace 必須	使用する namespace (例: default)	string

1.16.2.3.2. レスポンス

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

1.16.2.3.3. タグ

discoveryconfigs.operator.open-cluster-management.io

1.16.3. 定義

1.16.3.1. DiscoveryConfig

名前	説明	スキーマ
apiVersion 必須	discoveryconfigs のバージョンスキーマ。	string
kind 必須	REST リソースを表す文字列の値	string
metadata 必須	リソースを定義するルールを記述します。	object
spec 必須	DiscoveryConfig の必要な状態を定義します。	仕様のリストを参照してください。

1.16.3.2. 仕様のリスト

名前	説明	スキーマ
credential 必須	credential は、ユーザーの代わりに OCM API に接続するための認証情報が含まれるシークレットです。	string
filters 任意	検出するクラスターの種類に制限を設定します。	フィルターの一覧を参照してください。

1.16.3.3. フィルターのリスト

名前	説明	スキーマ
lastActive 必須	lastActive は、検出するクラスターの最後のアクティブ日数で、アクティビティーのタイムスタンプによって決定されます。	integer
openShiftVersions 任意	openShiftVersions は、OpenShift のリリースバージョン ("<Major>.<Minor>" 形式) のリストです。	object

1.17. DiscoveredCluster API

1.17.1. 概要

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

1.17.1.1. バージョン情報

バージョン: 2.10.0

1.17.1.2. URI スキーム

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

1.17.1.3. タグ

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

1.17.2. パス

1.17.2.1. DiscoveredCluster の作成

POST /app.k8s.io/v1/namespaces/{namespace}/discoveredclusters

1.17.2.1.1. 説明

DiscoveredCluster を作成します。

1.17.2.1.2. パラメーター

型	名前	説明	スキーマ
Header	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	string
パス	namespace 必須	使用する namespace (例: default)	string
Body	body 必須	作成する DiscoveredCluster を記述するパラメーター。	DiscoveredCluster

1.17.2.1.3. レスポンス

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

1.17.2.1.4. 消費されるアイテム

discoveredclusters/yaml

1.17.2.1.5. タグ

discoveredclusters.discovery.open-cluster-management.io

1.17.2.1.5.1. 要求の body

{
  "apiVersion": "apiextensions.k8s.io/v1",
  "kind": "CustomResourceDefinition",
  "metadata": {
    "annotations": {
      "controller-gen.kubebuilder.io/version": "v0.4.1",\
    },
    "creationTimestamp": null,
    "name": "discoveredclusters.discovery.open-cluster-management.io",
  },
  "spec": {
    "group": "discovery.open-cluster-management.io",
    "names": {
      "kind": "DiscoveredCluster",
      "listKind": "DiscoveredClusterList",
      "plural": "discoveredclusters",
      "singular": "discoveredcluster"
    },
    "scope": "Namespaced",
    "versions": [
      {
        "name": "v1",
        "schema": {
          "openAPIV3Schema": {
            "description": "DiscoveredCluster is the Schema for the discoveredclusters API",
            "properties": {
              "apiVersion": {
                "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
                "type": "string"
              },
              "kind": {
                "description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
                "type": "string"
              },
              "metadata": {
                "type": "object"
              },
              "spec": {
                "description": "DiscoveredClusterSpec defines the desired state of DiscoveredCluster",
                "properties": {
                  "activityTimestamp": {
                    "format": "date-time",
                    "type": "string"
                  },
                  "apiUrl": {
                    "type": "string"
                  },
                  "cloudProvider": {
                    "type": "string"
                  },
                  "console": {
                    "type": "string"
                  },
                  "creationTimestamp": {
                    "format": "date-time",
                    "type": "string"
                  },
                  "credential": {
                    "description": "ObjectReference contains enough information to let you inspect or modify the referred object. --- New uses of this type are discouraged because of difficulty describing its usage when embedded in APIs.  1. Ignored fields.  It includes many fields which are not generally honored.  For instance, ResourceVersion and FieldPath are both very rarely valid in actual usage.  2. Invalid usage help.  It is impossible to add specific help for individual usage.  In most embedded usages, there are particular     restrictions like, \"must refer only to types A and B\" or \"UID not honored\" or \"name must be restricted\".     Those cannot be well described when embedded.  3. Inconsistent validation.  Because the usages are different, the validation rules are different by usage, which makes it hard for users to predict what will happen.  4. The fields are both imprecise and overly precise.  Kind is not a precise mapping to a URL. This can produce ambiguity     during interpretation and require a REST mapping.  In most cases, the dependency is on the group,resource tuple     and the version of the actual struct is irrelevant.  5. We cannot easily change it.  Because this type is embedded in many locations, updates to this type     will affect numerous schemas.  Don't make new APIs embed an underspecified API type they do not control. Instead of using this type, create a locally provided and used type that is well-focused on your reference. For example, ServiceReferences for admission registration: https://github.com/kubernetes/api/blob/release-1.17/admissionregistration/v1/types.go#L533 .",
                    "properties": {
                      "apiVersion": {
                        "description": "API version of the referent.",
                        "type": "string"
                      },
                      "fieldPath": {
                        "description": "If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: \"spec.containers{name}\" (where \"name\" refers to the name of the container that triggered the event) or if no container name is specified \"spec.containers[2]\" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future.",
                        "type": "string"
                      },
                      "kind": {
                        "description": "Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
                        "type": "string"
                      },
                      "name": {
                        "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
                        "type": "string"
                      },
                      "namespace": {
                        "description": "Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/",
                        "type": "string"
                      },
                      "resourceVersion": {
                        "description": "Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency",
                        "type": "string"
                      },
                      "uid": {
                        "description": "UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids",
                        "type": "string"
                      }
                    },
                    "type": "object"
                  },
                  "displayName": {
                    "type": "string"
                  },
                  "isManagedCluster": {
                    "type": "boolean"
                  },
                  "name": {
                    "type": "string"
                  },
                  "openshiftVersion": {
                    "type": "string"
                  },
                  "status": {
                    "type": "string"
                  },
                  "type": {
                    "type": "string"
                  }
                },
                "required": [
                  "apiUrl",
                  "displayName",
                  "isManagedCluster",
                  "name",
                  "type"
                ],
                "type": "object"
              },
              "status": {
                "description": "DiscoveredClusterStatus defines the observed state of DiscoveredCluster",
                "type": "object"
              }
            },
            "type": "object"
          }
        },
        "served": true,
        "storage": true,
        "subresources": {
          "status": {}
        }
      }
    ]
  },
  "status": {
    "acceptedNames": {
      "kind": "",
      "plural": ""
    },
    "conditions": [],
    "storedVersions": []
  }
}

1.17.2.2. すべての DiscoveredClusters のクエリー

GET /operator.open-cluster-management.io/v1/namespaces/{namespace}/operator

1.17.2.2.1. 説明

discovered clusters 演算子に対してクエリーを実行して詳細を確認します。

1.17.2.2.2. パラメーター

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

1.17.2.2.3. レスポンス

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

1.17.2.2.4. 消費されるアイテム

operator/yaml

1.17.2.2.5. タグ

discoveredclusters.discovery.open-cluster-management.io

1.17.2.3. DiscoveredCluster 演算子の削除

DELETE /operator.open-cluster-management.io/v1/namespaces/{namespace}/operator/{discoveredclusters_name}

1.17.2.3.1. パラメーター

型	名前	説明	スキーマ
Header	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	string
パス	application_name 必須	削除する Discovered Cluster 演算子の名前。	string
パス	namespace 必須	使用する namespace (例: default)	string

1.17.2.3.2. レスポンス

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

1.17.2.3.3. タグ

discoveredclusters.operator.open-cluster-management.io

1.17.3. 定義

1.17.3.1. DiscoveredCluster

名前	説明	スキーマ
apiVersion 必須	discoveredclusters のバージョンスキーマ。	string
kind 必須	REST リソースを表す文字列の値	string
metadata 必須	リソースを定義するルールを記述します。	object
spec 必須	DiscoveredClusterSpec は、DiscoveredCluster の必要な状態を定義します。	仕様のリストを参照してください。

1.17.3.2. 仕様のリスト

名前	説明	スキーマ
activityTimestamp 任意	Discoveredclusters 最後に利用可能なアクティビティータイムスタンプ。	metav1.time
apiUrl 必須	Discoveredclusters API URL エンドポイント。	string
cloudProvider 任意	discoveredcluster のクラウドプロバイダー。	string
console 任意	Discoveredclusters コンソール URL エンドポイント。	string
creationTimestamp 任意	Discoveredclusters 作成タイプスタンプ。	metav1.time
credential 任意	クラスターが検出された認証情報への参照。	corev1.ObjectReference
displayName 必須	検出されたクラスターの表示名。	string
isManagedCluster 必須	true の場合、クラスターは ACM によって管理されます。	boolean
name 必須	検出されたクラスターの名前。	string
openshiftVersion 任意	検出されたクラスターの OpenShift バージョン。	string
status 任意	検出されたクラスターのステータス。	string
type 必須	OpenShift フレーバー (例:OCP、ROSA など)。	string

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. バージョン情報

バージョン: 2.10.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

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

spec

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

customizedVariable

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

nodePlacement

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

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. バージョン情報

バージョン: 2.10.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

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

spec

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

addOnMeta

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

configMeta

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

configReferent

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

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.10.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

名前	説明	スキーマ
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

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

1.21. ManagedClusterSet API (v1beta2)

1.21.1. 概要

このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes の ManagedClusterSet リソースについて説明します。ManagedClusterSet リソースには、create、query、delete、update の 4 つの要求を使用できます。ManagedClusterSet は、2 つ以上のマネージドクラスターを 1 つのセットにグループ化し、一緒に操作できるようにします。セットに属するマネージドクラスターは、使用目的の共有や同じデプロイメントリージョンなど、同様の属性を持つことができます。

1.21.1.1. バージョン情報

バージョン: 2.10.0

1.21.1.2. URI スキーム

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

1.21.1.3. タグ

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

1.21.2. パス

1.21.2.1. すべての managedclusterset のクエリー

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

1.21.2.1.1. 説明

詳細は、managedclustersets をクエリーしてください。

1.21.2.1.2. パラメーター

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

1.21.2.1.3. レスポンス

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

1.21.2.1.4. 消費されるアイテム

managedclusterset/yaml

1.21.2.1.5. タグ

cluster.open-cluster-management.io

1.21.2.2. managedclusterset の作成

POST /cluster.open-cluster-management.io/v1beta2/namespaces/{namespace}/managedclustersets

1.21.2.2.1. 説明

managedclusterset を作成します。

1.21.2.2.2. パラメーター

型	名前	説明	スキーマ
Header	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	string
パス	namespace 必須	使用する namespace (例: `default`)	string
Body	body 必須	作成する managedclusterset を記述するパラメーター。	Managedclusterset

1.21.2.2.3. レスポンス

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

1.21.2.2.4. 消費されるアイテム

managedclusterset/yaml

1.21.2.2.5. タグ

cluster.open-cluster-management.io

1.21.2.2.6. HTTP リクエストの例

1.21.2.2.6.1. 要求の body

{
  "apiVersion" : "cluster.open-cluster-management.io/v1beta2",
  "kind" : "ManagedClusterSet",
  "metadata" : {
    "name" : "example-clusterset",
  },
 "spec": {
  },
  "status" : { }
}

1.21.2.3. 単一の managedclusterset のクエリー

GET /cluster.open-cluster-management.io/v1beta2/namespaces/{namespace}/managedclustersets/{managedclusterset_name}

1.21.2.3.1. 説明

詳細は、単一の managedclusterset をクエリーしてください。

1.21.2.3.2. パラメーター

型	名前	説明	スキーマ
Header	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	string
パス	namespace 必須	使用する namespace (例: `default`)	string
パス	managedclusterset_name 必須	クエリーを行う managedclusterset の名前。	string

1.21.2.3.3. レスポンス

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

1.21.2.3.4. タグ

cluster.open-cluster-management.io

1.21.2.4. managedclusterset の削除

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

1.21.2.4.1. 説明

単一の managedclusterset を削除します。

1.21.2.4.2. パラメーター

型	名前	説明	スキーマ
Header	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	string
パス	namespace 必須	使用する namespace (例: `default`)	string
パス	managedclusterset_name 必須	削除する managedclusterset の名前。	string

1.21.2.4.3. レスポンス

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

1.21.2.4.4. タグ

cluster.open-cluster-management.io

1.21.3. 定義

1.21.3.1. ManagedClusterSet

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

1.22. KlusterletConfig API (v1alpha1)

1.22.1. 概要

このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes の KlusterletConfig リソースについて説明します。KlusterletConfig リソースには、create、query、delete、update の 4 つの要求を使用できます。KlusterletConfig には、nodeSelector、tolerations、および pullSecret などの klusterlet 設定情報が含まれます。KlusterletConfig はクラスタースコープのリソースで、open-cluster-managemnet-agent namespace 内の klusterlet Pod でのみ機能します。KlusterletConfig は、アドオンのデプロイメント設定には影響しません。

1.22.1.1. バージョン情報

バージョン: 2.10.0

1.22.1.2. URI スキーム

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

1.22.1.3. タグ

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

1.22.2. パス

1.22.2.1. 全 KlusterletConfig のクエリー

GET /config.open-cluster-management.io/v1alpha1/namespaces/{namespace}/klusterletconfigs

1.22.2.1.1. 説明

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

1.22.2.1.2. パラメーター

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

1.22.2.1.3. レスポンス

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

1.22.2.1.4. 消費されるアイテム

klusterletconfig/yaml

1.22.2.1.5. タグ

config.open-cluster-management.io

1.22.2.2. KlusterletConfig を作成します。

POST /config.open-cluster-management.io/v1alpha1/namespaces/{namespace}/klusterletconfigs

1.22.2.2.1. 説明

KlusterletConfig を作成します。

1.22.2.2.2. パラメーター

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

1.22.2.2.3. レスポンス

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

1.22.2.2.4. 消費されるアイテム

klusterletconfig/yaml

1.22.2.2.5. タグ

config.open-cluster-management.io

1.22.2.2.6. HTTP リクエストの例

1.22.2.2.6.1. 要求の body

{
  "apiVersion": "apiextensions.k8s.io/v1",
  "kind": "CustomResourceDefinition",
  "metadata": {
    "annotations": {
      "controller-gen.kubebuilder.io/version": "v0.7.0"
    },
    "creationTimestamp": null,
    "name": "klusterletconfigs.config.open-cluster-management.io"
  },
  "spec": {
    "group": "config.open-cluster-management.io",
    "names": {
      "kind": "KlusterletConfig",
      "listKind": "KlusterletConfigList",
      "plural": "klusterletconfigs",
      "singular": "klusterletconfig"
    },
    "preserveUnknownFields": false,
    "scope": "Cluster",
    "versions": [
      {
        "name": "v1alpha1",
        "schema": {
          "openAPIV3Schema": {
            "description": "KlusterletConfig contains the configuration of a klusterlet including the upgrade strategy, config overrides, proxy configurations etc.",
            "properties": {
              "apiVersion": {
                "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
                "type": "string"
              },
              "kind": {
                "description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
                "type": "string"
              },
              "metadata": {
                "type": "object"
              },
              "spec": {
                "description": "Spec defines the desired state of KlusterletConfig",
                "properties": {
                  "hubKubeAPIServerProxyConfig": {
                    "description": "HubKubeAPIServerProxyConfig holds proxy settings for connections between klusterlet/add-on agents on the managed cluster and the kube-apiserver on the hub cluster. Empty means no proxy settings is available.",
                    "properties": {
                      "caBundle": {
                        "description": "CABundle is a CA certificate bundle to verify the proxy server. It will be ignored if only HTTPProxy is set; And it is required when HTTPSProxy is set and self signed CA certificate is used by the proxy server.",
                        "format": "byte",
                        "type": "string"
                      },
                      "httpProxy": {
                        "description": "HTTPProxy is the URL of the proxy for HTTP requests",
                        "type": "string"
                      },
                      "httpsProxy": {
                        "description": "HTTPSProxy is the URL of the proxy for HTTPS requests HTTPSProxy will be chosen if both HTTPProxy and HTTPSProxy are set.",
                        "type": "string"
                      }
                    },
                    "type": "object"
                  },
                  "nodePlacement": {
                    "description": "NodePlacement enables explicit control over the scheduling of the agent components. If the placement is nil, the placement is not specified, it will be omitted. If the placement is an empty object, the placement will match all nodes and tolerate nothing.",
                    "properties": {
                      "nodeSelector": {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "description": "NodeSelector defines which Nodes the Pods are scheduled on. The default is an empty list.",
                        "type": "object"
                      },
                      "tolerations": {
                        "description": "Tolerations is attached by pods to tolerate any taint that matches the triple <key,value,effect> using the matching operator <operator>. The default is an empty list.",
                        "items": {
                          "description": "The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.",
                          "properties": {
                            "effect": {
                              "description": "Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.",
                              "type": "string"
                            },
                            "key": {
                              "description": "Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.",
                              "type": "string"
                            },
                            "operator": {
                              "description": "Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.",
                              "type": "string"
                            },
                            "tolerationSeconds": {
                              "description": "TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.",
                              "format": "int64",
                              "type": "integer"
                            },
                            "value": {
                              "description": "Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.",
                              "type": "string"
                            }
                          },
                          "type": "object"
                        },
                        "type": "array"
                      }
                    },
                    "type": "object"
                  },
                  "pullSecret": {
                    "description": "PullSecret is the name of image pull secret.",
                    "properties": {
                      "apiVersion": {
                        "description": "API version of the referent.",
                        "type": "string"
                      },
                      "fieldPath": {
                        "description": "If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: \"spec.containers{name}\" (where \"name\" refers to the name of the container that triggered the event) or if no container name is specified \"spec.containers[2]\" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future.",
                        "type": "string"
                      },
                      "kind": {
                        "description": "Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
                        "type": "string"
                      },
                      "name": {
                        "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
                        "type": "string"
                      },
                      "namespace": {
                        "description": "Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/",
                        "type": "string"
                      },
                      "resourceVersion": {
                        "description": "Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency",
                        "type": "string"
                      },
                      "uid": {
                        "description": "UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids",
                        "type": "string"
                      }
                    },
                    "type": "object"
                  },
                  "registries": {
                    "description": "Registries includes the mirror and source registries. The source registry will be replaced by the Mirror.",
                    "items": {
                      "properties": {
                        "mirror": {
                          "description": "Mirror is the mirrored registry of the Source. Will be ignored if Mirror is empty.",
                          "type": "string"
                        },
                        "source": {
                          "description": "Source is the source registry. All image registries will be replaced by Mirror if Source is empty.",
                          "type": "string"
                        }
                      },
                      "required": [
                        "mirror"
                      ],
                      "type": "object"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              },
              "status": {
                "description": "Status defines the observed state of KlusterletConfig",
                "type": "object"
              }
            },
            "type": "object"
          }
        },
        "served": true,
        "storage": true,
        "subresources": {
          "status": {}
        }
      }
    ]
  },
  "status": {
    "acceptedNames": {
      "kind": "",
      "plural": ""
    },
    "conditions": [],
    "storedVersions": []
  }
}

1.22.2.3. 単一の KlusterletConfig のクエリー

GET /config.open-cluster-management.io/v1alpha1/namespaces/{namespace}/klusterletconfigs/{klusterletconfig_name}

1.22.2.3.1. 説明

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

1.22.2.3.2. パラメーター

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

1.22.2.3.3. レスポンス

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

1.22.2.3.4. タグ

config.open-cluster-management.io

1.22.2.4. KlusterletConfig の削除

DELETE /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/klusterletconfigs/{klusterletconfig_name}

1.22.2.4.1. 説明

単一の klusterletconfig を削除します。

1.22.2.4.2. パラメーター

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

1.22.2.4.3. レスポンス

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

1.22.2.4.4. タグ

config.open-cluster-management.io

1.22.3. 定義

1.22.3.1. KlusterletConfig

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

spec

名前	説明	スキーマ
registries 任意	ミラーおよびソースレジストリーが含まれます。ソースレジストリーはミラーに置き換えられます。	registry
pullSecret 任意	イメージプルシークレットの名前。	object
nodePlacement 必須	マネージドクラスターでアドオンエージェントのスケジューリング制御を有効にします。	nodePlacement
hubKubeAPIServerProxyConfig 必須	マネージドクラスターの klusterlet またはアドオンエージェントとハブクラスターの kube-apiserver 間の接続のプロキシー設定が含まれています。空白は、使用できるプロキシー設定がないことを意味します。	kubeAPIServerProxyConfig

nodePlacement

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

kubeAPIServerProxyConfig

名前	説明	スキーマ
caBundle 任意	プロキシーサーバーを検証するための CA 証明書バンドルです。HTTPProxy のみが設定されている場合、バンドルは無視されます。このバンドルは、HTTPSProxy が設定され、自己署名 CA 証明書がプロキシーサーバーによって使用される場合に必要になります。	map[string]string
httpProxy 任意	HTTP リクエストのプロキシーの URL	map[string]string
httpsProxy 任意	HTTPS 要求のプロキシーの URL。HTTPProxy および HTTPSProxy の両方が設定されている場合は、HTTPSProxy が選択されます。	map[string]string

1.23. ポリシーコンプライアンス履歴 (テクノロジープレビュー)

1.23.1. 概要

ポリシーコンプライアンス履歴 API は、Red Hat Advanced Cluster Management for Kubernetes のポリシーコンプライアンスイベントをクエリー可能な形式で長期間保存する場合に使用できる、オプションのテクニカルプレビュー機能です。この API を使用すると、spec フィールドなどの追加の詳細を取得して、ポリシーを監査およびトラブルシューティングすることができます。また、ポリシーが無効化されたりクラスターから削除されたりしたときに、コンプライアンスイベントを取得できます。ポリシーコンプライアンス履歴 API は、監査とトラブルシューティングに役立つ、ポリシーコンプライアンスイベントのコンマ区切り値 (CSV) スプレッドシートを生成することもできます。

1.23.1.1. バージョン情報

バージョン: 2.10.0

1.23.2. API エンドポイント

1.23.2.1. ポリシーコンプライアンスイベントのリスト表示

/api/v1/compliance-events

これには、デフォルトでアクセスできるすべてのポリシーコンプライアンスイベントがリスト表示されます。レスポンスの形式は次のとおりです。デフォルトでは、event.timestamp によって降順に並べ替えられます。

{
  "data": [
    {
      "id": 2,
      "cluster": {
        "name": "cluster1",
        "cluster_id": "215ce184-8dee-4cab-b99b-1f8f29dff611"
      },
      "parent_policy": {
        "id": 3,
        "name": "configure-custom-app",
        "namespace": "policies",
        "catageories": ["CM Configuration Management"],
        "controls": ["CM-2 Baseline Configuration"],
        "standards": ["NIST SP 800-53"]
      },
      "policy": {
        "apiGroup": "policy.open-cluster-management.io",
        "id": 2,
        "kind": "ConfigurationPolicy",
        "name": "configure-custom-app",
        "namespace": "",
        // Only shown with `?include_spec`
        "spec": {}
      },
      "event": {
        "compliance": "NonCompliant",
        "message": "configmaps [app-data] not found in namespace default",
        "timestamp": "2023-07-19T18:25:43.511Z",
        "metadata": {}
      }
    },
    {
      "id": 1,
      "cluster": {
        "name": "cluster2",
        "cluster_id": "415ce234-8dee-4cab-b99b-1f8f29dff461"
      },
      "parent_policy": {
        "id": 3,
        "name": "configure-custom-app",
        "namespace": "policies",
        "catageories": ["CM Configuration Management"],
        "controls": ["CM-2 Baseline Configuration"],
        "standards": ["NIST SP 800-53"]
      },
      "policy": {
        "apiGroup": "policy.open-cluster-management.io",
        "id": 4,
        "kind": "ConfigurationPolicy",
        "name": "configure-custom-app",
        "namespace": "",
        // Only shown with `?include_spec`
        "spec": {}
      },
      "event": {
        "compliance": "Compliant",
        "message": "configmaps [app-data] found as specified in namespace default",
        "timestamp": "2023-07-19T18:25:41.523Z",
        "metadata": {}
      }
    }
  ],
  "metadata": {
    "page": 1,
    "pages": 7,
    "per_page": 20,
    "total": 123
  }
}

次のオプションのクエリーパラメーターを使用できます。説明のないものは、参照するフィールドをフィルターするだけであることに注意してください。パラメーター値 null は、値がないことを示します。さらに、コンマを使用して複数の値を指定できます。たとえば、"or" 条件でフィルタリングする場合は ??cluster.name=cluster1,cluster2 とします。必要に応じて、コンマを \ でエスケープできます。

表1.1 クエリーパラメーターの表
クエリー引数	説明
cluster.cluster_id
cluster.name
direction	並べ替えの基準となる方向。デフォルトは、降順を表す `desc` です。サポートされている値は `asc` と `desc` です。
event.compliance
event.message_includes	入力文字列を含むコンプライアンスメッセージのフィルター。サポートされる値は 1 つだけです。
event.message_like	コンプライアンスメッセージの SQL `LIKE` フィルター。パーセント記号 (`%`) は、0 個以上の文字のワイルドカードを表します。アンダースコア記号 (`_`) は、1 文字のワイルドカードを表します。たとえば、`%configmaps [%my-configmap%]%` は、config map `my-configmap` を参照する設定ポリシーコンプライアンスメッセージに一致します。
event.reported_by
event.timestamp
event.timestamp_after	RFC 3339 タイムスタンプ。この時刻以降のコンプライアンスイベントのみを表示することを示します。たとえば、`2024-02-28T16:32:57Z` です。
event.timestamp_before	RFC 3339 タイムスタンプ。この時刻以前のコンプライアンスイベントのみを表示することを示します。たとえば、`2024-02-28T16:32:57Z` です。
id
include_spec	戻り値にポリシーの `spec` フィールドを含めるフラグ。これはデフォルトでは設定されません。
page	クエリー内のページ番号。デフォルトは `1` です。
parent_policy.categories
parent_policy.controls
parent_policy.id
parent_policy.name
parent_policy.namespace
parent_policy.standards
per_page	ページごとに返されるコンプライアンスイベントの数。デフォルトは `20` で、`100` より大きくすることはできません。
policy.apiGroup
policy.id
policy.kind
policy.name
policy.namespace
policy.severity
sort	並べ替えに使用するフィールド。デフォルトは `event.timestamp` です。`policy.spec` と `event.metadata` を除くすべてのフィールドは、ドット表記を使用して並べ替えることができます。複数の並べ替えオプションを指定するには、`?sort=policy.name,policy.namespace` のようにコンマを使用します。

1.23.2.2. 単一のポリシーコンプライアンスイベントの選択

/api/v1/compliance-events/<id>

データベース ID を指定して、単一のポリシーコンプライアンスイベントを選択できます。たとえば、/api/v1/compliance-events/1 は、ID が 1 のコンプライアンスイベントを選択します。戻り値は次の JSON 形式です。

{
  "id": 1,
  "cluster": {
    "name": "cluster2",
    "cluster_id": "415ce234-8dee-4cab-b99b-1f8f29dff461"
  },
  "parent_policy": {
    "id": 2,
    "name": "etcd-encryption",
    "namespace": "policies",
    "catageories": ["CM Configuration Management"],
    "controls": ["CM-2 Baseline Configuration"],
    "standards": ["NIST SP 800-53"]
  },
  "policy": {
    "apiGroup": "policy.open-cluster-management.io",
    "id": 4,
    "kind": "ConfigurationPolicy",
    "name": "etcd-encryption",
    "namespace": "",
    "spec": {}
  },
  "event": {
    "compliance": "Compliant",
    "message": "configmaps [app-data] found as specified in namespace default",
    "timestamp": "2023-07-19T18:25:41.523Z",
    "metadata": {}
  }
}

1.23.2.3. スプレッドシートの生成

/api/v1/reports/compliance-events

監査とトラブルシューティングのために、コンプライアンスイベントのコンマ区切り値 (CSV) スプレッドシートを生成できます。この API エンドポイントは、/api/v1/compliance-events API エンドポイントと同じ結果を出力し、同じクエリー引数を受け入れます。デフォルトでは、per_page 制限は設定されておらず、per_page クエリー引数の最大値もありません。すべての CSV ヘッダーは /api/v1/compliance-events API エンドポイントと同じですが、JSON オブジェクトはアンダースコアで区切られています。たとえば、イベントのタイムスタンプのヘッダーは event_timestamp となります。

1.23.3. 認証および承認

ポリシーコンプライアンス履歴 API は、認証と認可のために Red Hat Advanced Cluster Management ハブクラスターが使用する OpenShift インスタンスを利用します。HTTPS リクエストの Authorization ヘッダーに、OpenShift トークンを指定する必要があります。

トークンを見つけるには、次のコマンドを実行します。

oc whoami --show-token

1.23.3.1. コンプライアンスイベントの表示

マネージドクラスターのコンプライアンスイベントを表示するには、Red Hat Advanced Cluster Management ハブクラスターの ManagedCluster オブジェクトに対する get verb を完了するためのアクセスが必要です。たとえば、local-cluster クラスターのコンプライアンスイベントを表示するには、open-cluster-management:view:local-cluster ClusterRole を使用するか、次の例のように独自のリソースを作成します。

apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
 name: local-cluster-view
rules:
- apiGroups:
 - cluster.open-cluster-management.io
 resources:
 - managedclusters
 resourceNames:
 - local-cluster
 verbs:
 - get

特定のマネージドクラスターへのアクセスを確認するには、oc auth can-i コマンドを使用します。たとえば、local-cluster マネージドクラスターにアクセスできるかどうかを確認するには、次のコマンドを実行します。

oc auth can-i get managedclusters.cluster.open-cluster-management.io/local-cluster

1.23.3.2. コンプライアンスイベントの記録

対応するマネージドクラスター namespace の policies.policy.open-cluster-management.io/status リソースで patch verb アクセスを持つユーザーまたはサービスアカウントには、ポリシーコンプライアンスイベントを記録するためのアクセスがあります。マネージドクラスターの governance-policy-framework Pod は、Red Hat Advanced Cluster Management ハブクラスターの対応するマネージドクラスター namespace の open-cluster-management-compliance-history-api-recorder サービスアカウントを使用して、コンプライアンスイベントを記録します。各サービスアカウントには、マネージドクラスター namespace にバインドされた open-cluster-management:compliance-history-api-recorder ClusterRole があります。ユーザーおよびサービスアカウントの patch 動詞によるポリシー status へのアクセスを制限し、ポリシーコンプライアンス履歴 API に保存されているデータの信頼性を確保します。

API

第1章 API

1.1. Clusters API

1.1.1. 概要

1.1.1.1. バージョン情報

1.1.1.2. URI スキーム

1.1.1.3. タグ

1.1.2. パス

1.1.2.1. 全クラスターのクエリー

1.1.2.1.1. 説明

1.1.2.1.2. パラメーター

1.1.2.1.3. レスポンス

1.1.2.1.4. 消費されるアイテム

1.1.2.1.5. タグ

1.1.2.2. クラスターの作成

1.1.2.2.1. 説明

1.1.2.2.2. パラメーター

1.1.2.2.3. レスポンス

1.1.2.2.4. 消費されるアイテム

1.1.2.2.5. タグ

1.1.2.2.6. HTTP リクエストの例

1.1.2.2.6.1. 要求の body

1.1.2.3. 単一クラスターのクエリー

1.1.2.3.1. 説明

1.1.2.3.2. パラメーター

1.1.2.3.3. レスポンス

1.1.2.3.4. タグ

1.1.2.4. クラスターの削除

1.1.2.4.1. 説明

1.1.2.4.2. パラメーター

1.1.2.4.3. レスポンス

1.1.2.4.4. タグ

1.1.3. 定義

1.1.3.1. クラスター

1.2. Clustersets API (v1beta2)

1.2.1. 概要

1.2.1.1. バージョン情報

1.2.1.2. URI スキーム

1.2.1.3. タグ

1.2.2. パス

1.2.2.1. 全 clusterset のクエリー

1.2.2.1.1. 説明

1.2.2.1.2. パラメーター

1.2.2.1.3. レスポンス

1.2.2.1.4. 消費されるアイテム

1.2.2.1.5. タグ

1.2.2.2. clusterset の作成

1.2.2.2.1. 説明

1.2.2.2.2. パラメーター

1.2.2.2.3. レスポンス

1.2.2.2.4. 消費されるアイテム

1.2.2.2.5. タグ

1.2.2.2.6. HTTP リクエストの例

1.2.2.2.6.1. 要求の body

1.2.2.3. 単一 clusterset のクエリー

1.2.2.3.1. 説明

1.2.2.3.2. パラメーター

1.2.2.3.3. レスポンス

1.2.2.3.4. タグ

1.2.2.4. clusterset の削除

1.2.2.4.1. 説明

1.2.2.4.2. パラメーター

1.2.2.4.3. レスポンス

1.2.2.4.4. タグ

1.2.3. 定義

1.2.3.1. Clusterset

1.3. Clustersetbindings API (v1beta2)

1.3.1. 概要

1.3.1.1. バージョン情報

1.3.1.2. URI スキーム

1.3.1.3. タグ

1.3.2. パス

1.3.2.1. 全 clustersetbinding のクエリー

1.3.2.1.1. 説明

1.3.2.1.2. パラメーター

1.3.2.1.3. レスポンス

1.3.2.1.4. 消費されるアイテム

1.3.2.1.5. タグ

1.3.2.2. clustersetbinding の作成