1.14. 放置 API (v1beta1)

1.14.1. 概述

本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的放置（Placement）资源相关的 API 信息。放置资源有 4 个可用的请求：create、query、delete 和 update。Placement 定义了一个规则，从绑定到放置命名空间的 ManagedClusterSets 中选择一组 ManagedClusters。会创建一个带有标签 cluster.open-cluster-management.io/placement={placement name} 的 PlacementDecisions 片段，以表示由这个放置选择的 ManagedClusters。

1.14.1.1. 版本信息

版本 : 2.8.0

1.14.1.2. URI scheme

BasePath : /kubernetes/apis
Schemes : HTTPS

1.14.1.3. Tags

cluster.open-cluster-management.io：创建和管理放置

1.14.2. 路径

1.14.2.1. 查询所有放置

GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placement

1.14.2.1.1. 描述

查询您的放置以获取更多详细信息。

1.14.2.1.2. 参数

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：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. Tags

cluster.open-cluster-management.io

1.14.2.2. 创建一个放置

POST /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placements

1.14.2.2.1. 描述

创建一个放置。

1.14.2.2.2. 参数

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
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. Tags

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

1.14.2.3. 查询单个放置

GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placements/{placement_name}

1.14.2.3.1. 描述

查询单个放置以获取更多详细信息。

1.14.2.3.2. 参数

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	placement_name 必需	要查询的放置名称。	字符串

1.14.2.3.3. 响应

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.14.2.3.4. Tags

cluster.open-cluster-management.io

1.14.2.4. 删除一个放置

DELETE /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placements/{placement_name}

1.14.2.4.1. 描述

删除一个放置。

1.14.2.4.2. 参数

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	placement_name 必需	要删除的放置名称。	字符串

1.14.2.4.3. 响应

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.14.2.4.4. Tags

cluster.open-cluster-management.io

1.14.3. 定义

1.14.3.1. Placement

Name	描述	模式
apiVersion 必需	放置的版本化模式。	字符串
kind 必需	代表 REST 资源的字符串值。	字符串
metadata 必需	放置的元数据。	对象
spec 必需	放置的规格。	spec

spec

Name	描述	模式
clusterSets 可选	从中选择 `ManagedClusters` 的 `ManagedClusterSets` 子集。如果 `ManagedClusterSet` 为空，则从绑定到 Placement 命名空间的 `ManagedClusterSets` 中选择 `ManagedClusters`。如果 `ManagedClusterSet` 包含 `ManagedClusters`，`ManagedClusters` 会从这个子集的交集中选择。所选 `ManagedClusterSets` 绑定到放置命名空间。	字符串数组
numberOfClusters 可选	要选择的 `ManagedClusters` 数量。	integer (int32)
predicates 可选	选择 `ManagedClusters` 的集群 predicates 的子集。条件逻辑为 OR。	clusterPredicate 数组
prioritizerPolicy 可选	优先级器的策略。	prioritizerPolicy
tolerations 可选	允许但不是必需的值，通过放置具有匹配容限的放置来选择具有特定污点的受管集群。	容限数组

clusterPredicate

Name	描述	模式
requiredClusterSelector 可选	选择带有标签和集群声明的 `ManagedClusters` 的集群选择器。	clusterSelector

clusterSelector

Name	描述	模式
labelSelector 可选	按标签的 `ManagedClusters` 选择器。	对象
claimSelector 可选	按声明的 `ManagedClusters` 选择器。	clusterClaimSelector

clusterClaimSelector

Name	描述	模式
matchExpressions 可选	集群声明选择器要求的子集。条件逻辑是 AND。	< object > 数组

prioritizerPolicy

Name	描述	模式
mode 可选	`Exact`、`Additive`、或 ""。"" 的默认值为 `Additive`。	字符串
configurations 可选	配置优先级。	prioritizerConfig 数组

prioritizerConfig

Name	描述	模式
scoreCoordinate 必需	配置优先级和分数源。	scoreCoordinate
weight 可选	优先级分数的权重。该值的范围： [-10,10]。	int32

scoreCoordinate

Name	描述	模式
type 必需	优先级分数的类型。有效值为 "BuiltIn" 或 "AddOn"。	字符串
builtIn 可选	来自以下选项的 `BuiltIn` prioritizer 的名称：1）Balance（平衡）：平衡集群之间的决策。2）Steady（稳定）：确保现有决策稳定。3) ResourceAllocatableCPU 和 ResourceAllocatableMemory: 根据可分配资源排序集群。4）Spread（分发）：将工作负载平均到拓扑。	字符串
addOn 可选	当类型为 `AddOn` 时，`AddOn` 定义资源名称和分数名称。	对象

容限 (tolerations)

Name	描述	模式
key 可选	容限应用到的污点键。空表示与所有污点键匹配。	字符串
operator 可选	键与值的关系。有效的运算符为 `Exists` 和 `Equal`。默认值为 `Equal`。	字符串
value 可选	匹配容限的污点值。	字符串
effect 可选	要匹配的污点效果。空意味着匹配所有污点效果。指定后，允许的值是 `NoSelect`、`PreferNoSelect` 和 `NoSelectIfNew`。	字符串
tolerationSeconds 可选	容许污点的时间长度，之后污点不会被容许。默认值为 nil，这表示污点的容许时间没有时间限制。	int64