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

Version: 2.8.0

1.6.1.2. URI スキーム

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

1.6.1.3. タグ

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

1.6.2. パス

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

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

1.6.2.1.1. 説明

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

1.6.2.1.2. パラメーター

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

1.6.2.1.3. 応答

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

1.6.2.1.4. 消費

subscription/yaml

1.6.2.1.5. タグ

subscriptions.apps.open-cluster-management.io

1.6.2.1.6. HTTP リクエストの例

1.6.2.1.6.1. 要求の body

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

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

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

1.6.2.2.1. 説明

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

1.6.2.2.2. パラメーター

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

1.6.2.2.3. レスポンス

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

1.6.2.2.4. 消費

subscription/yaml

1.6.2.2.5. タグ

subscriptions.apps.open-cluster-management.io

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

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

1.6.2.3.1. 説明

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

1.6.2.3.2. パラメーター

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

1.6.2.3.3. レスポンス

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

1.6.2.3.4. タグ

subscriptions.apps.open-cluster-management.io

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

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

1.6.2.4.1. パラメーター

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

1.6.2.4.2. レスポンス

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

1.6.2.4.3. タグ

subscriptions.apps.open-cluster-management.io

1.6.3. 定義

1.6.3.1. サブスクリプション

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

metadata

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

spec

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

overrides

Name	スキーマ
clusterName 必須	string
clusterOverrides 必須	object array

packageFilter

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

filterRef

Name	スキーマ
name 任意	string

labelSelector

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

matchExpressions

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

packageOverrides

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

placement

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

clusterSelector

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