Red Hat Summit1.14. Placements API (v1beta1)
1.14.1. 概要
このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes の Placement リソースについて説明します。Placement リソースには、create、query、delete、update の 4 つの要求を使用できます。
1.14.1.1. バージョン情報
バージョン: 2.5.0
1.14.1.2. URI スキーム
ベースパス: /kubernetes/apis
スキーム: HTTPS
1.14.1.3. タグ
- cluster.open-cluster-management.io: Placement を作成して管理します。
1.14.2. パス
1.14.2.1. 全 Placement のクエリー
GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placements
GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placements1.14.2.1.1. 説明
Placement に対してクエリーを実行して詳細を確認します。
1.14.2.1.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
1.14.2.1.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.14.2.1.4. 消費
-
placement/yaml
1.14.2.1.5. タグ
- cluster.open-cluster-management.io
1.14.2.2. Placement の作成
POST /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placements
POST /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placements1.14.2.2.1. 説明
Placement を作成します。
1.14.2.2.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| ボディー |
body | 作成する placement を記述するパラメーター |
1.14.2.2.3. 応答
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.14.2.2.4. 消費
-
placement/yaml
1.14.2.2.5. タグ
- cluster.open-cluster-management.io
1.14.2.2.6. HTTP 要求の例
1.14.2.2.6.1. 要求のボディー
{
"apiVersion" : "cluster.open-cluster-management.io/v1beta1",
"kind" : "Placement",
"metadata" : {
"name" : "placement1",
"namespace": "ns1"
},
"spec": {
"predicates": [
{
"requiredClusterSelector": {
"labelSelector": {
"matchLabels": {
"vendor": "OpenShift"
}
}
}
}
]
},
"status" : { }
}
{
"apiVersion" : "cluster.open-cluster-management.io/v1beta1",
"kind" : "Placement",
"metadata" : {
"name" : "placement1",
"namespace": "ns1"
},
"spec": {
"predicates": [
{
"requiredClusterSelector": {
"labelSelector": {
"matchLabels": {
"vendor": "OpenShift"
}
}
}
}
]
},
"status" : { }
}1.14.2.3. 単一の Placement のクエリー
GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placements/{placement_name}
GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placements/{placement_name}1.14.2.3.1. 説明
1 つの Placement に対してクエリーを実行して詳細を確認します。
1.14.2.3.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
placement_name | 問い合わせる Placement の名前 | 文字列 |
1.14.2.3.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.14.2.3.4. タグ
- cluster.open-cluster-management.io
1.14.2.4. Placement の削除
DELETE /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placements/{placement_name}
DELETE /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placements/{placement_name}1.14.2.4.1. 説明
単一の Placement を削除します。
1.14.2.4.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
placement_name | 削除する Placement の名前 | 文字列 |
1.14.2.4.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.14.2.4.4. タグ
- cluster.open-cluster-management.io
1.14.3. 定義
1.14.3.1. Placement
| 名前 | 説明 | スキーマ |
|---|---|---|
|
apiVersion | Placement のバージョンスキーマ | string |
|
kind | REST リソースを表す文字列の値 | string |
|
metadata | Placement のメタデータ | object |
|
spec | Placement の仕様 |
spec
| 名前 | 説明 | スキーマ |
|---|---|---|
|
ClusterSets | ManagedClusters を選択する ManagedClusterSets のサブセット。空白の場合には、Placement namespace にバインドされる ManagedClusterSets から ManagedClusters が選択されます。それ以外の場合は、ManagedClusters がこのサブセットの交差部分から選択され、ManagedClusterSets は Placement namespace にバインドされます。 | string array |
|
numberOfClusters | 選択する ManagedClusters の必要数 | 整数 (int32) |
|
predicates | ManagedClusters を選択するクラスター述語のサブセット。条件ロジックは OR です。 | clusterPredicate アレイ |
clusterPredicate
| 名前 | 説明 | スキーマ |
|---|---|---|
|
requiredClusterSelector | ラベルおよびクラスター要求のある ManagedClusters を選択するクラスターセレクター |
clusterSelector
| 名前 | 説明 | スキーマ |
|---|---|---|
|
labelSelector | ラベル別の ManagedClusters のセレクター | object |
|
claimSelector | 要求別の ManagedClusters のセレクター |
clusterClaimSelector
| 名前 | 説明 | スキーマ |
|---|---|---|
|
matchExpressions | クラスター要求のセレクター要件のサブセット。条件ロジックは AND です。 | < オブジェクト > 配列 |
'%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}