Red Hat Summit1.6. Subscriptions API
1.6.1. 概要
このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes の Subscription リソースを説明します。Subscription リソースには、create、query、delete、update の 4 つの要求を使用できます。非推奨: PlacementRule
1.6.1.1. バージョン情報
バージョン: 2.11.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}/subscriptions1.6.2.1.1. 説明
サブスクリプションを作成します。
1.6.2.1.2. パラメーター
| タイプ | 名前 | 設定 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
namespace | 使用する namespace (例: default) | string |
| Body |
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. 要求の 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}/subscriptions1.6.2.2.1. 説明
サブスクリプションにクエリーを行い、詳細を確認します。
1.6.2.2.2. パラメーター
| タイプ | 名前 | 設定 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
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 |
| Path |
namespace | 使用する namespace (例: default) | string |
| Path |
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 |
| Path |
namespace | 使用する namespace (例: default) | string |
| Path |
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. サブスクリプション
metadata
| 名前 | スキーマ |
|---|---|
|
annotations | object |
|
labels | object |
|
name | string |
|
namespace | string |
spec
| 名前 | スキーマ |
|---|---|
|
channel | string |
|
name | string |
|
overrides | overrides array |
|
packageFilter | |
|
packageOverrides | packageOverrides array |
|
placement | |
|
timewindow |
overrides
| 名前 | スキーマ |
|---|---|
|
clusterName | string |
|
clusterOverrides | object array |
packageFilter
| 名前 | 設定 | スキーマ |
|---|---|---|
|
annotations | string、string map | |
|
filterRef | ||
|
labelSelector | ||
|
version |
Pattern : | string |
filterRef
| 名前 | スキーマ |
|---|---|
|
name | string |
labelSelector
| 名前 | スキーマ |
|---|---|
|
matchExpressions | matchExpressions array |
|
matchLabels | string、string map |
matchExpressions
| 名前 | スキーマ |
|---|---|
|
key | string |
|
operator | string |
|
values | string array |
packageOverrides
| 名前 | スキーマ |
|---|---|
|
packageAlias | string |
|
packageName | string |
|
packageOverrides | object array |
placement
| 名前 | スキーマ |
|---|---|
|
clusterSelector | |
|
clusters | clusters array |
|
local | boolean |
|
placementRef |
clusterSelector
| 名前 | スキーマ |
|---|---|
|
matchExpressions | matchExpressions array |
|
matchLabels | string、string map |
matchExpressions
| 名前 | スキーマ |
|---|---|
|
key | string |
|
operator | string |
|
values | string array |
clusters
| 名前 | スキーマ |
|---|---|
|
name | string |
placementRef
| 名前 | スキーマ |
|---|---|
|
apiVersion | string |
|
fieldPath | string |
|
kind | string |
|
name | string |
|
namespace | string |
|
resourceVersion | string |
|
uid | string |
timewindow
| 名前 | スキーマ |
|---|---|
|
daysofweek | string array |
|
hours | hours array |
|
location | string |
|
windowtype | 列挙 (active、blocked、Active、Blocked) |
hours
| 名前 | スキーマ |
|---|---|
|
end | string |
|
start | string |
status
| 名前 | スキーマ |
|---|---|
|
lastUpdateTime | string (date-time) |
|
message | string |
|
phase | string |
|
reason | string |
|
statuses | object |
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}