1.14. Placement API (v1beta1)

1.14.1. 概要

このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes の Placement リソースについて説明します。Placement リソースには、create、query、delete、update の 4 つのリクエストを使用できます。Placement は、placement namespace にバインドされている ManagedClusterSets から一連の ManagedClusters を選択するルールを定義します。ラベル cluster.open-cluster-management.io/placement={placement name} を持つ PlacementDecisions のスライスが作成され、この配置によって選択される ManagedClusters が表されます。

1.14.1.1. バージョン情報

バージョン: 2.10.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}/placement

1.14.2.1.1. 説明

Placement に対してクエリーを実行して詳細を確認します。

1.14.2.1.2. パラメーター

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

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

1.14.2.2.1. 説明

Placement を作成します。

1.14.2.2.2. パラメーター

型	名前	説明	スキーマ
Header	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	string
Body	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. 要求の body

{
  "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}

1.14.2.3.1. 説明

1 つの Placement に対してクエリーを実行して詳細を確認します。

1.14.2.3.2. パラメーター

型	名前	説明	スキーマ
Header	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	string
パス	placement_name 必須	問い合わせる Placement の名前	string

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}

1.14.2.4.1. 説明

単一の Placement を削除します。

1.14.2.4.2. パラメーター

型	名前	説明	スキーマ
Header	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	string
パス	placement_name 必須	削除する Placement の名前	string

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

spec

名前	説明	スキーマ
clusterSets 任意	`ManagedClusters` の選択元となる `ManagedClusterSets` のサブセット。`ManagedClusterSet` が空の場合、`ManagedClusters` は Placement namespace にバインドされている `ManagedClusterSets` から選択されます。`ManagedClusterSet` に `ManagedClusters` が含まれている場合、`ManagedClusters` はこのサブセットの交差部分から選択されます。選択された `ManagedClusterSets` は placement namespace にバインドされます。	string array
numberOfClusters 任意	選択する `ManagedClusters` の数。	integer (int32)
predicates 任意	`ManagedClusters` を選択するクラスター述語のサブセット。条件ロジックは OR です。	clusterPredicate アレイ
prioritizerPolicy 任意	プライオリタイザーのポリシー。	prioritizerPolicy
tolerations 任意	特定の Taint を持つマネージドクラスターが、一致する許容範囲を持つプレースメントによって選択されることを許可するが、必須ではない値。	toleration array

clusterPredicate

名前	説明	スキーマ
requiredClusterSelector 任意	ラベルおよびクラスター要求のある `ManagedClusters` を選択するクラスターセレクター。	clusterSelector

clusterSelector

名前	説明	スキーマ
labelSelector 任意	ラベル別の `ManagedClusters` のセレクター。	object
claimSelector 任意	要求別の `ManagedClusters` のセレクター。	clusterClaimSelector

clusterClaimSelector

名前	説明	スキーマ
matchExpressions 任意	クラスター要求セレクター要件のサブセット。条件ロジックは AND です。	< object > array

prioritizerPolicy

名前	説明	スキーマ
mode 任意	`Exact`、`Additive`、または "" のいずれか。"" のデフォルト値は `Additive` です。	string
configurations 任意	プライオリタイザーの設定。	prioritizerConfig array

prioritizerConfig

名前	説明	スキーマ
scoreCoordinate 必須	プライオリタイザーおよびスコアソースの設定。	scoreCoordinate
weight 任意	プライオリタイザースコアの重み。値は [-10,10] の範囲内である必要があります。	int32

scoreCoordinate

名前	説明	スキーマ
type 必須	プライオリタイザースコアのタイプ。有効な値は "BuiltIn" または "AddOn" です。	string
builtIn 任意	次のオプションからの `BuiltIn` プライオリタイザーの名前: 1) バランス: クラスター間の決定のバランスをとります。2) 安定: 既存の決定が安定していることを確認します。3) ResourceAllocatableCPU & ResourceAllocatableMemory: 割り当て可能なリソースに基づいてクラスターを分類します。4) 分散: ワークロードをトポロジーに均等に分散します。	string
addOn 任意	type が `AddOn` の場合、`AddOn` はリソース名とスコア名を定義します。	object

容認

名前	説明	スキーマ
key 任意	Toleration が適用される Taint キー。空は、すべての Taint キーに一致することを意味します。	string
operator 任意	キーと値の関係。有効な Operator は `Exists` および `Equal` です。デフォルト値は `Equal` です。	string
value 任意	Toleration に一致する Taint 値。	string
effect 任意	一致する Taint 効果。空は、すべての Taint 効果に一致することを意味します。指定した場合、許可される値は `NoSelect`、`PreferNoSelect`、および `NoSelectIfNew` です。	string
tolerationSeconds 任意	Taint が許容される時間の長さ。その後、Taint は許容されません。デフォルト値は nil です。これは、Taint が許容される期間に時間制限がないことを示します。	int64