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
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions
1.6.2.1.1. 説明
サブスクリプションを作成します。
1.6.2.1.2. パラメーター
型 | 名前 | 説明 | スキーマ |
---|---|---|---|
ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
パス |
namespace | 使用する namespace (例: default) | 文字列 |
ボディー |
body | 作成するサブスクリプションを記述するパラメーター |
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. 要求のボディー
{ "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" } } } }
{
"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
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions
1.6.2.2.1. 説明
サブスクリプションにクエリーを行い、詳細を確認します。
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. 消費
-
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}
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}
1.6.2.3.1. 説明
1 つのサブスクリプションにクエリーを行い、詳細を確認します。
1.6.2.3.2. パラメーター
型 | 名前 | 説明 | スキーマ |
---|---|---|---|
ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
パス |
namespace | 使用する namespace (例: default) | 文字列 |
パス |
subscription_name | 問い合わせるサブスクリプションの名前 | 文字列 |
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}
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}
1.6.2.4.1. パラメーター
型 | 名前 | 説明 | スキーマ |
---|---|---|---|
ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
パス |
namespace | 使用する namespace (例: default) | 文字列 |
パス |
subscription_name | 削除するサブスクリプションの名前 | 文字列 |
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 | |
spec | |
status |
metadata
Name | スキーマ |
---|---|
annotations | object |
labels | object |
name | string |
namespace | string |
spec
名前 | スキーマ |
---|---|
channel | string |
name | string |
overrides | overrides 配列 |
packageFilter | |
packageOverrides | |
placement | |
timewindow |
overrides
Name | スキーマ |
---|---|
clusterName | string |
clusterOverrides | オブジェクト配列 |
packageFilter
Name | 説明 | スキーマ |
---|---|---|
annotations | 文字列、文字列マップ | |
filterRef | ||
labelSelector | ||
version |
Pattern : | 文字列 |
filterRef
Name | スキーマ |
---|---|
name | string |
labelSelector
Name | スキーマ |
---|---|
matchExpressions | |
matchLabels | 文字列、文字列マップ |
matchExpressions
Name | スキーマ |
---|---|
key | string |
operator | string |
values | string array |
packageOverrides
Name | スキーマ |
---|---|
packageAlias | string |
packageName | string |
packageOverrides | オブジェクト配列 |
placement
Name | スキーマ |
---|---|
clusterSelector | |
clusters | clusters 配列 |
local | boolean |
placementRef |
clusterSelector
Name | スキーマ |
---|---|
matchExpressions | |
matchLabels | 文字列、文字列マップ |
matchExpressions
Name | スキーマ |
---|---|
key | string |
operator | string |
values | string array |
clusters
Name | スキーマ |
---|---|
name | string |
placementRef
Name | スキーマ |
---|---|
apiVersion | string |
fieldPath | string |
kind | string |
name | string |
namespace | string |
resourceVersion | string |
uid | string |
timewindow
Name | スキーマ |
---|---|
daysofweek | string array |
hours | hours 配列 |
location | string |
windowtype | 列挙 (active、blocked、Active、Blocked) |
hours
Name | スキーマ |
---|---|
end | string |
start | string |
status
Name | スキーマ |
---|---|
lastUpdateTime | 文字列 (date-time) |
message | string |
phase | string |
reason | string |
statuses | object |