API

1.1. Clusters API
リンクのコピー

1.1.1. 概要
リンクのコピー

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

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. パラメーター
リンクのコピー

Expand

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

1.1.2.1.3. レスポンス
リンクのコピー

Expand

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. パラメーター
リンクのコピー

Expand

型	名前	説明	スキーマ
ヘッダー	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	文字列
ボディー	body 必須	作成するクラスターを記述するパラメーター	クラスター

1.1.2.2.3. 応答
リンクのコピー

Expand

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. 要求のボディー
リンクのコピー

{
  "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. パラメーター
リンクのコピー

Expand

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

1.1.2.3.3. レスポンス
リンクのコピー

Expand

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. パラメーター
リンクのコピー

Expand

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

1.1.2.4.3. レスポンス
リンクのコピー

Expand

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

1.1.2.4.4. タグ
リンクのコピー

cluster.open-cluster-management.io

1.1.3. 定義
リンクのコピー

1.1.3.1. クラスター
リンクのコピー

Expand

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

spec

Expand

名前	スキーマ
hubAcceptsClient 必須	bool
managedClusterClientConfigs 任意	managedClusterClientConfigs 配列
leaseDurationSeconds 任意	整数 (int32)

managedClusterClientConfigs

Expand

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

1.2. Clustersets API (v1beta1)
リンクのコピー

1.2.1. 概要
リンクのコピー

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

1.2.1.3. タグ
リンクのコピー

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

1.2.2. パス
リンクのコピー

1.2.2.1. 全 clusterset のクエリー
リンクのコピー

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

1.2.2.1.1. 説明
リンクのコピー

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

1.2.2.1.2. パラメーター
リンクのコピー

Expand

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

1.2.2.1.3. レスポンス
リンクのコピー

Expand

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/v1beta1/managedclustersets

1.2.2.2.1. 説明
リンクのコピー

Clusterset を作成します。

1.2.2.2.2. パラメーター
リンクのコピー

Expand

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

1.2.2.2.3. 応答
リンクのコピー

Expand

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. 要求のボディー
リンクのコピー

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

1.2.2.3. 単一 clusterset のクエリー
リンクのコピー

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

1.2.2.3.1. 説明
リンクのコピー

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

1.2.2.3.2. パラメーター
リンクのコピー

Expand

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

1.2.2.3.3. レスポンス
リンクのコピー

Expand

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/v1beta1/managedclustersets/{clusterset_name}

1.2.2.4.1. 説明
リンクのコピー

単一 clusterset を削除します。

1.2.2.4.2. パラメーター
リンクのコピー

Expand

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

1.2.2.4.3. レスポンス
リンクのコピー

Expand

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

1.2.2.4.4. タグ
リンクのコピー

cluster.open-cluster-management.io

1.2.3. 定義
リンクのコピー

1.2.3.1. Clusterset
リンクのコピー

Expand

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

1.3. Clustersetbindings API (v1beta1)
リンクのコピー

1.3.1. 概要
リンクのコピー

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

1.3.1.3. タグ
リンクのコピー

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

1.3.2. パス
リンクのコピー

1.3.2.1. 全 clustersetbinding のクエリー
リンクのコピー

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

1.3.2.1.1. 説明
リンクのコピー

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

1.3.2.1.2. パラメーター
リンクのコピー

Expand

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

1.3.2.1.3. レスポンス
リンクのコピー

Expand

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/v1beta1/namespaces/{namespace}/managedclustersetbindings

1.3.2.2.1. 説明
リンクのコピー

clustersetbinding を作成します。

1.3.2.2.2. パラメーター
リンクのコピー

Expand

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

1.3.2.2.3. 応答
リンクのコピー

Expand

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. 要求のボディー
リンクのコピー

{
  "apiVersion" : "cluster.open-cluster-management.io/v1beta1",
  "kind" : "ManagedClusterSetBinding",
  "metadata" : {
    "name" : "clusterset1",
    "namespace" : "ns1"
  },
 "spec": {
    "clusterSet": "clusterset1"
  },
  "status" : { }
}

1.3.2.3. 単一 clustersetbinding のクエリー
リンクのコピー

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

1.3.2.3.1. 説明
リンクのコピー

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

1.3.2.3.2. パラメーター
リンクのコピー

Expand

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

1.3.2.3.3. レスポンス
リンクのコピー

Expand

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/v1beta1/managedclustersetbindings/{clustersetbinding_name}

1.3.2.4.1. 説明
リンクのコピー

単一 clustersetbinding を削除します。

1.3.2.4.2. パラメーター
リンクのコピー

Expand

型	名前	説明	スキーマ
ヘッダー	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	文字列
パス	namespace 必須	使用する namespace (例: default)	文字列
パス	clustersetbinding_name 必須	削除する clustersetbinding の名前	文字列

1.3.2.4.3. レスポンス
リンクのコピー

Expand

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

1.3.2.4.4. タグ
リンクのコピー

cluster.open-cluster-management.io

1.3.3. 定義
リンクのコピー

1.3.3.1. Clustersetbinding
リンクのコピー

Expand

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

spec

Expand

名前	スキーマ
clusterSet 必須	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.5.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. パラメーター
リンクのコピー

Expand

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

1.4.2.1.3. レスポンス
リンクのコピー

Expand

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. パラメーター
リンクのコピー

Expand

型	名前	説明	スキーマ
ヘッダー	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	文字列
ボディー	body 任意	マネージドクラスターを一覧表示するユーザー ID の名前	文字列

1.4.2.2.3. レスポンス
リンクのコピー

Expand

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. 要求のボディー
リンクのコピー

{
  "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. パラメーター
リンクのコピー

Expand

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

1.4.2.3.3. レスポンス
リンクのコピー

Expand

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. パラメーター
リンクのコピー

Expand

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

1.4.2.4.3. レスポンス
リンクのコピー

Expand

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. パラメーター
リンクのコピー

Expand

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

1.4.2.5.3. レスポンス
リンクのコピー

Expand

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. パラメーター
リンクのコピー

Expand

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

1.4.2.6.3. レスポンス
リンクのコピー

Expand

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.5.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. パラメーター
リンクのコピー

Expand

型	名前	説明	スキーマ
ヘッダー	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	文字列
パス	namespace 必須	使用する namespace (例: default)	文字列
ボディー	body 必須	作成する deployable を記述するパラメーター	チャネル

1.5.2.1.3. 応答
リンクのコピー

Expand

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. 要求のボディー
リンクのコピー

{
  "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. パラメーター
リンクのコピー

Expand

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

1.5.2.2.3. レスポンス
リンクのコピー

Expand

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. パラメーター
リンクのコピー

Expand

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

1.5.2.3.3. レスポンス
リンクのコピー

Expand

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. パラメーター
リンクのコピー

Expand

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

1.5.2.4.2. レスポンス
リンクのコピー

Expand

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

1.5.2.4.3. タグ
リンクのコピー

channels.apps.open-cluster-management.io

1.5.3. 定義
リンクのコピー

1.5.3.1. チャネル
リンクのコピー

Expand

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

spec

Expand

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

configMapRef

Expand

Name	説明	スキーマ
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/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/api-conventions.md#concurrency-control-and-consistency	string
uid 任意	参照先の UID。詳細: UIDs	文字列

gates

Expand

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

annotations

Expand

Name	スキーマ
key 任意	string
value 任意	string

labelSelector

Expand

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

matchExpressions

Expand

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

secretRef

Expand

Name	説明	スキーマ
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/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/api-conventions.md#concurrency-control-and-consistency	string
uid 任意	参照先の UID。詳細:UIDs	文字列

1.6. Subscriptions API
リンクのコピー

1.6.1. 概要
リンクのコピー

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

1.6.1.1. バージョン情報
リンクのコピー

バージョン: 2.5.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. パラメーター
リンクのコピー

Expand

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

1.6.2.1.3. 応答
リンクのコピー

Expand

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. 要求のボディー
リンクのコピー

{
  "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. パラメーター
リンクのコピー

Expand

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

1.6.2.2.3. レスポンス
リンクのコピー

Expand

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. パラメーター
リンクのコピー

Expand

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

1.6.2.3.3. レスポンス
リンクのコピー

Expand

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. パラメーター
リンクのコピー

Expand

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

1.6.2.4.2. レスポンス
リンクのコピー

Expand

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

1.6.2.4.3. タグ
リンクのコピー

subscriptions.apps.open-cluster-management.io

1.6.3. 定義
リンクのコピー

1.6.3.1. サブスクリプション
リンクのコピー

Expand

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

metadata

Expand

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

spec

Expand

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

overrides

Expand

Name	スキーマ
clusterName 必須	string
clusterOverrides 必須	オブジェクト配列

packageFilter

Expand

Name	説明	スキーマ
annotations 任意		文字列、文字列マップ
filterRef 任意		filterRef
labelSelector 任意		labelSelector
version 任意	Pattern : `"()((\\.[0-9])(\\.)\|(\\.[0-9])?(\\.[xX]))$"`	文字列

filterRef

Expand

Name	スキーマ
name 任意	string

labelSelector

Expand

Name	スキーマ
matchExpressions 任意	matchExpressions 配列
matchLabels 任意	文字列、文字列マップ

matchExpressions

Expand

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

packageOverrides

Expand

Name	スキーマ
packageAlias 任意	string
packageName 必須	string
packageOverrides 任意	オブジェクト配列

placement

Expand

Name	スキーマ
clusterSelector 任意	clusterSelector
clusters 任意	clusters 配列
local 任意	boolean
placementRef 任意	placementRef

clusterSelector

Expand

Name	スキーマ
matchExpressions 任意	matchExpressions 配列
matchLabels 任意	文字列、文字列マップ

matchExpressions

Expand

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

clusters

Expand

Name	スキーマ
name 必須	string

placementRef

Expand

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

timewindow

Expand

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

hours

Expand

Name	スキーマ
end 任意	string
start 任意	string

status

Expand

Name	スキーマ
lastUpdateTime 任意	文字列 (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.5.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. パラメーター
リンクのコピー

Expand

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

1.7.2.1.3. 応答
リンクのコピー

Expand

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. 要求のボディー
リンクのコピー

{
  "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. パラメーター
リンクのコピー

Expand

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

1.7.2.2.3. レスポンス
リンクのコピー

Expand

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. パラメーター
リンクのコピー

Expand

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

1.7.2.3.3. レスポンス
リンクのコピー

Expand

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. パラメーター
リンクのコピー

Expand

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

1.7.2.4.2. レスポンス
リンクのコピー

Expand

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
リンクのコピー

Expand

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

spec

Expand

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

clusterConditions

Expand

Name	スキーマ
status 任意	string
type 任意	string

clusterSelector

Expand

Name	スキーマ
matchExpressions 任意	matchExpressions 配列
matchLabels 任意	文字列、文字列マップ

matchExpressions

Expand

Name	スキーマ
key 任意	string
Operator 任意	string
values 任意	string array

clusters

Expand

Name	スキーマ
name 任意	string

policies

Expand

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

resourceHint

Expand

Name	スキーマ
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.5.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. パラメーター
リンクのコピー

Expand

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

1.8.2.1.3. 応答
リンクのコピー

Expand

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. 要求のボディー
リンクのコピー

{
  "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. パラメーター
リンクのコピー

Expand

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

1.8.2.2.3. レスポンス
リンクのコピー

Expand

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. パラメーター
リンクのコピー

Expand

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

1.8.2.3.3. レスポンス
リンクのコピー

Expand

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. パラメーター
リンクのコピー

Expand

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

1.8.2.4.2. レスポンス
リンクのコピー

Expand

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

1.8.2.4.3. タグ
リンクのコピー

applications.app.k8s.io

1.8.3. 定義
リンクのコピー

1.8.3.1. アプリケーション
リンクのコピー

Expand

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

spec

Expand

名前	スキーマ
assemblyPhase 任意	string
componentKinds 任意	オブジェクト配列
descriptor 任意	記述子
info 任意	info 配列
selector 任意	object

記述子

Expand

Name	スキーマ
description 任意	string
icons 任意	icons 配列
keywords 任意	string array
links 任意	links 配列
maintainers 任意	maintainers 配列
notes 任意	string
owners 任意	owners 配列
type 任意	string
version 任意	string

icons

Expand

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

links

Expand

Name	スキーマ
description 任意	string
url 任意	string

maintainers

Expand

Name	スキーマ
email 任意	string
name 任意	string
url 任意	string

owners

Expand

Name	スキーマ
email 任意	string
name 任意	string
url 任意	string

info

Expand

Name	スキーマ
name 任意	string
type 任意	string
value 任意	string
valueFrom 任意	valueFrom

valueFrom

Expand

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

configMapKeyRef

Expand

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

ingressRef

Expand

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

secretKeyRef

Expand

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

serviceRef

Expand

Name	スキーマ
apiVersion 任意	string
fieldPath 任意	string
kind 任意	string
name 任意	string
namespace 任意	string
path 任意	string
ポート任意	整数 (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.5.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. パラメーター
リンクのコピー

Expand

型	名前	説明	スキーマ
ヘッダー	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	文字列
パス	namespace 必須	使用する namespace (例: default)	文字列
ボディー	body 必須	作成する helmrelease を記述するパラメーター	HelmRelease

1.9.2.1.3. 応答
リンクのコピー

Expand

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. 要求のボディー
リンクのコピー

{
  "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. パラメーター
リンクのコピー

Expand

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

1.9.2.2.3. レスポンス
リンクのコピー

Expand

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. パラメーター
リンクのコピー

Expand

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

1.9.2.3.3. レスポンス
リンクのコピー

Expand

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. パラメーター
リンクのコピー

Expand

型	名前	説明	スキーマ
ヘッダー	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	文字列
パス	helmrelease_name 必須	削除する helmrelease の名前	文字列
パス	namespace 必須	使用する namespace (例: default)	文字列

1.9.2.4.2. レスポンス
リンクのコピー

Expand

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
リンクのコピー

Expand

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

repo

Expand

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

configMapRef

Expand

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

secretRef

Expand

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

source

Expand

Name	スキーマ
github 任意	github
helmRepo 任意	helmRepo
type 任意	string

github

Expand

Name	スキーマ
branch 任意	string
chartPath 任意	string
urls 任意	string array

helmRepo

Expand

Name	スキーマ
urls 任意	string array

status

Expand

Name	スキーマ
conditions 必須	conditions 配列
deployedRelease 任意	deployedRelease

conditions

Expand

Name	スキーマ
lastTransitionTime 任意	文字列 (date-time)
message 任意	string
reason 任意	string
status 必須	string
type 必須	string

deployedRelease

Expand

Name	スキーマ
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.5.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. パラメーター
リンクのコピー

Expand

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

1.10.2.1.3. 応答
リンクのコピー

Expand

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. 要求のボディー
リンクのコピー

{
  "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. パラメーター
リンクのコピー

Expand

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

1.10.2.2.3. レスポンス
リンクのコピー

Expand

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. パラメーター
リンクのコピー

Expand

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

1.10.2.3.3. レスポンス
リンクのコピー

Expand

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. パラメーター
リンクのコピー

Expand

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

1.10.2.4.2. レスポンス
リンクのコピー

Expand

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

1.10.2.4.3. タグ
リンクのコピー

policy.open-cluster-management.io

1.10.3. 定義
リンクのコピー

1.10.3.1. Policy
リンクのコピー

Expand

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

spec

Expand

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

policy-templates

Expand

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

clusterConditions

Expand

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

rules

Expand

Name	説明	スキーマ
apiGroups 必須	このルールが適用される API の一覧	string
resources 必須	リソースタイプの一覧	object
verbs 必須	動詞の一覧	文字列

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.5.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. パラメーター
リンクのコピー

Expand

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

1.11.2.1.3. 応答
リンクのコピー

Expand

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. 要求のボディー
リンクのコピー

{
  "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. パラメーター
リンクのコピー

Expand

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

1.11.2.2.3. レスポンス
リンクのコピー

Expand

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. パラメーター
リンクのコピー

Expand

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

1.11.2.3.3. レスポンス
リンクのコピー

Expand

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. パラメーター
リンクのコピー

Expand

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

1.11.2.4.2. レスポンス
リンクのコピー

Expand

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
リンクのコピー

Expand

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

spec

Expand

名前	説明	スキーマ
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 のレプリカ	整数

storageConfig

Expand

Name	説明	スキーマ
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 optional	エンドポイントアクセス情報のリスト。	[ ]WriteStorage

writeStorage

Expand

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

metricObjectStorage

Expand

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

observabilityAddonSpec

Expand

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

advanced

Expand

Name	説明	スキーマ
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 optional	コンパクトなステートフルセットのリソースを指定します。	compact
storeMemcached 任意	store-memcached のレプリカ、リソースなどを指定します。	storeMemcached
queryFrontendMemcached 任意	query-frontend-memcached のレプリカ、リソースなどを指定します。	CacheConfig

retentionConfig

Expand

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

CompactSpec

Expand

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

storeMemcached

Expand

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

status

Expand

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

CommonSpec

Expand

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

QuerySpec

Expand

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

ReceiveSpec

Expand

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

StoreSpec

Expand

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

RuleSpec

Expand

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

1.12. Search customization API
リンクのコピー

1.12.1. 概要
リンクのコピー

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

1.12.1.1. バージョン情報
リンクのコピー

バージョン: 2.5.0

1.12.1.2. URI スキーム
リンクのコピー

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

1.12.1.3. タグ
リンクのコピー

search.open-cluster-management.io/v1: 永続ボリュームを作成して管理します。

1.12.2. パス
リンクのコピー

1.12.2.1. searchCustomization の作成
リンクのコピー

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

1.12.2.1.1. 説明
リンクのコピー

searchCustomization を作成します。

1.12.2.1.2. パラメーター
リンクのコピー

Expand

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

1.12.2.1.3. 応答
リンクのコピー

Expand

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

1.12.2.1.4. 消費
リンクのコピー

searchCustomization/json

1.12.2.1.5. タグ
リンクのコピー

search.open-cluster-management.io

1.12.2.1.6. HTTP 要求の例
リンクのコピー

1.12.2.1.6.1. 要求のボディー
リンクのコピー

{
  "apiVersion": "search.open-cluster-management.io/v1",
  "kind": "SearchCustomization",
  "metadata": {
    "name": "test-search-swagger",
    "description": "Example body for SearchCustomization API Swagger docs"
  },
  "spec": {
    "remediationAction": "enforce",
    "namespaces": {
      "include": [
        "default"
      ],
      "exclude": [
        "kube*"
      ]
    },
    "policy-templates": {
    "kind": "ConfigurationPolicy",
    "apiVersion": "search.open-cluster-management.io/v1alpha1",
    "complianceType": "musthave",
    "metadata": {
      "namespace": null,
      "name": "test-role"
    },
    "selector": {
      "matchLabels": {
        "cloud": "IBM"
      }
    },
    "spec" : {
      "object-templates": {
        "complianceType": "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.12.2.2. searchCustomization のクエリー
リンクのコピー

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

1.12.2.2.1. 説明
リンクのコピー

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

1.12.2.2.2. パラメーター
リンクのコピー

Expand

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

1.12.2.2.3. レスポンス
リンクのコピー

Expand

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

1.12.2.2.4. 消費
リンクのコピー

searchCustomization/json

1.12.2.2.5. タグ
リンクのコピー

search.open-cluster-management.io

1.12.2.3. 単一ポリシーのクエリー
リンクのコピー

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

1.12.2.3.1. 説明
リンクのコピー

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

1.12.2.3.2. パラメーター
リンクのコピー

Expand

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

1.12.2.3.3. レスポンス
リンクのコピー

Expand

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

1.12.2.3.4. タグ
リンクのコピー

search.open-cluster-management.io

1.12.2.4. searchCustomization の削除
リンクのコピー

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

1.12.2.4.1. パラメーター
リンクのコピー

Expand

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

1.12.2.4.2. レスポンス
リンクのコピー

Expand

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

1.12.2.4.3. タグ
リンクのコピー

search.open-cluster-management.io

1.12.3. 定義
リンクのコピー

1.12.3.1. SearchCustomization
リンクのコピー

Expand

Name	説明	スキーマ
apiVersion 必須	SearchCustomization のバージョンスキーマ	string
kind 必須	REST リソースを表す文字列の値	string
metadata 必須	ポリシーを定義するルールを記述します。	オブジェクト

spec

Expand

名前	説明	スキーマ
remediationAction 任意	リソースで定義されているように違反をどのように処理するかを表す値	string
namespaces 必須	ポリシーが適用される際に、`include` または `exclude` する namespace を表す値	文字列

policy-templates

Expand

Name	説明	スキーマ
apiVersion 必須	SearchCustomization のバージョンスキーマ	string
kind 任意	REST リソースを表す文字列の値	string
metadata 必須	ポリシーを定義するルールを記述します。	オブジェクト
complianceType	マネージドクラスターに評価または適用する必要のあるロールおよび他の Kubernetes オブジェクトの予想される動作を一覧表示するのに使用されます。	string
clusterConditions optional	ラベルを定義するセクション	string
rules optional		string

clusterConditions

Expand

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

rules

Expand

Name	説明	スキーマ
apiGroups 必須	このルールが適用される API の一覧	string
resources 必須	リソースタイプの一覧	object
verbs 必須	動詞の一覧	文字列

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.5.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. パラメーター
リンクのコピー

Expand

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

1.13.2.1.3. 応答
リンクのコピー

Expand

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. 要求のボディー
リンクのコピー

{
  "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.",
        "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 {product-title-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. パラメーター
リンクのコピー

Expand

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

1.13.2.2.3. レスポンス
リンクのコピー

Expand

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. パラメーター
リンクのコピー

Expand

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

1.13.2.3.3. レスポンス
リンクのコピー

Expand

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. パラメーター
リンクのコピー

Expand

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

1.13.2.4.2. レスポンス
リンクのコピー

Expand

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
リンクのコピー

Expand

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

spec

Expand

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 にインストールします。	ブール値

hive

Expand

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

ingress

Expand

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

backup

Expand

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

failedProvisionConfig

Expand

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

status

Expand

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

conditions

Expand

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

StatusConditions

Expand

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

1.14. Placements API (v1beta1)
リンクのコピー

1.14.1. 概要
リンクのコピー

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

1.14.1.1. バージョン情報
リンクのコピー

バージョン: 2.5.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}/placements

1.14.2.1.1. 説明
リンクのコピー

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

1.14.2.1.2. パラメーター
リンクのコピー

Expand

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

1.14.2.1.3. レスポンス
リンクのコピー

Expand

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. パラメーター
リンクのコピー

Expand

型	名前	説明	スキーマ
ヘッダー	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	文字列
ボディー	body 必須	作成する placement を記述するパラメーター	Placement

1.14.2.2.3. 応答
リンクのコピー

Expand

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. 要求のボディー
リンクのコピー

{
  "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. パラメーター
リンクのコピー

Expand

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

1.14.2.3.3. レスポンス
リンクのコピー

Expand

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. パラメーター
リンクのコピー

Expand

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

1.14.2.4.3. レスポンス
リンクのコピー

Expand

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

1.14.2.4.4. タグ
リンクのコピー

cluster.open-cluster-management.io

1.14.3. 定義
リンクのコピー

1.14.3.1. Placement
リンクのコピー

Expand

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

spec

Expand

名前	説明	スキーマ
ClusterSets 任意	ManagedClusters を選択する ManagedClusterSets のサブセット。空白の場合には、Placement namespace にバインドされる ManagedClusterSets から ManagedClusters が選択されます。それ以外の場合は、ManagedClusters がこのサブセットの交差部分から選択され、ManagedClusterSets は Placement namespace にバインドされます。	string array
numberOfClusters 任意	選択する ManagedClusters の必要数	整数 (int32)
predicates 任意	ManagedClusters を選択するクラスター述語のサブセット。条件ロジックは OR です。	clusterPredicate アレイ

clusterPredicate

Expand

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

clusterSelector

Expand

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

clusterClaimSelector

Expand

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

1.15. PlacementDecisions API (v1beta1)
リンクのコピー

1.15.1. 概要
リンクのコピー

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

1.15.1.1. バージョン情報
リンクのコピー

バージョン: 2.5.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. パラメーター
リンクのコピー

Expand

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

1.15.2.1.3. レスポンス
リンクのコピー

Expand

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. 説明
リンクのコピー

PlacementDecisions を作成します。

1.15.2.2.2. パラメーター
リンクのコピー

Expand

型	名前	説明	スキーマ
ヘッダー	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	文字列
ボディー	body 必須	作成する PlacementDecision を記述するパラメーター	PlacementDecision

1.15.2.2.3. 応答
リンクのコピー

Expand

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. 要求のボディー
リンクのコピー

{
  "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 つの PlacementDecisions に対してクエリーを実行して詳細を確認します。

1.15.2.3.2. パラメーター
リンクのコピー

Expand

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

1.15.2.3.3. レスポンス
リンクのコピー

Expand

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. パラメーター
リンクのコピー

Expand

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

1.15.2.4.3. レスポンス
リンクのコピー

Expand

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

1.15.2.4.4. タグ
リンクのコピー

cluster.open-cluster-management.io

1.15.3. 定義
リンクのコピー

1.15.3.1. PlacementDecision
リンクのコピー

Expand

名前	説明	スキーマ
apiVersion 必須	PlacementDecision のバージョンスキーマ	string
kind 必須	REST リソースを表す文字列の値	string
metadata 必須	PlacementDecision のメタデータ	オブジェクト

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.5.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. パラメーター
リンクのコピー

Expand

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

1.16.2.1.3. 応答
リンクのコピー

Expand

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. 要求のボディー
リンクのコピー

{
  "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.5\"",
                          "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. パラメーター
リンクのコピー

Expand

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

1.16.2.2.3. レスポンス
リンクのコピー

Expand

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. パラメーター
リンクのコピー

Expand

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

1.16.2.3.2. レスポンス
リンクのコピー

Expand

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
リンクのコピー

Expand

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

1.16.3.2. 仕様の一覧
リンクのコピー

Expand

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

1.16.3.3. フィルターの一覧
リンクのコピー

Expand

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

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.5.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. パラメーター
リンクのコピー

Expand

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

1.17.2.1.3. 応答
リンクのコピー

Expand

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. 要求のボディー
リンクのコピー

{
  "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. パラメーター
リンクのコピー

Expand

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

1.17.2.2.3. レスポンス
リンクのコピー

Expand

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. パラメーター
リンクのコピー

Expand

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

1.17.2.3.2. レスポンス
リンクのコピー

Expand

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
リンクのコピー

Expand

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

1.17.3.2. 仕様の一覧
リンクのコピー

Expand

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

アプリケーションリソース、チャンネル、サブスクリプションの作成および管理、ならびに情報のクエリーに使用できる 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. 要求のボディーリンクのコピーリンクがクリップボードにコピーされました!

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 (v1beta1)リンクのコピーリンクがクリップボードにコピーされました!

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. 要求のボディーリンクのコピーリンクがクリップボードにコピーされました!

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 (v1beta1)リンクのコピーリンクがクリップボードにコピーされました!

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 の作成リンクのコピーリンクがクリップボードにコピーされました!

第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. 要求のボディー
リンクのコピー

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 (v1beta1)
リンクのコピー

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. 要求のボディー
リンクのコピー

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 (v1beta1)
リンクのコピー

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 の作成
リンクのコピー

1.3.2.2.1. 説明
リンクのコピー

1.3.2.2.2. パラメーター
リンクのコピー