11.6. Placements API (v1alpha1)
11.6.1. 概要
このドキュメントは、Kubernetes のマルチクラスターエンジンの配置リソースに関するものです。Placement リソースには、create、query、delete、update の 4 つの要求を使用できます。
11.6.1.1. URI スキーム
ベースパス: /kubernetes/apis
スキーム: HTTPS
11.6.1.2. タグ
- cluster.open-cluster-management.io: Placement を作成して管理します。
11.6.2. パス
11.6.2.1. 全 Placement のクエリー
GET /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/placements11.6.2.1.1. 説明
Placement に対してクエリーを実行して詳細を確認します。
11.6.2.1.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
11.6.2.1.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
11.6.2.1.4. 消費
-
placement/yaml
11.6.2.1.5. タグ
- cluster.open-cluster-management.io
11.6.2.2. Placement の作成
POST /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/placements11.6.2.2.1. 説明
Placement を作成します。
11.6.2.2.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| ボディー |
body | 作成する placement を記述するパラメーター |
11.6.2.2.3. 応答
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
11.6.2.2.4. 消費
-
placement/yaml
11.6.2.2.5. タグ
- cluster.open-cluster-management.io
11.6.2.2.6. HTTP 要求の例
11.6.2.2.6.1. 要求のボディー
{
"apiVersion" : "cluster.open-cluster-management.io/v1alpha1",
"kind" : "Placement",
"metadata" : {
"name" : "placement1",
"namespace": "ns1"
},
"spec": {
"predicates": [
{
"requiredClusterSelector": {
"labelSelector": {
"matchLabels": {
"vendor": "OpenShift"
}
}
}
}
]
},
"status" : { }
}11.6.2.3. 単一の Placement のクエリー
GET /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/placements/{placement_name}11.6.2.3.1. 説明
1 つの Placement に対してクエリーを実行して詳細を確認します。
11.6.2.3.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
placement_name | 問い合わせる Placement の名前 | 文字列 |
11.6.2.3.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
11.6.2.3.4. タグ
- cluster.open-cluster-management.io
11.6.2.4. Placement の削除
DELETE /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/placements/{placement_name}11.6.2.4.1. 説明
単一の Placement を削除します。
11.6.2.4.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
placement_name | 削除する Placement の名前 | 文字列 |
11.6.2.4.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
11.6.2.4.4. タグ
- cluster.open-cluster-management.io
11.6.3. 定義
11.6.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 です。 | < オブジェクト > 配列 |
