Menu Close

API

Red Hat Advanced Cluster Management for Kubernetes 2.1

API

概要

Red Hat Advanced Cluster Management for Kubernetes の API ガイド

第1章 API

API にアクセスして、アプリケーションリソース、チャネル、サブスクリプションの作成や管理、さらに情報のクエリーを行うことができます。

必要なユーザーアクセス権: ロールが割り当てられているアクションのみを実行できます。「ロールベースのアクセス制御」のドキュメントで、アクセス要件について確認してください。

詳細は、以下のリソースに関する API のドキュメントを参照してください。

1.1. Clusters API

1.1.1. 概要

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

1.1.1.1. バージョン情報

バージョン : 2.1.0

1.1.1.2. お問い合わせ先

お問い合わせメール: apiteam@swagger.io

1.1.1.3. ライセンス情報

ライセンス: Apache 2.0
ライセンス URL: http://www.apache.org/licenses/LICENSE-2.0.html
利用規約: http://swagger.io/terms/

1.1.1.4. URI スキーム

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

1.1.1.5. タグ

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

1.1.1.6. 外部ドキュメント

説明: Swagger に関する詳細は次を確認してください。
URL: http://swagger.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. パラメーター
タイプName (名前)説明スキーマ

ヘッダー

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

文字列

1.1.2.1.3. 応答
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.1.2.1.4. 消費
  • cluster/yaml
1.1.2.1.5. タグ
  • cluster.open-cluster-management.io

1.1.2.2. クラスターを作成します。

POST /cluster.open-cluster-management.io/v1/managedclusters
1.1.2.2.1. 説明

クラスターを作成します。

1.1.2.2.2. パラメーター
タイプName (名前)説明スキーマ

ヘッダー

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

文字列

ボディー

body
必須

作成するクラスターを記述するパラメーター

クラスター

1.1.2.2.3. 応答
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.1.2.2.4. 消費
  • cluster/yaml
1.1.2.2.5. タグ
  • cluster.open-cluster-management.io
1.1.2.2.6. HTTP 要求の例
1.1.2.2.6.1. 要求ボディー
{
  "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. パラメーター
タイプName (名前)説明スキーマ

ヘッダー

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

文字列

パス

cluster_name
必須

問い合わせるクラスターの名前。

文字列

1.1.2.3.3. 応答
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.1.2.3.4. タグ
  • cluster.open-cluster-management.io

1.1.2.4. クラスターを削除します。

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

単一クラスターの削除

1.1.2.4.2. パラメーター
タイプName (名前)説明スキーマ

ヘッダー

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

文字列

パス

cluster_name
必須

削除するクラスターの名前。

文字列

1.1.2.4.3. 応答
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.1.2.4.4. タグ
  • cluster.open-cluster-management.io

1.1.3. 定義

1.1.3.1. クラスター

名前Schema

apiVersion
必須

string

kind
必須

string

metadata
必須

object

spec
必須

spec

spec

名前Schema

hubAcceptsClient
必須

bool

managedClusterClientConfigs
任意

< managedClusterClientConfigs > array

leaseDurationSeconds
任意

整数 (int32)

managedClusterClientConfigs

名前説明Schema

URL
必須

 

string

cabundle
任意

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

文字列 (バイト)

1.2. Clustersets API (v1alpha1)

1.2.1. 概要

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

1.2.1.1. バージョン情報

バージョン : 2.1.0

1.2.1.2. お問い合わせ先

お問い合わせメール: apiteam@swagger.io

1.2.1.3. ライセンス情報

ライセンス: Apache 2.0
ライセンス URL: http://www.apache.org/licenses/LICENSE-2.0.html
利用規約: http://swagger.io/terms/

1.2.1.4. URI スキーム

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

1.2.1.5. タグ

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

1.2.1.6. 外部ドキュメント

説明: Swagger に関する詳細は次を確認してください。
URL: http://swagger.io

1.2.2. パス

1.2.2.1. 全クラスターセットのクエリー

GET /cluster.open-cluster-management.io/v1alpha1/managedclustersets
1.2.2.1.1. 説明

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

1.2.2.1.2. パラメーター
タイプName (名前)説明スキーマ

ヘッダー

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

文字列

1.2.2.1.3. 応答
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.2.2.1.4. 消費
  • clusterset/yaml
1.2.2.1.5. タグ
  • cluster.open-cluster-management.io

1.2.2.2. クラスターセットの作成

POST /cluster.open-cluster-management.io/v1alpha1/managedclustersets
1.2.2.2.1. 説明

クラスターセットの作成

1.2.2.2.2. パラメーター
タイプName (名前)説明スキーマ

ヘッダー

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

文字列

ボディー

body
必須

作成するクラスターセットを記述するパラメーター

Clusterset

1.2.2.2.3. 応答
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.2.2.2.4. 消費
  • clusterset/yaml
1.2.2.2.5. タグ
  • cluster.open-cluster-management.io
1.2.2.2.6. HTTP 要求の例
1.2.2.2.6.1. 要求ボディー
{
  "apiVersion" : "cluster.open-cluster-management.io/v1alpha1",
  "kind" : "ManagedClusterSet",
  "metadata" : {
    "name" : "clusterset1"
  },
  "spec": { },
  "status" : { }
}

1.2.2.3. 単一クラスターセットのクエリー

GET /cluster.open-cluster-management.io/v1alpha1/managedclustersets/{clusterset_name}
1.2.2.3.1. 説明

単一のクラスターセットに対してクエリーを実行して詳細を確認します。

1.2.2.3.2. パラメーター
タイプName (名前)説明スキーマ

ヘッダー

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

文字列

パス

clusterset_name
必須

問い合わせるクラスターセットの名前。

文字列

1.2.2.3.3. 応答
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.2.2.3.4. タグ
  • cluster.open-cluster-management.io

1.2.2.4. クラスターセットの削除

DELETE /cluster.open-cluster-management.io/v1alpha1/managedclustersets/{clusterset_name}
1.2.2.4.1. 説明

単一クラスターセットの削除

1.2.2.4.2. パラメーター
タイプName (名前)説明スキーマ

ヘッダー

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

文字列

パス

clusterset_name
必須

削除するクラスターセットの名前。

文字列

1.2.2.4.3. 応答
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.2.2.4.4. タグ
  • cluster.open-cluster-management.io

1.2.3. 定義

1.2.3.1. クラスターセット

名前Schema

apiVersion
必須

string

kind
必須

string

metadata
必須

object

1.3. Clustersetbindings API (v1alpha1)

1.3.1. 概要

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

1.3.1.1. バージョン情報

バージョン : 2.1.0

1.3.1.2. お問い合わせ先

お問い合わせメール: apiteam@swagger.io

1.3.1.3. ライセンス情報

ライセンス: Apache 2.0
ライセンス URL: http://www.apache.org/licenses/LICENSE-2.0.html
利用規約: http://swagger.io/terms/

1.3.1.4. URI スキーム

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

1.3.1.5. タグ

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

1.3.1.6. 外部ドキュメント

説明: Swagger に関する詳細は次を確認してください。
URL: http://swagger.io

1.3.2. パス

1.3.2.1. 全 clustersetbinding のクエリー

GET /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/managedclustersetbindings
1.3.2.1.1. 説明

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

1.3.2.1.2. パラメーター
タイプName (名前)説明スキーマ

ヘッダー

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

1.3.2.1.3. 応答
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.3.2.1.4. 消費
  • clustersetbinding/yaml
1.3.2.1.5. タグ
  • cluster.open-cluster-management.io

1.3.2.2. clustersetbinding の作成

POST /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/managedclustersetbindings
1.3.2.2.1. 説明

clustersetbinding の作成

1.3.2.2.2. パラメーター
タイプName (名前)説明スキーマ

ヘッダー

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

ボディー

body
必須

作成する clustersetbinding を記述するパラメーター

Clustersetbinding

1.3.2.2.3. 応答
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.3.2.2.4. 消費
  • clustersetbinding/yaml
1.3.2.2.5. タグ
  • cluster.open-cluster-management.io
1.3.2.2.6. HTTP 要求の例
1.3.2.2.6.1. 要求ボディー
{
  "apiVersion" : "cluster.open-cluster-management.io/v1alpha1",
  "kind" : "ManagedClusterSetBinding",
  "metadata" : {
    "name" : "clusterset1",
    "namespace" : "ns1"
  },
 "spec": {
    "clusterSet": "clusterset1"
  },
  "status" : { }
}

1.3.2.3. 単一 clustersetbinding のクエリー

GET /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/managedclustersetbindings/{clustersetbinding_name}
1.3.2.3.1. 説明

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

1.3.2.3.2. パラメーター
タイプName (名前)説明スキーマ

ヘッダー

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

パス

clustersetbinding_name
必須

問い合わせる clustersetbinding の名前。

文字列

1.3.2.3.3. 応答
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.3.2.3.4. タグ
  • cluster.open-cluster-management.io

1.3.2.4. clustersetbinding の削除

DELETE /cluster.open-cluster-management.io/v1alpha1/managedclustersetbindings/{clustersetbinding_name}
1.3.2.4.1. 説明

単一 clustersetbinding の削除

1.3.2.4.2. パラメーター
タイプName (名前)説明スキーマ

ヘッダー

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

パス

clustersetbinding_name
必須

削除する clustersetbinding の名前。

文字列

1.3.2.4.3. 応答
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.3.2.4.4. タグ
  • cluster.open-cluster-management.io

1.3.3. 定義

1.3.3.1. Clustersetbinding

名前Schema

apiVersion
必須

string

kind
必須

string

metadata
必須

object

spec
必須

spec

spec

名前Schema

clusterSet
必須

string

1.4. Channels API

1.4.1. 概要

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

1.4.1.1. バージョン情報

バージョン : 2.1.0

1.4.1.2. お問い合わせ先

お問い合わせメール: apiteam@swagger.io

1.4.1.3. ライセンス情報

ライセンス: Apache 2.0
ライセンス URL: http://www.apache.org/licenses/LICENSE-2.0.html
利用規約: http://swagger.io/terms/

1.4.1.4. URI スキーム

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

1.4.1.5. タグ

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

1.4.1.6. 外部ドキュメント

説明: Swagger に関する詳細は次を確認してください。
URL: http://swagger.io

1.4.2. パス

1.4.2.1. チャネルの作成

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

チャネルを作成します。

1.4.2.1.2. パラメーター
タイプName (名前)説明スキーマ

ヘッダー

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

ボディー

body
必須

作成する deployable を記述するパラメーター

チャネル

1.4.2.1.3. 応答
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.4.2.1.4. 消費
  • application/yaml
1.4.2.1.5. タグ
  • channels.apps.open-cluster-management.io
1.4.2.1.6. HTTP 要求の例
1.4.2.1.6.1. 要求ボディー
{
  "apiVersion" : "apps.open-cluster-management.io/v1",
  "kind" : "Channel",
  "name" : "sample-channel",
  "namespace" : "default",
  "spec" : {
    "type" : "Git",
    "pathname" : "https://github.com/IBM/charts.git",
    "configMapRef" : {
      "name" : "bookinfo-resource-filter-configmap",
      "kind" : "configmap"
    }
  }
}

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

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

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

1.4.2.2.2. パラメーター
タイプName (名前)説明スキーマ

ヘッダー

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

1.4.2.2.3. 応答
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.4.2.2.4. 消費
  • application/yaml
1.4.2.2.5. タグ
  • channels.apps.open-cluster-management.io

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

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

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

1.4.2.3.2. パラメーター
タイプName (名前)説明スキーマ

ヘッダー

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

文字列

パス

channel_name
必須

問い合わせる deployable の名前。

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

1.4.2.3.3. 応答
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.4.2.3.4. タグ
  • channels.apps.open-cluster-management.io

1.4.2.4. チャネルの削除

DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels/{channel_name}
1.4.2.4.1. パラメーター
タイプName (名前)説明スキーマ

ヘッダー

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

文字列

パス

channel_name
必須

削除するチャネルの名前。

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

1.4.2.4.2. 応答
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.4.2.4.3. タグ
  • channels.apps.open-cluster-management.io

1.4.3. 定義

1.4.3.1. チャネル

名前Schema

apiVersion
必須

string

kind
必須

string

metadata
必須

object

spec
必須

spec

spec

Name (名前)説明Schema

configMapRef
任意

ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。

configMapRef

gates
任意

ChannelGate はチャネルにプロモートする基準を定義します。

gates

pathname
必須

 

string

secretRef
任意

ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。

secretRef

sourceNamespaces
任意

 

< enum (Namespace, HelmRepo, ObjectBucket, Git, namespace, helmrepo, objectbucket, github) > 配列

configMapRef

名前説明Schema

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
任意

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#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。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

文字列

gates

名前説明Schema

annotations
任意

k8s の典型的なアノテーション

annotations

labelSelector
任意

ラベルセレクターとは、一連のリソースに対するラベルクエリー機能です。matchLabels と matchExpressions の結果は AND を使用して結合されます。ラベルセレクターが空の場合は、全オブジェクトをマッチします。ラベルセレクターが null の場合は、どのオブジェクトもマッチしません。

labelSelector

name
任意

 

string

annotations

名前Schema

key
任意

string

value
任意

string

labelSelector

名前説明Schema

matchExpressions
任意

matchExpressions はラベルセレクターの要件の一覧です。要件は AND で結合します。

< matchExpressions > array

matchLabels
任意

matchLabels は、{key,value} ペアのマップです。MatchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには「key」、演算子には「In」、値配列には「value」のみが含まれます。要件は AND で結合します。

< string, string > マップ

matchExpressions

名前説明Schema

key
必須

key は、セレクターの適用先のラベルキーです。

string

operator
必須

Operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

string

values
任意

value は文字列値の配列です。Operator が In または NotIn の場合には、値の配列を空白にできません。Operator が Exists または DoesNotExist の場合には、値の配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

< 文字列 > 配列

secretRef

名前説明Schema

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
任意

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#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。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

文字列

1.5. Subscriptions API

1.5.1. 概要

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

1.5.1.1. バージョン情報

バージョン : 2.1.0

1.5.1.2. お問い合わせ先

お問い合わせメール: apiteam@swagger.io

1.5.1.3. ライセンス情報

ライセンス: Apache 2.0
ライセンス URL: http://www.apache.org/licenses/LICENSE-2.0.html
利用規約: http://swagger.io/terms/

1.5.1.4. URI スキーム

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

1.5.1.5. タグ

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

1.5.1.6. 外部ドキュメント

説明: Swagger に関する詳細は次を確認してください。
URL: http://swagger.io

1.5.2. パス

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

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

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

1.5.2.1.2. パラメーター
タイプName (名前)説明スキーマ

ヘッダー

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

ボディー

body
必須

作成するサブスクリプションを記述するパラメーター。

Subscription

1.5.2.1.3. 応答
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.5.2.1.4. 消費
  • subscription/yaml
1.5.2.1.5. タグ
  • subscriptions.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" : "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.5.2.2. 全サブスクリプションのクエリー

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

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

1.5.2.2.2. パラメーター
タイプName (名前)説明スキーマ

ヘッダー

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

1.5.2.2.3. 応答
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.5.2.2.4. 消費
  • subscription/yaml
1.5.2.2.5. タグ
  • subscriptions.apps.open-cluster-management.io

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

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

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

1.5.2.3.2. パラメーター
タイプName (名前)説明スキーマ

ヘッダー

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

パス

subscription_name
必須

問い合わせるサブスクリプションの名前。

文字列

1.5.2.3.3. 応答
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.5.2.3.4. タグ
  • subscriptions.apps.open-cluster-management.io

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

DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}
1.5.2.4.1. パラメーター
タイプName (名前)説明スキーマ

ヘッダー

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

パス

subscription_name
必須

削除するサブスクリプションの名前。

文字列

1.5.2.4.2. 応答
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.5.2.4.3. タグ
  • subscriptions.apps.open-cluster-management.io

1.5.3. 定義

1.5.3.1. Subscription

名前Schema

apiVersion
必須

string

kind
必須

string

metadata
必須

metadata

spec
必須

spec

status
任意

status

metadata

名前Schema

annotations
任意

object

labels
任意

object

name
任意

string

namespace
任意

string

spec

名前Schema

channel
必須

string

name
任意

string

overrides
任意

<overrides > 配列

packageFilter
任意

packageFilter

packageOverrides
任意

< packageOverrides > array

placement
任意

placement

timewindow
任意

timewindow

overrides

名前Schema

clusterName
必須

string

clusterOverrides
必須

< オブジェクト > 配列

packageFilter

名前説明Schema

annotations
任意

 

< string, string > マップ

filterRef
任意

 

filterRef

labelSelector
任意

 

labelSelector

version
任意

Pattern : "([0-9]+)\\.[0-9]+)(\\.[0-9]+)|(\\.[0-9]+)?(\\.[xX]$"

string

filterRef

名前Schema

name
任意

string

labelSelector

名前Schema

matchExpressions
任意

< matchExpressions > array

matchLabels
任意

< string, string > マップ

matchExpressions

名前Schema

key
必須

string

operator
必須

string

values
任意

< 文字列 > 配列

packageOverrides

名前Schema

packageAlias
任意

string

packageName
必須

string

packageOverrides
任意

< オブジェクト > 配列

placement

名前Schema

clusterSelector
任意

clusterSelector

clusters
任意

<clusters > 配列

local
任意

boolean

placementRef
任意

placementRef

clusterSelector

名前Schema

matchExpressions
任意

< matchExpressions > array

matchLabels
任意

< string, string > マップ

matchExpressions

名前Schema

key
必須

string

operator
必須

string

values
任意

< 文字列 > 配列

clusters

名前Schema

name
必須

string

placementRef

名前Schema

apiVersion
任意

string

fieldPath
任意

string

kind
任意

string

name
任意

string

namespace
任意

string

resourceVersion
任意

string

uid
任意

string

timewindow

名前Schema

daysofweek
任意

< 文字列 > 配列

hours
任意

<hours > 配列

location
任意

string

windowtype
任意

列挙 (active, blocked, Active, Blocked)

hours

名前Schema

end
任意

string

start
任意

string

status

名前Schema

lastUpdateTime
任意

文字列 (date-time)

message
任意

string

phase
任意

string

reason
任意

string

statuses
任意

object

1.6. PlacementRules API

1.6.1. 概要

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

1.6.1.1. バージョン情報

バージョン : 2.1.0

1.6.1.2. お問い合わせ先

お問い合わせメール: apiteam@swagger.io

1.6.1.3. ライセンス情報

ライセンス: Apache 2.0
ライセンス URL: http://www.apache.org/licenses/LICENSE-2.0.html
利用規約: http://swagger.io/terms/

1.6.1.4. URI スキーム

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

1.6.1.5. タグ

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

1.6.1.6. 外部ドキュメント

説明: Swagger に関する詳細は次を確認してください。
URL: http://swagger.io

1.6.2. パス

1.6.2.1. 配置ルールの作成

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

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

1.6.2.1.2. パラメーター
タイプName (名前)説明スキーマ

ヘッダー

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

ボディー

body
必須

作成する配置ルールを記述するパラメーター。

Placementrule

1.6.2.1.3. 応答
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.6.2.1.4. 消費
  • application/yaml
1.6.2.1.5. タグ
  • placementrules.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" : "PlacementRule",
  "metadata" : {
    "name" : "towhichcluster",
    "namespace" : "ns-sub-1"
  },
  "spec" : {
    "clusterConditions" : [ {
      "type": "ManagedClusterConditionAvailable",
      "status": "True"
    } ],
    "clusterSelector" : { }
  }
}

1.6.2.2. 全 placementrules のクエリー

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

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

1.6.2.2.2. パラメーター
タイプName (名前)説明スキーマ

ヘッダー

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

1.6.2.2.3. 応答
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.6.2.2.4. 消費
  • application/yaml
1.6.2.2.5. タグ
  • placementrules.apps.open-cluster-management.io

1.6.2.3. 単一の placementrule のクエリー

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

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

1.6.2.3.2. パラメーター
タイプName (名前)説明スキーマ

ヘッダー

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

パス

placementrule_name
必須

問い合わせる配置ルールの名前。

文字列

1.6.2.3.3. 応答
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.6.2.3.4. タグ
  • placementrules.apps.open-cluster-management.io

1.6.2.4. Placementrule の削除

DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules/{placementrule_name}
1.6.2.4.1. パラメーター
タイプName (名前)説明スキーマ

ヘッダー

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

パス

placementrule_name
必須

削除する placementrule の名前。

文字列

1.6.2.4.2. 応答
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.6.2.4.3. タグ
  • placementrules.apps.open-cluster-management.io

1.6.3. 定義

1.6.3.1. Placementrule

名前Schema

apiVersion
必須

string

kind
必須

string

metadata
必須

object

spec
必須

spec

spec

名前Schema

clusterConditions
任意

< clusterConditions > array

clusterReplicas
任意

integer

clusterSelector
任意

clusterSelector

clusters
任意

<clusters > 配列

policies
任意

<policies > 配列

resourceHint
任意

resourceHint

schedulerName
任意

string

clusterConditions

名前Schema

status
任意

string

type
任意

string

clusterSelector

名前Schema

matchExpressions
任意

< matchExpressions > array

matchLabels
任意

< string, string > マップ

matchExpressions

名前Schema

key
任意

string

operator
任意

string

values
任意

< 文字列 > 配列

clusters

名前Schema

name
任意

string

policies

名前Schema

apiVersion
任意

string

fieldPath
任意

string

kind
任意

string

name
任意

string

namespace
任意

string

resourceVersion
任意

string

uid
任意

string

resourceHint

名前Schema

order
任意

string

type
任意

string

1.7. Applications API

1.7.1. 概要

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

1.7.1.1. バージョン情報

バージョン : 2.1.0

1.7.1.2. お問い合わせ先

お問い合わせメール: apiteam@swagger.io

1.7.1.3. ライセンス情報

ライセンス: Apache 2.0
ライセンス URL: http://www.apache.org/licenses/LICENSE-2.0.html
利用規約: http://swagger.io/terms/

1.7.1.4. URI スキーム

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

1.7.1.5. タグ

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

1.7.1.6. 外部ドキュメント

説明: Swagger に関する詳細は次を確認してください。
URL: http://swagger.io

1.7.2. パス

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

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

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

1.7.2.1.2. パラメーター
タイプName (名前)説明スキーマ

ヘッダー

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

ボディー

body
必須

作成するアプリケーションを記述するパラメーター。

アプリケーション

1.7.2.1.3. 応答
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.7.2.1.4. 消費
  • application/yaml
1.7.2.1.5. タグ
  • applications.app.k8s.io
1.7.2.1.6. HTTP 要求の例
1.7.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.7.2.2. 全アプリケーションのクエリー

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

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

1.7.2.2.2. パラメーター
タイプName (名前)説明スキーマ

ヘッダー

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

1.7.2.2.3. 応答
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.7.2.2.4. 消費
  • application/yaml
1.7.2.2.5. タグ
  • applications.app.k8s.io

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

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

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

1.7.2.3.2. パラメーター
タイプName (名前)説明スキーマ

ヘッダー

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

文字列

パス

application_name
必須

問い合わせるアプリケーションの名前。

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

1.7.2.3.3. 応答
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.7.2.3.4. タグ
  • applications.app.k8s.io

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

DELETE /app.k8s.io/v1beta1/namespaces/{namespace}/applications/{application_name}
1.7.2.4.1. パラメーター
タイプName (名前)説明スキーマ

ヘッダー

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

文字列

パス

application_name
必須

削除するアプリケーションの名前。

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

1.7.2.4.2. 応答
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.7.2.4.3. タグ
  • applications.app.k8s.io

1.7.3. 定義

1.7.3.1. アプリケーション

名前Schema

apiVersion
必須

string

kind
必須

string

metadata
必須

object

spec
必須

spec

spec

名前Schema

assemblyPhase
任意

string

componentKinds
任意

< オブジェクト > 配列

descriptor
任意

記述子

info
任意

<info > 配列

selector
任意

object

記述子

名前Schema

description
任意

string

icons
任意

<icons > 配列

keywords
任意

< 文字列 > 配列

links
任意

<links > 配列

maintainers
任意

<maintainers > 配列

notes
任意

string

owners
任意

<owners > 配列

type
任意

string

version
任意

string

icons

名前Schema

size
任意

string

src
必須

string

type
任意

string

名前Schema

description
任意

string

url
任意

string

maintainers

名前Schema

email
任意

string

name
任意

string

url
任意

string

owners

名前Schema

email
任意

string

name
任意

string

url
任意

string

info

名前Schema

name
任意

string

type
任意

string

value
任意

string

valueFrom
任意

valueFrom

valueFrom

名前Schema

configMapKeyRef
任意

configMapKeyRef

ingressRef
任意

ingressRef

secretKeyRef
任意

secretKeyRef

serviceRef
任意

serviceRef

type
任意

string

configMapKeyRef

名前Schema

apiVersion
任意

string

fieldPath
任意

string

key
任意

string

kind
任意

string

name
任意

string

namespace
任意

string

resourceVersion
任意

string

uid
任意

string

ingressRef

名前Schema

apiVersion
任意

string

fieldPath
任意

string

host
任意

string

kind
任意

string

name
任意

string

namespace
任意

string

path
任意

string

resourceVersion
任意

string

uid
任意

string

secretKeyRef

名前Schema

apiVersion
任意

string

fieldPath
任意

string

key
任意

string

kind
任意

string

name
任意

string

namespace
任意

string

resourceVersion
任意

string

uid
任意

string

serviceRef

名前Schema

apiVersion
任意

string

fieldPath
任意

string

kind
任意

string

name
任意

string

namespace
任意

string

path
任意

string

port
任意

整数 (int32)

resourceVersion
任意

string

uid
任意

string

1.8. Helm API

1.8.1. 概要

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

1.8.1.1. バージョン情報

バージョン : 2.1.0

1.8.1.2. お問い合わせ先

お問い合わせメール: apiteam@swagger.io

1.8.1.3. ライセンス情報

ライセンス: Apache 2.0
ライセンス URL: http://www.apache.org/licenses/LICENSE-2.0.html
利用規約: http://swagger.io/terms/

1.8.1.4. URI スキーム

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

1.8.1.5. タグ

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

1.8.1.6. 外部ドキュメント

説明: Swagger に関する詳細は次を確認してください。
URL: http://swagger.io

1.8.2. パス

1.8.2.1. helmrelease の作成

POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases
1.8.2.1.1. 説明

Helmrelease を作成します。

1.8.2.1.2. パラメーター
タイプName (名前)説明スキーマ

ヘッダー

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

ボディー

body
必須

作成する helmrelease を記述するパラメーター。

HelmRelease

1.8.2.1.3. 応答
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.8.2.1.4. 消費
  • application/yaml
1.8.2.1.5. タグ
  • helmreleases.apps.open-cluster-management.io
1.8.2.1.6. HTTP 要求の例
1.8.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.8.2.2. 全 helmreleases のクエリー

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases
1.8.2.2.1. 説明

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

1.8.2.2.2. パラメーター
タイプName (名前)説明スキーマ

ヘッダー

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

1.8.2.2.3. 応答
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.8.2.2.4. 消費
  • application/yaml
1.8.2.2.5. タグ
  • helmreleases.apps.open-cluster-management.io

1.8.2.3. 単一の helmrelease のクエリー

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases/{helmrelease_name}
1.8.2.3.1. 説明

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

1.8.2.3.2. パラメーター
タイプName (名前)説明スキーマ

ヘッダー

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

文字列

パス

helmrelease_name
必須

問い合わせる helmrelease の名前。

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

1.8.2.3.3. 応答
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.8.2.3.4. タグ
  • helmreleases.apps.open-cluster-management.io

1.8.2.4. helmrelease の削除

DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases/{helmrelease_name}
1.8.2.4.1. パラメーター
タイプName (名前)説明スキーマ

ヘッダー

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

文字列

パス

helmrelease_name
必須

削除する helmrelease の名前。

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

1.8.2.4.2. 応答
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.8.2.4.3. タグ
  • helmreleases.apps.open-cluster-management.io

1.8.3. 定義

1.8.3.1. HelmRelease

名前Schema

apiVersion
必須

string

kind
必須

string

metadata
必須

object

repo
必須

repo

spec
必須

object

status
必須

status

repo

名前Schema

chartName
任意

string

configMapRef
任意

configMapRef

secretRef
任意

secretRef

source
任意

source

version
任意

string

configMapRef

名前Schema

apiVersion
任意

string

fieldPath
任意

string

kind
任意

string

name
任意

string

namespace
任意

string

resourceVersion
任意

string

uid
任意

string

secretRef

名前Schema

apiVersion
任意

string

fieldPath
任意

string

kind
任意

string

name
任意

string

namespace
任意

string

resourceVersion
任意

string

uid
任意

string

source

名前Schema

github
任意

github

helmRepo
任意

helmRepo

type
任意

string

github

名前Schema

branch
任意

string

chartPath
任意

string

urls
任意

< 文字列 > 配列

helmRepo

名前Schema

urls
任意

< 文字列 > 配列

status

名前Schema

conditions
必須

<conditions > 配列

deployedRelease
任意

deployedRelease

conditions

名前Schema

lastTransitionTime
任意

文字列 (date-time)

message
任意

string

reason
任意

string

status
必須

string

type
必須

string

deployedRelease

名前Schema

manifest
任意

string

name
任意

string

1.9. Policy API

1.9.1. 概要

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

1.9.1.1. バージョン情報

バージョン : 2.1.0

1.9.1.2. お問い合わせ先

お問い合わせメール: apiteam@swagger.io

1.9.1.3. ライセンス情報

ライセンス: Apache 2.0
ライセンス URL: http://www.apache.org/licenses/LICENSE-2.0.html
利用規約: http://swagger.io/terms/

1.9.1.4. URI スキーム

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

1.9.1.5. タグ

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

1.9.1.6. 外部ドキュメント

説明: Swagger に関する詳細は次を確認してください。
URL: http://swagger.io

1.9.2. パス

1.9.2.1. ポリシーの作成

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

ポリシーを作成します。

1.9.2.1.2. パラメーター
タイプName (名前)説明スキーマ

ヘッダー

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

ボディー

body
必須

作成するポリシーを記述するパラメーター

アプリケーション

1.9.2.1.3. 応答
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.9.2.1.4. 消費
  • application/json
1.9.2.1.5. タグ
  • policy.open-cluster-management.io
1.9.2.1.6. HTTP 要求の例
1.9.2.1.6.1. 要求ボディー
{
  "apiVersion": "policy.open-cluster-management.io/v1/v1alpha1",
  "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/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.9.2.2. 全ポリシーのクエリー

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

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

1.9.2.2.2. パラメーター
タイプName (名前)説明スキーマ

ヘッダー

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

文字列

パス

namespace
必須

ポリシーを適用する namespace (例: default)

文字列

1.9.2.2.3. 応答
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.9.2.2.4. 消費
  • application/json
1.9.2.2.5. タグ
  • policy.open-cluster-management.io

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

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

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

1.9.2.3.2. パラメーター
タイプName (名前)説明スキーマ

ヘッダー

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

文字列

パス

policy_name
必須

問い合わせるポリシーの名前。

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

1.9.2.3.3. 応答
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.9.2.3.4. タグ
  • policy.open-cluster-management.io

1.9.2.4. ポリシーの削除

DELETE /policy.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}
1.9.2.4.1. パラメーター
タイプName (名前)説明スキーマ

ヘッダー

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

文字列

パス

policy_name
必須

削除するポリシーの名前。

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

1.9.2.4.2. 応答
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.9.2.4.3. タグ
  • policy.open-cluster-management.io

1.9.3. 定義

1.9.3.1. ポリシー

Name (名前)説明Schema

apiVersion
必須

ポリシーのバージョンスキーマ。

string

kind
必須

REST リソースを表す文字列の値。

string

metadata
必須

ポリシーを定義するルールを記述します。

オブジェクト

spec

Name (名前)説明Schema

remediationAction
任意

リソースで定義されているように違反をどのように処理するかを表す値。

string

namespaceSelector
必須

ポリシーが適用される namespace を表す値。

string

policy-templates

Name (名前)説明Schema

apiVersion
必須

ポリシーのバージョンスキーマ。

string

kind
任意

REST リソースを表す文字列の値。

string

metadata
必須

ポリシーを定義するルールを記述します。

オブジェクト

clusterConditions
任意

ラベルを定義するセクション。

string

rules
任意

 

string

clusterConditions

Name (名前)説明Schema

matchLabels
任意

ポリシーを namespace に適用するのに必要なラベル。

object

cloud
任意

ポリシーをクラウドプロバイダーに適用するのに必要なラベル。

string

ルール

Name (名前)説明Schema

apiGroups
必須

このルールが適用される API の一覧です。

文字列

resources
必須

リソースタイプの一覧。

object

verbs
必須

動詞の一覧。

文字列

1.10. Observability API

1.10.1. 概要

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

1.10.1.1. バージョン情報

バージョン : 2.1.0

1.10.1.2. お問い合わせ先

お問い合わせメール: apiteam@swagger.io

1.10.1.3. ライセンス情報

ライセンス: Apache 2.0
ライセンス URL: http://www.apache.org/licenses/LICENSE-2.0.html
利用規約: http://swagger.io/terms/

1.10.1.4. URI スキーム

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

1.10.1.5. タグ

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

1.10.1.6. 外部ドキュメント

説明: Swagger に関する詳細は次を確認してください。
URL: http://swagger.io

1.10.2. パス

1.10.2.1. multiclusterobservability リソースの作成

POST /apis/observability.open-cluster-management.io/v1beta1/multiclusterobservabilities
1.10.2.1.1. 説明

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

1.10.2.1.2. パラメーター
タイプName (名前)説明スキーマ

ヘッダー

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

文字列

ボディー

body
必須

作成する MultiClusterObservability リソースを記述するパラメーター

MultiClusterObservability

1.10.2.1.3. 応答
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.10.2.1.4. 消費
  • application/yaml
1.10.2.1.5. タグ
  • observability.apps.open-cluster-management.io
1.10.2.1.6. HTTP 要求の例
1.10.2.1.6.1. 要求ボディー
{
  "apiVersion": "observability.open-cluster-management.io/v1beta1",
  "kind": "MultiClusterObservability",
  "metadata": {
    "name": "example"
  },
  "spec": {
    "storageConfigObject": {
      "metricObjectStorage": {
        "name": "thanos-object-storage",
        "key": "thanos.yaml"
      }
    }
  }
}

1.10.2.2. すべての multiclusterobservabilities のクエリー

GET /apis/observability.open-cluster-management.io/v1beta1/multiclusterobservabilities
1.10.2.2.1. 説明

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

1.10.2.2.2. パラメーター
タイプName (名前)説明スキーマ

ヘッダー

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

文字列

1.10.2.2.3. 応答
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.10.2.2.4. 消費
  • application/yaml
1.10.2.2.5. タグ
  • observability.apps.open-cluster-management.io

1.10.2.3. 単一の multiclusterobservability のクエリー

GET /apis/observability.open-cluster-management.io/v1beta1/multiclusterobservabilities/{multiclusterobservability_name}
1.10.2.3.1. 説明

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

1.10.2.3.2. パラメーター
タイプName (名前)説明スキーマ

ヘッダー

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

文字列

パス

multiclusterobservability_name
必須

問い合わせる multiclusterobservability の名前

文字列

1.10.2.3.3. 応答
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.10.2.3.4. タグ
  • observability.apps.open-cluster-management.io

1.10.2.4. multiclusterobservability リソースの削除

DELETE /apis/observability.open-cluster-management.io/v1beta1/multiclusterobservabilities/{multiclusterobservability_name}
1.10.2.4.1. パラメーター
タイプName (名前)説明スキーマ

ヘッダー

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

文字列

パス

multiclusterobservability_name
必須

削除する multiclusterobservability の名前

文字列

1.10.2.4.2. 応答
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.10.2.4.3. タグ
  • observability.apps.open-cluster-management.io

1.10.3. 定義

1.10.3.1. MultiClusterObservability

名前説明Schema

apiVersion
必須

MultiClusterObservability のバージョンスキーマ。

string

kind
必須

REST リソース (MultiClusterObservability) を表す文字列の値。

string

metadata
必須

ポリシーを定義するルールを記述します。

オブジェクト

spec

Name (名前)説明Schema

availabilityConfig
任意

高可用性サポートの選択に使用するパラメーター。これにより、フェイルオーバー時のサポートが提供され、リソースを多く使用できます。
オプション: Basic および High

string

enableDownSampling
任意

downsample を有効または無効にします。デフォルト値は false です。downsample データがない場合は、クエリーを利用できません。

boolean

imagePullPolicy
任意

可観測性イメージのプルポリシー。

string

imagePullSecret
任意

可観測性イメージのプルシークレット。

string

nodeSelector
任意

ノード選択の制約のサポート

object

observabilityAddonSpec
任意

アドオンが有効な全マネージドクラスターのグローバル設定。

observabilityAddonSpec

retentionResolution1h
任意

バスケットに解像度 2 のサンプルを保持する時間 (1 時間)。デフォルト値は 30 日 (30d) です。

string

retentionResolution5m
任意

バスケットに解像度 1 のサンプルを保持する時間 (5 分)。デフォルト値は 14 日 (14d) です。

string

retentionResolutionRaw
任意

バスケットで未加工の解像度サンプルを保持する時間。

string

storageConfigObject
必須

可観測性が使用するストレージを指定します。

storageConfigObject

observabilityAddonSpec

Name (名前)説明Schema

enableMetrics
任意

可観測性アドオンがメトリクスをハブクラスターに送信するかどうかを指定します。デフォルト値は true です。

boolean

interval
任意

可観測性アドオンがメトリクスをハブクラスターに送信する間隔。デフォルト値は 60 秒(60s)です。

整数

storageConfigObject

名前説明Schema

metricObjectStorage
必須

メトリクスのシークレットを設定するオブジェクトストア。

metricObjectStorage

statefulSetSize
任意

可観測性ステートフルセットに適用されるストレージの量 (Thanos ストア、ルール、コンパクト、およびレシーバー)。デフォルト値は 10Gi です。

文字列

statefulSetStorageClass
任意

storageClass ステートフルセットを指定します。このストレージは、オペレーティングシステムでストレージを作成するように MetricObjectStorage が設定されている場合に、オブジェクトストレージに使用します。デフォルト値は gp2 です。

string

metricObjectStorage

Name (名前)説明Schema

key
必須

選択するシークレットのキー。有効な秘密鍵でなければなりません。

文字列

name
必須

metricObjectStorage の名前。

文字列