API

Red Hat Advanced Cluster Management for Kubernetes 2.0

API

Red Hat Advanced Cluster Management for Kubernetes Team

概要

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.0.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
利用規約 :

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. パラメーター
タイプ名前説明スキーマ

ヘッダー

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. パラメーター
タイプ名前説明スキーマ

ヘッダー

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. パラメーター
タイプ名前説明スキーマ

ヘッダー

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. パラメーター
タイプ名前説明スキーマ

ヘッダー

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. クラスター

名前スキーマ

apiVersion
必須

文字列

kind
必須

文字列

metadata
必須

オブジェクト

spec
必須

spec

spec

名前スキーマ

hubAcceptsClient
必須

ブール型

managedClusterClientConfigs
任意

< managedClusterClientConfigs > array

leaseDurationSeconds
任意

整数 (int32)

managedClusterClientConfigs

名前説明スキーマ

URL
必須

 

文字列

CABundle
任意

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

文字列 (バイト)

1.2. Channels API

1.2.1. 概要

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

1.2.1.1. バージョン情報

バージョン : 2.0.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
利用規約 :

1.2.1.4. URI スキーム

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

1.2.1.5. タグ

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

1.2.1.6. 外部ドキュメント

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

1.2.2. パス

1.2.2.1. チャネルの作成

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

チャネルを作成します。

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

ヘッダー

COOKIE
必須

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

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

ボディー

body
必須

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

チャネル

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

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.2.2.1.4. 消費
  • application/yaml
1.2.2.1.5. タグ
  • channels.apps.open-cluster-management.io
1.2.2.1.6. HTTP 要求の例
1.2.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.2.2.2. ターゲット namespace の全チャネルのクエリー

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

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

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

ヘッダー

COOKIE
必須

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

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

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

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

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

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

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

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

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

ヘッダー

COOKIE
必須

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

文字列

パス

channel_name
必須

問い合わせる deployable の名前。

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

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

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

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

1.2.2.4. チャネルの削除

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

ヘッダー

COOKIE
必須

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

文字列

パス

channel_name
必須

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

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

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

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

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

1.2.3. 定義

1.2.3.1. チャネル

名前スキーマ

apiVersion
必須

文字列

kind
必須

文字列

metadata
必須

オブジェクト

spec
必須

spec

spec

名前説明スキーマ

configMapRef
任意

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

configMapRef

gates
任意

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

gates

pathname
必須

 

文字列

secretRef
任意

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

secretRef

sourceNamespaces
任意

 

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

configMapRef

名前説明スキーマ

apiVersion
任意

参照先の API バージョン。

文字列

fieldPath
任意

オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、「spec.containers{name}」などの値に設定されます (「name」はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、「spec.containers[2]」の値に設定されます (この Pod 内でインデックス が 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部を明確に定義するためです。TODO: この設計は最終版ではないので今後このフィールドは変更される可能性があります。

文字列

kind
任意

参照先の種類。詳細: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#types-kinds

文字列

name
任意

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

文字列

namespace
任意

参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

文字列

resourceVersion
任意

この参照が作成される特定の resourceVersion (ある場合)。詳細: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

文字列

uid
任意

参照先の UID。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

文字列

gates

名前説明スキーマ

annotations
任意

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

annotations

labelSelector
任意

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

labelSelector

name
任意

 

文字列

annotations

名前スキーマ

key
任意

文字列

value
任意

文字列

labelSelector

名前説明スキーマ

matchExpressions
任意

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

< matchExpressions > 配列

matchLabels
任意

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

< string, string > マップ

matchExpressions

名前説明スキーマ

key
必須

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

文字列

operator
必須

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

文字列

values
任意

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

< 文字列 > 配列

secretRef

名前説明スキーマ

apiVersion
任意

参照先の API バージョン。

文字列

fieldPath
任意

オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、「spec.containers{name}」などの値に設定されます (「name」はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、「spec.containers[2]」の値に設定されます (この Pod 内でインデックス が 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部を明確に定義するためです。TODO: この設計は最終版ではないので今後このフィールドは変更される可能性があります。

文字列

kind
任意

参照先の種類。詳細: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#types-kinds

文字列

name
任意

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

文字列

namespace
任意

参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

文字列

resourceVersion
任意

この参照が作成される特定の resourceVersion (ある場合)。詳細: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

文字列

uid
任意

参照先の UID。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

文字列

1.3. Subscriptions API

1.3.1. 概要

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

1.3.1.1. バージョン情報

バージョン : 2.0.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
利用規約 :

1.3.1.4. URI スキーム

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

1.3.1.5. タグ

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

1.3.1.6. 外部ドキュメント

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

1.3.2. パス

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

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

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

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

ヘッダー

COOKIE
必須

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

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

ボディー

body
必須

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

Subscription

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

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.3.2.1.4. 消費
  • subscription/yaml
1.3.2.1.5. タグ
  • subscriptions.apps.open-cluster-management.io
1.3.2.1.6. HTTP 要求の例
1.3.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.3.2.2. 全サブスクリプションのクエリー

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

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

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

ヘッダー

COOKIE
必須

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

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

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

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

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

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

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

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

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

ヘッダー

COOKIE
必須

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

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

パス

subscription_name
必須

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

文字列

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

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

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

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

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

ヘッダー

COOKIE
必須

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

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

パス

subscription_name
必須

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

文字列

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

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

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

1.3.3. 定義

1.3.3.1. Subscription

名前スキーマ

apiVersion
必須

文字列

kind
必須

文字列

metadata
必須

metadata

spec
必須

spec

status
任意

status

metadata

名前スキーマ

annotations
任意

オブジェクト

labels
任意

オブジェクト

name
任意

文字列

namespace
任意

文字列

spec

名前スキーマ

channel
必須

文字列

name
任意

文字列

overrides
任意

< overrides > 配列

packageFilter
任意

packageFilter

packageOverrides
任意

< packageOverrides > 配列

placement
任意

placement

timewindow
任意

timewindow

overrides

名前スキーマ

clusterName
必須

文字列

clusterOverrides
必須

< オブジェクト > 配列

packageFilter

名前説明スキーマ

annotations
任意

 

< string, string > マップ

filterRef
任意

 

filterRef

labelSelector
任意

 

labelSelector

version
任意

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

文字列

filterRef

名前スキーマ

name
任意

文字列

labelSelector

名前スキーマ

matchExpressions
任意

< matchExpressions > 配列

matchLabels
任意

< string, string > マップ

matchExpressions

名前スキーマ

key
必須

文字列

operator
必須

文字列

values
任意

< 文字列 > 配列

packageOverrides

名前スキーマ

packageAlias
任意

文字列

packageName
必須

文字列

packageOverrides
任意

< オブジェクト > 配列

placement

名前スキーマ

clusterSelector
任意

clusterSelector

clusters
任意

< clusters > 配列

local
任意

ブール値

placementRef
任意

placementRef

clusterSelector

名前スキーマ

matchExpressions
任意

< matchExpressions > 配列

matchLabels
任意

< string, string > マップ

matchExpressions

名前スキーマ

key
必須

文字列

operator
必須

文字列

values
任意

< 文字列 > 配列

clusters

名前スキーマ

name
必須

文字列

placementRef

名前スキーマ

apiVersion
任意

文字列

fieldPath
任意

文字列

kind
任意

文字列

name
任意

文字列

namespace
任意

文字列

resourceVersion
任意

文字列

uid
任意

文字列

timewindow

名前スキーマ

daysofweek
任意

< 文字列 > 配列

hours
任意

< hours > 配列

location
任意

文字列

windowtype
任意

列挙 (active, blocked, Active, Blocked)

hours

名前スキーマ

end
任意

文字列

start
任意

文字列

status

名前スキーマ

lastUpdateTime
任意

文字列 (date-time)

message
任意

文字列

phase
任意

文字列

reason
任意

文字列

statuses
任意

オブジェクト

1.4. Placementrules API

1.4.1. 概要

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

1.4.1.1. バージョン情報

バージョン : 2.0.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
利用規約 :

1.4.1.4. URI スキーム

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

1.4.1.5. タグ

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

1.4.1.6. 外部ドキュメント

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

1.4.2. パス

1.4.2.1. Placementrule の作成

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

Placementrule を作成します。

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

ヘッダー

COOKIE
必須

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

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

ボディー

body
必須

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

Placementrule

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

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

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

1.4.2.2. 全 placementrules のクエリー

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

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

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

ヘッダー

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. タグ
  • placementrules.apps.open-cluster-management.io

1.4.2.3. 単一の placementrule のクエリー

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

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

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

ヘッダー

COOKIE
必須

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

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

パス

placementrule_name
必須

問い合わせる placementrule の名前。

文字列

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

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

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

1.4.2.4. Placementrule の削除

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

ヘッダー

COOKIE
必須

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

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

パス

placementrule_name
必須

削除する placementrule の名前。

文字列

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

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

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

1.4.3. 定義

1.4.3.1. Placementrule

名前スキーマ

apiVersion
必須

文字列

kind
必須

文字列

metadata
必須

オブジェクト

spec
必須

spec

spec

名前スキーマ

clusterConditions
任意

< clusterConditions > 配列

clusterReplicas
任意

整数

clusterSelector
任意

clusterSelector

clusters
任意

< clusters > 配列

policies
任意

< policies > 配列

resourceHint
任意

resourceHint

schedulerName
任意

文字列

clusterConditions

名前スキーマ

status
任意

文字列

type
任意

文字列

clusterSelector

名前スキーマ

matchExpressions
任意

< matchExpressions > 配列

matchLabels
任意

< string, string > マップ

matchExpressions

名前スキーマ

key
任意

文字列

operator
任意

文字列

values
任意

< 文字列 > 配列

clusters

名前スキーマ

name
任意

文字列

policies

名前スキーマ

apiVersion
任意

文字列

fieldPath
任意

文字列

kind
任意

文字列

name
任意

文字列

namespace
任意

文字列

resourceVersion
任意

文字列

uid
任意

文字列

resourceHint

名前スキーマ

order
任意

文字列

type
任意

文字列

1.5. Applications API

1.5.1. 概要

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

1.5.1.1. バージョン情報

バージョン : 2.0.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
利用規約 :

1.5.1.4. URI スキーム

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

1.5.1.5. タグ

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

1.5.1.6. 外部ドキュメント

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

1.5.2. パス

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

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

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

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

ヘッダー

COOKIE
必須

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

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

ボディー

body
必須

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

アプリケーション

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

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.5.2.1.4. 消費
  • application/yaml
1.5.2.1.5. タグ
  • applications.app.k8s.io
1.5.2.1.6. HTTP 要求の例
1.5.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.5.2.2. 全アプリケーションのクエリー

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

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

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

ヘッダー

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. 消費
  • application/yaml
1.5.2.2.5. タグ
  • applications.app.k8s.io

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

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

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

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

ヘッダー

COOKIE
必須

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

文字列

パス

application_name
必須

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

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

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

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

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

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

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

ヘッダー

COOKIE
必須

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

文字列

パス

application_name
必須

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

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

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

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

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

1.5.3. 定義

1.5.3.1. アプリケーション

名前スキーマ

apiVersion
必須

文字列

kind
必須

文字列

metadata
必須

オブジェクト

spec
必須

spec

spec

名前スキーマ

assemblyPhase
任意

文字列

componentKinds
任意

< オブジェクト > 配列

descriptor
任意

記述子

info
任意

< info > 配列

selector
任意

オブジェクト

記述子

名前スキーマ

description
任意

文字列

icons
任意

< icons > 配列

keywords
任意

< 文字列 > 配列

links
任意

< links > 配列

maintainers
任意

<maintainers > 配列

notes
任意

文字列

owners
任意

< owners > 配列

type
任意

文字列

version
任意

文字列

icons

名前スキーマ

size
任意

文字列

src
必須

文字列

type
任意

文字列

名前スキーマ

description
任意

文字列

url
任意

文字列

maintainers

名前スキーマ

email
任意

文字列

name
任意

文字列

url
任意

文字列

owners

名前スキーマ

email
任意

文字列

name
任意

文字列

url
任意

文字列

info

名前スキーマ

name
任意

文字列

type
任意

文字列

value
任意

文字列

valueFrom
任意

valueFrom

valueFrom

名前スキーマ

configMapKeyRef
任意

configMapKeyRef

ingressRef
任意

ingressRef

secretKeyRef
任意

secretKeyRef

serviceRef
任意

serviceRef

type
任意

文字列

configMapKeyRef

名前スキーマ

apiVersion
任意

文字列

fieldPath
任意

文字列

key
任意

文字列

kind
任意

文字列

name
任意

文字列

namespace
任意

文字列

resourceVersion
任意

文字列

uid
任意

文字列

ingressRef

名前スキーマ

apiVersion
任意

文字列

fieldPath
任意

文字列

host
任意

文字列

kind
任意

文字列

name
任意

文字列

namespace
任意

文字列

path
任意

文字列

resourceVersion
任意

文字列

uid
任意

文字列

secretKeyRef

名前スキーマ

apiVersion
任意

文字列

fieldPath
任意

文字列

key
任意

文字列

kind
任意

文字列

name
任意

文字列

namespace
任意

文字列

resourceVersion
任意

文字列

uid
任意

文字列

serviceRef

名前スキーマ

apiVersion
任意

文字列

fieldPath
任意

文字列

kind
任意

文字列

name
任意

文字列

namespace
任意

文字列

path
任意

文字列

port
任意

整数 (int32)

resourceVersion
任意

文字列

uid
任意

文字列

1.6. Helm API

1.6.1. 概要

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

1.6.1.1. バージョン情報

バージョン : 2.0.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
利用規約 :

1.6.1.4. URI スキーム

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

1.6.1.5. タグ

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

1.6.1.6. 外部ドキュメント

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

1.6.2. パス

1.6.2.1. helmrelease の作成

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

Helmrelease を作成します。

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

ヘッダー

COOKIE
必須

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

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

ボディー

body
必須

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

HelmRelease

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

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.6.2.1.4. 消費
  • application/yaml
1.6.2.1.5. タグ
  • helmreleases.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" : "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.6.2.2. 全 helmreleases のクエリー

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

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

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

ヘッダー

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. タグ
  • helmreleases.apps.open-cluster-management.io

1.6.2.3. 単一の helmrelease のクエリー

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

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

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

ヘッダー

COOKIE
必須

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

文字列

パス

helmrelease_name
必須

問い合わせる helmrelease の名前。

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

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

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

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

1.6.2.4. helmrelease の削除

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

ヘッダー

COOKIE
必須

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

文字列

パス

helmrelease_name
必須

削除する helmrelease の名前。

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

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

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

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

1.6.3. 定義

1.6.3.1. HelmRelease

名前スキーマ

apiVersion
必須

文字列

kind
必須

文字列

metadata
必須

オブジェクト

repo
必須

repo

spec
必須

オブジェクト

status
必須

status

repo

名前スキーマ

chartName
任意

文字列

configMapRef
任意

configMapRef

secretRef
任意

secretRef

source
任意

source

version
任意

文字列

configMapRef

名前スキーマ

apiVersion
任意

文字列

fieldPath
任意

文字列

kind
任意

文字列

name
任意

文字列

namespace
任意

文字列

resourceVersion
任意

文字列

uid
任意

文字列

secretRef

名前スキーマ

apiVersion
任意

文字列

fieldPath
任意

文字列

kind
任意

文字列

name
任意

文字列

namespace
任意

文字列

resourceVersion
任意

文字列

uid
任意

文字列

source

名前スキーマ

github
任意

github

helmRepo
任意

helmRepo

type
任意

文字列

github

名前スキーマ

branch
任意

文字列

chartPath
任意

文字列

urls
任意

< 文字列 > 配列

helmRepo

名前スキーマ

urls
任意

< 文字列 > 配列

status

名前スキーマ

conditions
必須

< conditions > 配列

deployedRelease
任意

deployedRelease

conditions

名前スキーマ

lastTransitionTime
任意

文字列 (date-time)

message
任意

文字列

reason
任意

文字列

status
必須

文字列

type
必須

文字列

deployedRelease

名前スキーマ

manifest
任意

文字列

name
任意

文字列

1.7. Policy API

1.7.1. 概要

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

1.7.1.1. バージョン情報

バージョン : 2.0.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
利用規約 :

1.7.1.4. URI スキーム

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

1.7.1.5. タグ

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

1.7.1.6. 外部ドキュメント

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

1.7.2. パス

1.7.2.1. ポリシーの作成

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

ポリシーを作成します。

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

ヘッダー

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/json
1.7.2.1.5. タグ
  • policy.open-cluster-management.io
1.7.2.1.6. HTTP 要求の例
1.7.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.7.2.2. 全ポリシーのクエリー

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

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

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

ヘッダー

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/json
1.7.2.2.5. タグ
  • policy.open-cluster-management.io

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

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

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

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

ヘッダー

COOKIE
必須

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

文字列

パス

policy_name
必須

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

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

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

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

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

1.7.2.4. ポリシーの削除

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

ヘッダー

COOKIE
必須

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

文字列

パス

policy_name
必須

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

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

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

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

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

1.7.3. 定義

1.7.3.1. ポリシー

名前説明スキーマ

apiVersion
必須

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

文字列

kind
必須

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

文字列

metadata
必須

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

オブジェクト

spec

名前説明スキーマ

remediationAction
任意

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

文字列

namespace
必須

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

文字列

policy-templates

名前説明スキーマ

apiVersion
必須

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

文字列

kind
任意

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

文字列

complianceType
必須

コンプライアンス規格。

文字列

metadata
必須

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

オブジェクト

clusterConditions
任意

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

文字列

rules
任意

 

文字列

セレクター

名前説明スキーマ

matchLabels
任意

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

オブジェクト

cloud
任意

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

文字列

ルール

名前説明スキーマ

apiGroups
必須

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

文字列

resources
必須

リソースタイプの一覧。

オブジェクト

verbs
必須

動詞の一覧。

文字列

法律上の通知

Copyright © 2021 Red Hat, Inc.
The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.