×
描述

ControlPlaneMachineSet 确保在任何给定时间运行指定数量的控制平面机器副本。兼容性级别 1:在主要版本中稳定至少 12 个月或 3 个次要版本(以较长者为准)。

类型

对象

规格

属性 类型 描述

apiVersion

字符串

APIVersion 定义了此对象表示的版本化模式。服务器应将识别的模式转换为最新的内部值,并可能拒绝无法识别的值。更多信息:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

字符串

Kind 是一个字符串值,表示此对象表示的 REST 资源。服务器可以从客户端提交请求的端点推断出这一点。无法更新。使用驼峰命名法。更多信息:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

标准对象的元数据。更多信息:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

对象

ControlPlaneMachineSet 表示 ControlPlaneMachineSet 的配置。

status

对象

ControlPlaneMachineSetStatus 表示 ControlPlaneMachineSet CRD 的状态。

.spec

描述

ControlPlaneMachineSet 表示 ControlPlaneMachineSet 的配置。

类型

对象

必需
  • replicas

  • selector

  • template

属性 类型 描述

replicas

整数

Replicas 定义此 ControlPlaneMachineSet 应创建多少个控制平面机器。此字段是不可变的,集群安装后无法更改。ControlPlaneMachineSet 只操作具有 3 个或 5 个节点的控制平面,3 和 5 是此字段的唯一有效值。

selector

对象

机器的标签选择器。通过此选择器选择的现有机器将受此 ControlPlaneMachineSet 影响。它必须与模板的标签匹配。此字段在资源创建后被认为是不可变的。

state

字符串

State 定义 ControlPlaneMachineSet 是 Active 还是 Inactive。当为 Inactive 时,ControlPlaneMachineSet 将不会对集群中机器的状态采取任何操作。当为 Active 时,ControlPlaneMachineSet 将协调机器,并根据需要更新机器。一旦处于 Active 状态,ControlPlaneMachineSet 就无法变为 Inactive 状态。要阻止进一步的操作,请删除 ControlPlaneMachineSet。

strategy

对象

Strategy 定义当 ControlPlaneMachineSet 检测到 ProviderSpec 的更改时,它将如何更新机器。

template

对象

Template 描述将由此 ControlPlaneMachineSet 创建的控制平面机器。

.spec.selector

描述

机器的标签选择器。通过此选择器选择的现有机器将受此 ControlPlaneMachineSet 影响。它必须与模板的标签匹配。此字段在资源创建后被认为是不可变的。

类型

对象

属性 类型 描述

matchExpressions

数组

matchExpressions 是标签选择器要求的列表。这些要求是 AND 关系。

matchExpressions[]

对象

标签选择器要求是一个包含值、键和运算符的选择器,这些运算符将键和值关联起来。

matchLabels

对象(字符串)

matchLabels 是 {key,value} 对的映射。matchLabels 映射中的单个 {key,value} 等效于 matchExpressions 的一个元素,其 key 字段为“key”,运算符为“In”,而 values 数组仅包含“value”。这些要求是 AND 关系。

.spec.selector.matchExpressions

描述

matchExpressions 是标签选择器要求的列表。这些要求是 AND 关系。

类型

数组

.spec.selector.matchExpressions[]

描述

标签选择器要求是一个包含值、键和运算符的选择器,这些运算符将键和值关联起来。

类型

对象

必需
  • key

  • operator

属性 类型 描述

key

字符串

key 是选择器应用到的标签键。

operator

字符串

operator 表示键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。

values

数组(字符串)

values 是字符串值的数组。如果运算符是 In 或 NotIn,则 values 数组必须是非空的。如果运算符是 Exists 或 DoesNotExist,则 values 数组必须为空。此数组在策略性合并补丁期间会被替换。

.spec.strategy

描述

Strategy 定义当 ControlPlaneMachineSet 检测到 ProviderSpec 的更改时,它将如何更新机器。

类型

对象

属性 类型 描述

type

字符串

Type 定义更新 ControlPlaneMachineSet 拥有的机器时应使用的更新策略类型。有效值为“RollingUpdate”和“OnDelete”。当前默认值为“RollingUpdate”。

.spec.template

描述

Template 描述将由此 ControlPlaneMachineSet 创建的控制平面机器。

类型

对象

必需
  • machineType

属性 类型 描述

machineType

字符串

MachineType 确定应由 ControlPlaneMachineSet 管理的机器类型。当前,唯一有效的值是 machines_v1beta1_machine_openshift_io。

machines_v1beta1_machine_openshift_io

对象

OpenShiftMachineV1Beta1Machine 定义从 v1beta1.machine.openshift.io API 组创建机器的模板。

.spec.template.machines_v1beta1_machine_openshift_io

描述

OpenShiftMachineV1Beta1Machine 定义从 v1beta1.machine.openshift.io API 组创建机器的模板。

类型

对象

必需
  • metadata

  • spec

属性 类型 描述

failureDomains

对象

FailureDomains 是 ControlPlaneMachineSet 应该在其上平衡控制平面机器的故障域(有时称为可用区)列表。这将合并到模板中给出的 ProviderSpec 中。在不需要放置信息的平台上,此字段是可选的。

metadata

对象

ObjectMeta 是标准对象元数据 更多信息:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata 标签必须与 ControlPlaneMachineSet 选择器匹配。

spec

对象

Spec 包含控制平面机器的所需配置。内部的 ProviderSpec 包含创建控制平面机器的平台特定详细信息。ProviderSpec 应该除了平台特定的故障域字段之外是完整的。在基于 FailureDomains 字段创建机器时,这将被覆盖。

.spec.template.machines_v1beta1_machine_openshift_io.failureDomains

描述

FailureDomains 是 ControlPlaneMachineSet 应该在其上平衡控制平面机器的故障域(有时称为可用区)列表。这将合并到模板中给出的 ProviderSpec 中。在不需要放置信息的平台上,此字段是可选的。

类型

对象

必需
  • platform

属性 类型 描述

aws

数组

AWS 配置 AWS 平台的故障域信息。

aws[]

对象

AWSFailureDomain 配置 AWS 平台的故障域信息。

azure

数组

Azure 配置 Azure 平台的故障域信息。

azure[]

对象

AzureFailureDomain 配置 Azure 平台的故障域信息。

gcp

数组

GCP 配置 GCP 平台的故障域信息。

gcp[]

对象

GCPFailureDomain 配置 GCP 平台的故障域信息

nutanix

数组

nutanix 配置 Nutanix 平台的故障域信息。

nutanix[]

对象

NutanixFailureDomainReference 指的是 Nutanix 平台的故障域。

openstack

数组

OpenStack 配置 OpenStack 平台的故障域信息。

openstack[]

对象

OpenStackFailureDomain 配置 OpenStack 平台的故障域信息。

platform

字符串

Platform 标识 FailureDomain 代表的平台。当前支持的值为 AWS、Azure、GCP、OpenStack、VSphere 和 Nutanix。

vsphere

数组

vsphere 配置 VSphere 平台的故障域信息。

vsphere[]

对象

VSphereFailureDomain 配置 vSphere 平台的故障域信息

.spec.template.machines_v1beta1_machine_openshift_io.failureDomains.aws

描述

AWS 配置 AWS 平台的故障域信息。

类型

数组

.spec.template.machines_v1beta1_machine_openshift_io.failureDomains.aws[]

描述

AWSFailureDomain 配置 AWS 平台的故障域信息。

类型

对象

属性 类型 描述

placement

对象

Placement 配置此实例的放置信息。

subnet

对象

Subnet 是对要为此实例使用的子网的引用。

.spec.template.machines_v1beta1_machine_openshift_io.failureDomains.aws[].placement

描述

Placement 配置此实例的放置信息。

类型

对象

必需
  • availabilityZone

属性 类型 描述

availabilityZone

字符串

AvailabilityZone 是实例的可用区。

.spec.template.machines_v1beta1_machine_openshift_io.failureDomains.aws[].subnet

描述

Subnet 是对要为此实例使用的子网的引用。

类型

对象

必需
  • type

属性 类型 描述

arn

字符串

资源的 ARN。

filters

数组

Filters 是一组用于标识资源的过滤器。

filters[]

对象

AWSResourceFilter 是用于标识 AWS 资源的过滤器

id

字符串

资源的 ID。

type

字符串

Type 确定引用将如何获取 AWS 资源。

.spec.template.machines_v1beta1_machine_openshift_io.failureDomains.aws[].subnet.filters

描述

Filters 是一组用于标识资源的过滤器。

类型

数组

.spec.template.machines_v1beta1_machine_openshift_io.failureDomains.aws[].subnet.filters[]

描述

AWSResourceFilter 是用于标识 AWS 资源的过滤器

类型

对象

必需
  • name

属性 类型 描述

name

字符串

过滤器的名称。过滤器名称区分大小写。

values

数组(字符串)

Values 包含一个或多个过滤器值。过滤器值区分大小写。

.spec.template.machines_v1beta1_machine_openshift_io.failureDomains.azure

描述

Azure 配置 Azure 平台的故障域信息。

类型

数组

.spec.template.machines_v1beta1_machine_openshift_io.failureDomains.azure[]

描述

AzureFailureDomain 配置 Azure 平台的故障域信息。

类型

对象

必需
  • 区域

属性 类型 描述

subnet

字符串

子网是将创建虚拟机的网络子网名称。省略此项时,将使用机器 providerSpec 模板中的子网值。

区域

字符串

虚拟机的可用区。如果为 nil,则虚拟机不应部署到任何区域。

.spec.template.machines_v1beta1_machine_openshift_io.failureDomains.gcp

描述

GCP 配置 GCP 平台的故障域信息。

类型

数组

.spec.template.machines_v1beta1_machine_openshift_io.failureDomains.gcp[]

描述

GCPFailureDomain 配置 GCP 平台的故障域信息

类型

对象

必需
  • 区域

属性 类型 描述

区域

字符串

区域是 GCP 机器提供程序将在其中创建虚拟机的区域。

.spec.template.machines_v1beta1_machine_openshift_io.failureDomains.nutanix

描述

nutanix 配置 Nutanix 平台的故障域信息。

类型

数组

.spec.template.machines_v1beta1_machine_openshift_io.failureDomains.nutanix[]

描述

NutanixFailureDomainReference 指的是 Nutanix 平台的故障域。

类型

对象

必需
  • name

属性 类型 描述

name

字符串

Nutanix 机器提供程序将在其中创建虚拟机的故障域名称。故障域在集群的 config.openshift.io/Infrastructure 资源中定义。

.spec.template.machines_v1beta1_machine_openshift_io.failureDomains.openstack

描述

OpenStack 配置 OpenStack 平台的故障域信息。

类型

数组

.spec.template.machines_v1beta1_machine_openshift_io.failureDomains.openstack[]

描述

OpenStackFailureDomain 配置 OpenStack 平台的故障域信息。

类型

对象

属性 类型 描述

availabilityZone

字符串

availabilityZone 是 OpenStack 机器提供程序将在其中创建虚拟机的 Nova 可用区。如果未指定,则虚拟机将在 nova 配置中指定的默认可用区中创建。可用区名称不得包含“:”符号,因为管理员用户使用它来指定在服务器创建中启动实例的主机。此外,它不得包含空格,否则将导致属于此可用区的节点注册失败,有关详细信息,请参阅 kubernetes/cloud-provider-openstack#1379。根据标签限制,可用区名称的最大长度为 63 个字符。

根卷

对象

rootVolume 包含 OpenStack 机器提供程序将用于创建附加到虚拟机的根卷的设置。如果未指定,则不会创建根卷。

.spec.template.machines_v1beta1_machine_openshift_io.failureDomains.openstack[].rootVolume

描述

rootVolume 包含 OpenStack 机器提供程序将用于创建附加到虚拟机的根卷的设置。如果未指定,则不会创建根卷。

类型

对象

必需
  • 卷类型

属性 类型 描述

availabilityZone

字符串

availabilityZone 指定将创建根卷的 Cinder 可用区。如果未指定,则根卷将在 cinder 配置中由卷类型指定的可用区中创建。如果卷类型(在 OpenStack 集群中配置)未指定可用区,则根卷将在 cinder 配置中指定的默认可用区中创建。有关详细信息,请参阅 https://docs.openstack.org/cinder/latest/admin/availability-zone-type.html。如果 OpenStack 集群部署时 cross_az_attach 配置选项设置为 false,则根卷必须与虚拟机位于同一可用区(由 OpenStackFailureDomain.AvailabilityZone 定义)。可用区名称不得包含空格,否则将导致属于此可用区的卷注册失败,有关详细信息,请参阅 kubernetes/cloud-provider-openstack#1379。根据标签限制,可用区名称的最大长度为 63 个字符。

卷类型

字符串

volumeType 指定将配置的根卷的类型。根据 OpenStack 限制,卷类型名称的最大长度为 255 个字符。

.spec.template.machines_v1beta1_machine_openshift_io.failureDomains.vsphere

描述

vsphere 配置 VSphere 平台的故障域信息。

类型

数组

.spec.template.machines_v1beta1_machine_openshift_io.failureDomains.vsphere[]

描述

VSphereFailureDomain 配置 vSphere 平台的故障域信息

类型

对象

必需
  • name

属性 类型 描述

name

字符串

vSphere 机器提供程序将在其中创建虚拟机的故障域名称。故障域在集群的 config.openshift.io/Infrastructure 资源中定义。在故障域之间平衡机器时,控制平面机器集将把来自 Infrastructure 资源的配置注入机器 providerSpec 中,以将机器分配到故障域。

.spec.template.machines_v1beta1_machine_openshift_io.metadata

描述

ObjectMeta 是标准对象元数据 更多信息:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata 标签必须与 ControlPlaneMachineSet 选择器匹配。

类型

对象

必需
  • 标签

属性 类型 描述

注释

对象(字符串)

注释是存储在资源中的非结构化键值映射,外部工具可以使用它来存储和检索任意元数据。它们不可查询,在修改对象时应予以保留。更多信息:https://kubernetes.ac.cn/docs/user-guide/annotations

标签

对象(字符串)

字符串键和值的映射,可用于组织和分类(范围和选择)对象。可能与复制控制器和服务的选取器匹配。更多信息:https://kubernetes.ac.cn/docs/user-guide/labels。此字段必须同时包含“machine.openshift.io/cluster-api-machine-role”和“machine.openshift.io/cluster-api-machine-type”标签,两者值均为“master”。它还必须包含一个键为“machine.openshift.io/cluster-api-cluster”的标签。

.spec.template.machines_v1beta1_machine_openshift_io.spec

描述

Spec 包含控制平面机器的所需配置。内部的 ProviderSpec 包含创建控制平面机器的平台特定详细信息。ProviderSpec 应该除了平台特定的故障域字段之外是完整的。在基于 FailureDomains 字段创建机器时,这将被覆盖。

类型

对象

属性 类型 描述

生命周期钩子

对象

生命周期钩子允许用户在机器生命周期的某些预定义点暂停机器上的操作。

metadata

对象

ObjectMeta 将自动填充创建的节点。使用此项指示创建节点时应使用哪些标签、注释、名称前缀等。

提供程序ID

字符串

ProviderID 是提供程序提供的机器的标识 ID。此字段必须与在对应于此机器的节点对象上看到的提供程序 ID 匹配。此字段是集群 API 的高级使用者所需的。用例示例是使用集群 API 作为提供程序的集群自动缩放器。自动缩放器中的清理逻辑比较机器和节点以找出无法注册为 Kubernetes 节点的提供程序上的机器。使用集群 API 作为自动缩放器的通用外部树提供程序,自动缩放器需要此字段才能拥有机器列表的提供程序视图。从 k8s apiserver 查询节点的另一个列表,然后进行比较以找出未注册的机器并将其标记为删除。此字段将由执行器设置,并由诸如将与集群 API 作为通用提供程序交互的自动缩放器之类的更高级别的实体使用。

提供程序规范

对象

ProviderSpec 详细说明节点创建期间使用的特定于提供程序的配置。

污点

数组

以累加方式应用于相应节点的污点列表。此列表不会覆盖其他实体持续添加到节点的任何其他污点。这些污点应主动协调(例如,如果您要求机器控制器应用污点,然后手动删除污点,机器控制器将将其放回),但不应让机器控制器删除任何污点。

污点[]

对象

附加此污点的节点对任何不宽容此污点的 Pod 具有“影响”。

.spec.template.machines_v1beta1_machine_openshift_io.spec.lifecycleHooks

描述

生命周期钩子允许用户在机器生命周期的某些预定义点暂停机器上的操作。

类型

对象

属性 类型 描述

预排空

数组

PreDrain 钩子阻止机器被排空。这还会阻止进一步的生命周期事件,例如终止。

preDrain[]

对象

LifecycleHook 代表生命周期钩子的单个实例。

预终止

数组

PreTerminate 钩子阻止机器被终止。在机器被排空后,可以执行 PreTerminate 钩子。

preTerminate[]

对象

LifecycleHook 代表生命周期钩子的单个实例。

.spec.template.machines_v1beta1_machine_openshift_io.spec.lifecycleHooks.preDrain

描述

PreDrain 钩子阻止机器被排空。这还会阻止进一步的生命周期事件,例如终止。

类型

数组

.spec.template.machines_v1beta1_machine_openshift_io.spec.lifecycleHooks.preDrain[]

描述

LifecycleHook 代表生命周期钩子的单个实例。

类型

对象

必需
  • name

  • 所有者

属性 类型 描述

name

字符串

Name 定义生命周期钩子的唯一名称。名称应唯一且具有描述性,理想情况下为 1-3 个单词,使用驼峰式命名法,或者可以命名空间,例如 foo.example.com/CamelCase。名称必须唯一,并且只能由单个实体管理。

所有者

字符串

Owner 定义生命周期钩子的所有者。这应该具有足够的描述性,以便用户能够识别谁/什么负责阻塞生命周期。这可以是控制器名称(例如 clusteroperator/etcd)或管理钩子的管理员。

.spec.template.machines_v1beta1_machine_openshift_io.spec.lifecycleHooks.preTerminate

描述

PreTerminate 钩子阻止机器被终止。在机器被排空后,可以执行 PreTerminate 钩子。

类型

数组

.spec.template.machines_v1beta1_machine_openshift_io.spec.lifecycleHooks.preTerminate[]

描述

LifecycleHook 代表生命周期钩子的单个实例。

类型

对象

必需
  • name

  • 所有者

属性 类型 描述

name

字符串

Name 定义生命周期钩子的唯一名称。名称应唯一且具有描述性,理想情况下为 1-3 个单词,使用驼峰式命名法,或者可以命名空间,例如 foo.example.com/CamelCase。名称必须唯一,并且只能由单个实体管理。

所有者

字符串

Owner 定义生命周期钩子的所有者。这应该具有足够的描述性,以便用户能够识别谁/什么负责阻塞生命周期。这可以是控制器名称(例如 clusteroperator/etcd)或管理钩子的管理员。

.spec.template.machines_v1beta1_machine_openshift_io.spec.metadata

描述

ObjectMeta 将自动填充创建的节点。使用此项指示创建节点时应使用哪些标签、注释、名称前缀等。

类型

对象

属性 类型 描述

注释

对象(字符串)

注释是存储在资源中的非结构化键值映射,外部工具可以使用它来存储和检索任意元数据。它们不可查询,在修改对象时应予以保留。更多信息:https://kubernetes.ac.cn/docs/user-guide/annotations

generateName

字符串

GenerateName 是一个可选的前缀,由服务器使用,仅当未提供 Name 字段时才生成唯一名称。如果使用此字段,则返回给客户端的名称将与传入的名称不同。此值还将与一个唯一的后缀组合。提供的值具有与 Name 字段相同的验证规则,并且可能会根据使值在服务器上唯一所需的尾缀长度而被截断。如果指定此字段并且生成的名称存在,服务器将不会返回 409 - 相反,它将返回 201 已创建或 500,原因是 ServerTimeout 指示在分配的时间内找不到唯一名称,客户端应重试(可选地在 Retry-After 标头中指示的时间之后)。仅当未指定 Name 时才应用。更多信息:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

标签

对象(字符串)

字符串键值对的映射,可用于组织和分类(范围和选择)对象。可能与复制控制器的选择器和服务匹配。更多信息:https://kubernetes.ac.cn/docs/user-guide/labels

name

字符串

Name 在命名空间内必须唯一。创建资源时是必需的,尽管某些资源可能允许客户端请求自动生成合适的名称。Name 主要用于创建幂等性和配置定义。不能更新。更多信息:https://kubernetes.ac.cn/docs/user-guide/identifiers#names

namespace

字符串

Namespace 定义每个名称必须唯一的空间。空命名空间等效于“default”命名空间,但“default”是规范表示。并非所有对象都需要限定到命名空间 - 这些对象的此字段的值将为空。必须是 DNS_LABEL。不能更新。更多信息:https://kubernetes.ac.cn/docs/user-guide/namespaces

ownerReferences

数组

此对象依赖的对象列表。如果列表中的所有对象都已被删除,则此对象将被垃圾回收。如果此对象由控制器管理,则此列表中的一个条目将指向此控制器,并将 controller 字段设置为 true。不能有多个管理控制器。

ownerReferences[]

对象

OwnerReference 包含足够的信息,可让您识别拥有对象。拥有对象必须与被依赖对象位于同一命名空间中,或者必须是集群范围的,因此没有命名空间字段。

.spec.template.machines_v1beta1_machine_openshift_io.spec.metadata.ownerReferences

描述

此对象依赖的对象列表。如果列表中的所有对象都已被删除,则此对象将被垃圾回收。如果此对象由控制器管理,则此列表中的一个条目将指向此控制器,并将 controller 字段设置为 true。不能有多个管理控制器。

类型

数组

.spec.template.machines_v1beta1_machine_openshift_io.spec.metadata.ownerReferences[]

描述

OwnerReference 包含足够的信息,可让您识别拥有对象。拥有对象必须与被依赖对象位于同一命名空间中,或者必须是集群范围的,因此没有命名空间字段。

类型

对象

必需
  • apiVersion

  • kind

  • name

  • uid

属性 类型 描述

apiVersion

字符串

引用的 API 版本。

blockOwnerDeletion

布尔值

如果为 true,并且所有者具有“foregroundDeletion”最终器,则在删除此引用之前,无法从键值存储中删除所有者。请参阅https://kubernetes.ac.cn/docs/concepts/architecture/garbage-collection/#foreground-deletion,了解垃圾收集器如何与此字段交互并强制执行前台删除。默认为 false。要设置此字段,用户需要所有者的“删除”权限,否则将返回 422(不可处理的实体)。

controller

布尔值

如果为 true,则此引用指向管理控制器。

kind

字符串

引用的种类。更多信息:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

name

字符串

引用的名称。更多信息:https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/names#names

uid

字符串

引用的 UID。更多信息:https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/names#uids

.spec.template.machines_v1beta1_machine_openshift_io.spec.providerSpec

描述

ProviderSpec 详细说明节点创建期间使用的特定于提供程序的配置。

类型

对象

属性 类型 描述

value

``

Value 是资源配置的内联序列化表示。建议提供者维护他们自己的版本化 API 类型,这些类型应该从此字段序列化/反序列化,类似于组件配置。

.spec.template.machines_v1beta1_machine_openshift_io.spec.taints

描述

以累加方式应用于相应节点的污点列表。此列表不会覆盖其他实体持续添加到节点的任何其他污点。这些污点应主动协调(例如,如果您要求机器控制器应用污点,然后手动删除污点,机器控制器将将其放回),但不应让机器控制器删除任何污点。

类型

数组

.spec.template.machines_v1beta1_machine_openshift_io.spec.taints[]

描述

附加此污点的节点对任何不宽容此污点的 Pod 具有“影响”。

类型

对象

必需
  • effect

  • key

属性 类型 描述

effect

字符串

必需。污点对不忍受污点的 Pod 的影响。有效的影响是 NoSchedule、PreferNoSchedule 和 NoExecute。

key

字符串

必需。要应用于节点的污点键。

timeAdded

字符串

TimeAdded 表示添加污点的时间。它仅针对 NoExecute 污点写入。

value

字符串

与污点键对应的污点值。

.status

描述

ControlPlaneMachineSetStatus 表示 ControlPlaneMachineSet CRD 的状态。

类型

对象

属性 类型 描述

conditions

数组

Conditions 表示对 ControlPlaneMachineSet 当前状态的观察。已知的 .status.conditions.type 为:Available、Degraded 和 Progressing。

conditions[]

对象

Condition 包含此 API 资源当前状态的一个方面的详细信息。--- 此结构旨在直接用作字段路径 .status.conditions 的数组。例如,类型 FooStatus struct{ // 表示 foo 当前状态的观察结果。 // 已知的 .status.conditions.type 为:“Available”、“Progressing”和“Degraded” // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // 其他字段 }

observedGeneration

整数

ObservedGeneration 是为此 ControlPlaneMachineSet 观察到的最新一代。它对应于 ControlPlaneMachineSets 的 generation,该 generation 通过 API 服务器在变异时更新。

readyReplicas

整数

ReadyReplicas 是 ControlPlaneMachineSet 控制器创建的已准备就绪的控制平面机器的数量。请注意,在滚动更新进行中时,此值可能高于所需的副本数量。

replicas

整数

Replicas 是 ControlPlaneMachineSet 控制器创建的控制平面机器的数量。请注意,在更新操作期间,此值可能与所需的副本计数不同。

unavailableReplicas

整数

UnavailableReplicas 是在 ControlPlaneMachineSet 达到所需的可用容量之前仍然需要的控制平面机器的数量。当此值非零时,ReadyReplicas 的数量小于所需的 Replicas。

updatedReplicas

整数

UpdatedReplicas 表示由 ControlPlaneMachineSet 控制器创建的、具有所需提供程序规范且已准备就绪的非终止控制平面机器数量。当检测到所需规范发生更改时,此值将设置为 0。当更新策略为 RollingUpdate 时,这还将与启动机器更新过程同时发生。当更新策略为 OnDelete 时,此值将保持为 0,直到用户删除现有副本及其替换副本已准备就绪。

.status.conditions

描述

Conditions 表示对 ControlPlaneMachineSet 当前状态的观察。已知的 .status.conditions.type 为:Available、Degraded 和 Progressing。

类型

数组

.status.conditions[]

描述

Condition 包含此 API 资源当前状态的一个方面的详细信息。--- 此结构旨在直接用作字段路径 .status.conditions 的数组。例如,类型 FooStatus struct{ // 表示 foo 当前状态的观察结果。 // 已知的 .status.conditions.type 为:“Available”、“Progressing”和“Degraded” // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // 其他字段 }

类型

对象

必需
  • lastTransitionTime

  • message

  • reason

  • status

  • type

属性 类型 描述

lastTransitionTime

字符串

lastTransitionTime 是条件从一种状态转换到另一种状态的最后时间。这应该是底层条件发生变化的时间。如果不知道,则可以使用 API 字段更改的时间。

message

字符串

message 是一条人性化的消息,指示有关转换的详细信息。这可能是一个空字符串。

observedGeneration

整数

observedGeneration 表示设置条件的 .metadata.generation。例如,如果 .metadata.generation 当前为 12,但 .status.conditions[x].observedGeneration 为 9,则该条件相对于实例的当前状态已过期。

reason

字符串

reason 包含一个程序标识符,指示条件上次转换的原因。特定条件类型的生产者可以为此字段定义预期的值和含义,以及这些值是否被视为保证的 API。该值应为驼峰式字符串。此字段不能为空。

status

字符串

条件的状态,True、False、Unknown 之一。

type

字符串

条件的类型,使用驼峰式命名法或 foo.example.com/CamelCase 格式。——许多 .condition.type 值在资源中是一致的,例如 Available,但由于任意条件可能很有用(参见 .node.status.conditions),因此去冲突的能力非常重要。它匹配的正则表达式为 (dns1123SubdomainFmt/)?(qualifiedNameFmt)

API 端点

提供以下 API 端点

  • /apis/machine.openshift.io/v1/controlplanemachinesets

    • GET:列出 ControlPlaneMachineSet 类型的对象

  • /apis/machine.openshift.io/v1/namespaces/{namespace}/controlplanemachinesets

    • DELETE:删除 ControlPlaneMachineSet 集合

    • GET:列出 ControlPlaneMachineSet 类型的对象

    • POST:创建一个 ControlPlaneMachineSet

  • /apis/machine.openshift.io/v1/namespaces/{namespace}/controlplanemachinesets/{name}

    • DELETE:删除一个 ControlPlaneMachineSet

    • GET:读取指定的 ControlPlaneMachineSet

    • PATCH:部分更新指定的 ControlPlaneMachineSet

    • PUT:替换指定的 ControlPlaneMachineSet

  • /apis/machine.openshift.io/v1/namespaces/{namespace}/controlplanemachinesets/{name}/scale

    • GET:读取指定的 ControlPlaneMachineSet 的规模

    • PATCH:部分更新指定的 ControlPlaneMachineSet 的规模

    • PUT:替换指定的 ControlPlaneMachineSet 的规模

  • /apis/machine.openshift.io/v1/namespaces/{namespace}/controlplanemachinesets/{name}/status

    • GET:读取指定的 ControlPlaneMachineSet 的状态

    • PATCH:部分更新指定的 ControlPlaneMachineSet 的状态

    • PUT:替换指定的 ControlPlaneMachineSet 的状态

/apis/machine.openshift.io/v1/controlplanemachinesets

HTTP 方法

GET

描述

列出 ControlPlaneMachineSet 类型的对象

表 1. HTTP 响应
HTTP 代码 响应体

200 - OK

ControlPlaneMachineSetList 模式

401 - 未授权

/apis/machine.openshift.io/v1/namespaces/{namespace}/controlplanemachinesets

HTTP 方法

DELETE

描述

删除 ControlPlaneMachineSet 集合

表 2. HTTP 响应
HTTP 代码 响应体

200 - OK

Status 模式

401 - 未授权

HTTP 方法

GET

描述

列出 ControlPlaneMachineSet 类型的对象

表 3. HTTP 响应
HTTP 代码 响应体

200 - OK

ControlPlaneMachineSetList 模式

401 - 未授权

HTTP 方法

POST

描述

创建一个 ControlPlaneMachineSet

表 4. 查询参数
参数 类型 描述

dryRun

字符串

如果存在,则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应,并且不会进一步处理请求。有效值为:- All:将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为:- Ignore:这将忽略任何静默从对象中删除的未知字段,并将忽略解码器遇到的所有重复字段中的最后一个字段。这是 v1.23 之前的默认行为。- Warn:这将通过标准警告响应标头为每个从对象中删除的未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误,请求仍将成功,并且只会保留任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict:如果任何未知字段将从对象中删除,或者存在任何重复字段,则这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 5. 请求体参数
参数 类型 描述

body

ControlPlaneMachineSet 模式

表 6. HTTP 响应
HTTP 代码 响应体

200 - OK

ControlPlaneMachineSet 模式

201 - 已创建

ControlPlaneMachineSet 模式

202 - 已接受

ControlPlaneMachineSet 模式

401 - 未授权

/apis/machine.openshift.io/v1/namespaces/{namespace}/controlplanemachinesets/{name}

表 7. 全局路径参数
参数 类型 描述

name

字符串

ControlPlaneMachineSet 的名称

HTTP 方法

DELETE

描述

删除一个 ControlPlaneMachineSet

表 8. 查询参数
参数 类型 描述

dryRun

字符串

如果存在,则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应,并且不会进一步处理请求。有效值为:- All:将处理所有 dry run 阶段

表 9. HTTP 响应
HTTP 代码 响应体

200 - OK

Status 模式

202 - 已接受

Status 模式

401 - 未授权

HTTP 方法

GET

描述

读取指定的 ControlPlaneMachineSet

表 10. HTTP 响应
HTTP 代码 响应体

200 - OK

ControlPlaneMachineSet 模式

401 - 未授权

HTTP 方法

PATCH

描述

部分更新指定的 ControlPlaneMachineSet

表 11. 查询参数
参数 类型 描述

dryRun

字符串

如果存在,则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应,并且不会进一步处理请求。有效值为:- All:将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为:- Ignore:这将忽略任何静默从对象中删除的未知字段,并将忽略解码器遇到的所有重复字段中的最后一个字段。这是 v1.23 之前的默认行为。- Warn:这将通过标准警告响应标头为每个从对象中删除的未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误,请求仍将成功,并且只会保留任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict:如果任何未知字段将从对象中删除,或者存在任何重复字段,则这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 12. HTTP 响应
HTTP 代码 响应体

200 - OK

ControlPlaneMachineSet 模式

401 - 未授权

HTTP 方法

PUT

描述

替换指定的 ControlPlaneMachineSet

表 13. 查询参数
参数 类型 描述

dryRun

字符串

如果存在,则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应,并且不会进一步处理请求。有效值为:- All:将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为:- Ignore:这将忽略任何静默从对象中删除的未知字段,并将忽略解码器遇到的所有重复字段中的最后一个字段。这是 v1.23 之前的默认行为。- Warn:这将通过标准警告响应标头为每个从对象中删除的未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误,请求仍将成功,并且只会保留任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict:如果任何未知字段将从对象中删除,或者存在任何重复字段,则这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 14. 请求体参数
参数 类型 描述

body

ControlPlaneMachineSet 模式

表 15. HTTP 响应
HTTP 代码 响应体

200 - OK

ControlPlaneMachineSet 模式

201 - 已创建

ControlPlaneMachineSet 模式

401 - 未授权

/apis/machine.openshift.io/v1/namespaces/{namespace}/controlplanemachinesets/{name}/scale

表 16. 全局路径参数
参数 类型 描述

name

字符串

ControlPlaneMachineSet 的名称

HTTP 方法

GET

描述

读取指定的 ControlPlaneMachineSet 的规模

表 17. HTTP 响应
HTTP 代码 响应体

200 - OK

Scale 模式

401 - 未授权

HTTP 方法

PATCH

描述

部分更新指定的 ControlPlaneMachineSet 的规模

表 18. 查询参数
参数 类型 描述

dryRun

字符串

如果存在,则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应,并且不会进一步处理请求。有效值为:- All:将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为:- Ignore:这将忽略任何静默从对象中删除的未知字段,并将忽略解码器遇到的所有重复字段中的最后一个字段。这是 v1.23 之前的默认行为。- Warn:这将通过标准警告响应标头为每个从对象中删除的未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误,请求仍将成功,并且只会保留任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict:如果任何未知字段将从对象中删除,或者存在任何重复字段,则这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 19. HTTP 响应
HTTP 代码 响应体

200 - OK

Scale 模式

401 - 未授权

HTTP 方法

PUT

描述

替换指定的 ControlPlaneMachineSet 的规模

表 20. 查询参数
参数 类型 描述

dryRun

字符串

如果存在,则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应,并且不会进一步处理请求。有效值为:- All:将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为:- Ignore:这将忽略任何静默从对象中删除的未知字段,并将忽略解码器遇到的所有重复字段中的最后一个字段。这是 v1.23 之前的默认行为。- Warn:这将通过标准警告响应标头为每个从对象中删除的未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误,请求仍将成功,并且只会保留任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict:如果任何未知字段将从对象中删除,或者存在任何重复字段,则这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 21. 请求体参数
参数 类型 描述

body

Scale 模式

表 22. HTTP 响应
HTTP 代码 响应体

200 - OK

Scale 模式

201 - 已创建

Scale 模式

401 - 未授权

/apis/machine.openshift.io/v1/namespaces/{namespace}/controlplanemachinesets/{name}/status

表 23. 全局路径参数
参数 类型 描述

name

字符串

ControlPlaneMachineSet 的名称

HTTP 方法

GET

描述

读取指定的 ControlPlaneMachineSet 的状态

表 24. HTTP 响应
HTTP 代码 响应体

200 - OK

ControlPlaneMachineSet 模式

401 - 未授权

HTTP 方法

PATCH

描述

部分更新指定的 ControlPlaneMachineSet 的状态

表 25. 查询参数
参数 类型 描述

dryRun

字符串

如果存在,则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应,并且不会进一步处理请求。有效值为:- All:将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为:- Ignore:这将忽略任何静默从对象中删除的未知字段,并将忽略解码器遇到的所有重复字段中的最后一个字段。这是 v1.23 之前的默认行为。- Warn:这将通过标准警告响应标头为每个从对象中删除的未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误,请求仍将成功,并且只会保留任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict:如果任何未知字段将从对象中删除,或者存在任何重复字段,则这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 26. HTTP 响应
HTTP 代码 响应体

200 - OK

ControlPlaneMachineSet 模式

401 - 未授权

HTTP 方法

PUT

描述

替换指定的 ControlPlaneMachineSet 的状态

表 27. 查询参数
参数 类型 描述

dryRun

字符串

如果存在,则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应,并且不会进一步处理请求。有效值为:- All:将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为:- Ignore:这将忽略任何静默从对象中删除的未知字段,并将忽略解码器遇到的所有重复字段中的最后一个字段。这是 v1.23 之前的默认行为。- Warn:这将通过标准警告响应标头为每个从对象中删除的未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误,请求仍将成功,并且只会保留任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict:如果任何未知字段将从对象中删除,或者存在任何重复字段,则这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 28. 请求体参数
参数 类型 描述

body

ControlPlaneMachineSet 模式

表 29. HTTP 响应
HTTP 代码 响应体

200 - OK

ControlPlaneMachineSet 模式

201 - 已创建

ControlPlaneMachineSet 模式

401 - 未授权