第 4 章 ControlPlaneMachineSet [machine.openshift.io/v1]

replicas

整数

replicas 定义此 ControlPlaneMachineSet 应该创建多少个 Control Plane Machines。此字段不可变，集群安装后无法更改。ControlPlaneMachineSet 只适用于 3 或 5 个节点 control plane，3 和 5 是此字段的唯一有效值。

selector

object

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

state

string

State 定义 ControlPlaneMachineSet 是否为 Active 或 Inactive。当 Inactive 时，ControlPlaneMachineSet 不会对集群中的机器状态执行任何操作。当 Active 时，ControlPlaneMachineSet 将协调 Machine，并根据需要更新机器。Active 后，无法使 ControlPlaneMachineSet 变为不活动状态。要防止进一步操作，请删除 ControlPlaneMachineSet。

策略

object

strategy 定义 ControlPlaneMachineSet 在检测到 ProviderSpec 更改时如何更新 Machine。

模板

object

模板描述了此 ControlPlaneMachineSet 创建的 Control Plane Machines。

matchExpressions

array

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

matchExpressions[]

对象

标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。

matchLabels

对象（字符串）

matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素，其 key 字段是 "key"，运算符是 "In"，值数组仅包含 "value"。要求的逻辑关系是 AND。

key

字符串

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

operator

字符串

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

值

数组（字符串）

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

type

string

type 定义在更新 ControlPlaneMachineSet 拥有的 Machine 时应使用的更新策略类型。有效值为 "RollingUpdate" 和 "OnDelete"。当前的默认值为 "RollingUpdate"。

machineType

string

machineType 决定应由 ControlPlaneMachineSet 管理的机器类型。目前，唯一有效的值为 machines_v1beta1_machine_openshift_io。

machines_v1beta1_machine_openshift_io

object

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

failureDomains

object

failureDomains 是 ControlPlaneMachineSet 应该平衡 Control Plane Machines 的故障域列表（有时称为可用区）。这将合并到模板中提供的 ProviderSpec。在不需要放置信息的平台上，此字段是可选的。

metadata

object

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

spec

object

spec 包含 Control Plane Machine 所需的配置。中的 ProviderSpec 包含创建 Control Plane Machines 的特定平台详情。除了平台特定的故障域字段外，ProviderSe 应该完成。当基于 FailureDomains 字段创建 Machine 时，这将被覆盖。

aws

数组

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

aws[]

object

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

azure

数组

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

azure[]

object

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

gcp

数组

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

gcp[]

object

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

nutanix

数组

Nutanix 为 Nutanix 平台配置故障域信息。

nutanix[]

object

NutanixFailureDomainReference 是指 Nutanix 平台的故障域。

openstack

数组

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

openstack[]

object

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

platform

string

平台标识 FailureDomain 所代表的平台。目前支持的值有 AWS、Azure、GCP、OpenStack、VSphere 和 Nutanix。

placement

object

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

子网

object

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

availabilityZone

string

AvailabilityZone 是实例的可用区。

arn

string

资源的 ARN。

过滤器

数组

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

filters[]

object

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

id

string

资源的 ID。

type

string

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

name

string

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

values

数组（字符串）

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

子网

string

subnet 是创建虚拟机的网络子网的名称。如果省略时，将使用机器 providerSpec 模板中的 subnet 值。

zone

string

虚拟机的可用区。如果为 nil，则虚拟机应部署到没有区。

zone

string

zone 是 GCP 机器供应商创建虚拟机的区域。

name

string

nutanix 机器供应商创建虚拟机的故障域的名称。故障域在集群的 config.openshift.io/Infrastructure 资源中定义。

availabilityZone

string

availabilityZone 是 OpenStack 计算机提供程序将创建虚拟机的 nova 可用性区域。如果没有指定，虚拟机将在 nova 配置中指定的默认可用区中创建。可用性区域名称不得包含 : 由于管理员用户使用它来指定在服务器创建中启动实例的主机。另外，它不得包含空格，否则它将导致属于此可用区注册失败的节点，请参阅 kubernetes/cloud-provider-openstack foundation79。根据标签限制，可用区名称的最大长度为 63。

rootVolume

object

rootVolume 包含将供 OpenStack 计算机提供程序用于创建附加到虚拟机的 root 卷的设置。如果没有指定，则不会创建根卷。

availabilityZone

string

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

volumeType

string

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

annotations

对象（字符串）

annotations 是一个无结构的键值映射，它存储有资源，可通过外部工具存储和检索任意元数据。它们不可查询，应在修改对象时保留。更多信息： http://kubernetes.io/docs/user-guide/annotations

labels

对象（字符串）

可用于组织和分类（范围和选择）对象的字符串键和值映射。可能与复制控制器和服务选择器匹配。更多信息： http://kubernetes.io/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' 的标签。

lifecycleHooks

object

lifecycleHooks 允许用户在机器生命周期的特定预定义点暂停机器上的操作。

metadata

对象

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

providerID

字符串

providerID 是供应商提供的机器的标识 ID。此字段必须与与此机器对应的节点对象中看到的供应商 ID 匹配。cluster-api 的高级别消费者需要此字段。示例用例是 cluster-api，将 cluster-api 用作供应商。自动缩放器中的清理逻辑将机器与节点进行比较，以查找供应商无法注册为 Kubernetes 节点的机器。使用 cluster-api 作为自动扩展的通用树提供商时，自动扩展需要此字段才能具有机器列表的供应商视图。另一个节点列表是从 k8s apiserver 查询的另一个节点列表，然后做比较以查找未注册的机器并标记为 delete。此字段由行动者设置，并由更高级别的实体（如自动扩展器）使用，该自动扩展将与 cluster-api 作为通用提供程序交互。

providerSpec

对象

providerSpec 详情特定于供应商的配置，以便在节点创建过程中使用。

污点

array

要以增加方式应用到对应节点的污点列表。此列表不会根据其他实体持续覆盖添加到节点的任何其他污点。这些污点应该被主动协调，例如，如果您要求机器控制器应用污点，然后手动删除机器控制器将重新放置的污点，但机器控制器没有删除任何污点

taints[]

对象

此 Taint 附加到任何不容许 Taint 的 pod 上的"effect"的节点。

preDrain

数组

preDrain hook 会阻止机器排空。这也会阻止进一步的生命周期事件，如终止。

preDrain[]

object

LifecycleHook 代表生命周期 hook 的单一实例

preTerminate

数组

preTerminate hook 会阻止机器被终止。在机器排空后，会执行 preTerminate hook。

preTerminate[]

object

LifecycleHook 代表生命周期 hook 的单一实例

name

string

name 为 lifcycle hook 定义唯一名称。名称应是唯一的，最好是 1-3 个单词，在 CamelCase 中，或者可以是命名空间，如 foo.example.com/CamelCase。名称必须是唯一的，并且只能由单个实体管理。

owner

string

Owner 定义生命周期 hook 的所有者。这应该完全描述性，以便用户可以识别谁/负责阻塞生命周期。这可以是控制器的名称（如 clusteroperator/etcd）或管理员管理 hook。

name

string

name 为 lifcycle hook 定义唯一名称。名称应是唯一的，最好是 1-3 个单词，在 CamelCase 中，或者可以是命名空间，如 foo.example.com/CamelCase。名称必须是唯一的，并且只能由单个实体管理。

owner

string

Owner 定义生命周期 hook 的所有者。这应该完全描述性，以便用户可以识别谁/负责阻塞生命周期。这可以是控制器的名称（如 clusteroperator/etcd）或管理员管理 hook。

annotations

对象（字符串）

annotations 是一个无结构的键值映射，它存储有资源，可通过外部工具存储和检索任意元数据。它们不可查询，应在修改对象时保留。更多信息： http://kubernetes.io/docs/user-guide/annotations

generateName

字符串

generateName 是一个可选前缀，服务器使用它来生成唯一的名称 IF，即未提供 Name 字段。如果使用此字段，返回到客户端的名称将与传递的名称不同。这个值也会与唯一的后缀合并。provided 值的验证规则与 Name 字段相同，并可能由使值在服务器上唯一要求的后缀长度截断。如果指定了此字段并且存在生成的名称，服务器将不会返回 409 -，它会返回 201 Created 或 500 with Reason ServerTimeout，表示无法在分配时找到唯一名称，并且客户端应重试（可选在 Retry-After 标头中指定的时间之后）。仅在未指定 Name 时应用。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

labels

对象（字符串）

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

name

字符串

名称在命名空间中必须是唯一的。创建资源时需要一些资源，但有些资源可能会允许客户端自动请求生成适当名称。name 主要用于创建 idempotence 和配置定义。无法更新。更多信息： http://kubernetes.io/docs/user-guide/identifiers#names

namespace

字符串

namespace 定义每个名称中的空间必须是唯一的。空命名空间等同于 "default" 命名空间，但 "default" 是规范表示。不是所有对象都必须限定到命名空间 - 这些对象的这个字段的值为空。必须是 DNS_LABEL。无法更新。更多信息： http://kubernetes.io/docs/user-guide/namespaces

ownerReferences

array

此对象依赖的对象列表。如果列表中删除列表中的 all 对象，则会收集此对象。如果此对象由控制器管理，则此列表中的一个条目将指向此控制器，controller 字段设为 true。不能有多个管理控制器。

ownerReferences[]

对象

OwnerReference 包含足够信息，供您标识拥有的对象。所属对象必须与依赖的命名空间相同，或是集群范围的，因此没有命名空间字段。

apiVersion

字符串

引用的 API 版本。

blockOwnerDeletion

布尔值

如果为 true，并且所有者是否有"foregroundDeletion"终结器，则无法从键值存储中删除所有者，直到此引用被删除为止。有关垃圾收集器如何与此字段交互并强制实施前台删除方式，请参阅 https://kubernetes.io/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.io/docs/concepts/overview/working-with-objects/names#names

uid

字符串

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

value

``

值是资源配置的内联序列化表示。建议供应商维护自己的版本化 API 类型，这些类型应该从此字段序列化/反序列化到组件配置。

effect

字符串

必需。污点对不容许该污点的 pod 的影响。有效效果为 NoSchedule、PreferNoSchedule 和 NoExecute。

key

字符串

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

timeAdded

字符串

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

value

字符串

与污点键对应的污点值。

conditions

数组

条件代表 ControlPlaneMachineSet 当前状态的观察。已知的 .status.conditions.type 是： Available、Degraded 和 Progressing。

conditions[]

对象

条件包含此 API 资源当前状态的一个方面的详情。--- 这个结构旨在直接用作字段路径 .status.conditions 中的数组。例如，输入 FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: "Available", "Progressing", and "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" // other fields }

observedGeneration

整数

observedGeneration 是此 ControlPlaneMachineSet 观察到的最新生成。它对应于 ControlPlaneMachineSets 的生成，该生成在 API 服务器时更新。

readyReplicas

整数

readyReplicas 是 ControlPlaneMachineSet 控制器创建的 Control Plane Machines 数量。请注意，在滚动更新正在进行时，这个值可能大于所需的副本数。

replicas

整数

replicas 是 ControlPlaneMachineSet 控制器创建的 Control Plane Machine 数量。请注意，在更新操作时，这个值可能与所需的副本数不同。

unavailableReplicas

整数

UnavailableReplicas 是 ControlPlaneMachineSet 达到所需的可用容量前仍需要的 Control Plane Machine 数量。当这个值为零时，ReadyReplicas 的数量会小于所需的 Replicas。

updatedReplicas

整数

UpdatedReplicas 是 ControlPlaneMachineSet 控制器创建的、具有所需供应商 spec 和就绪状态创建的非终止 Control Plane 机器数量。当检测到到所需的 spec 更改时，这个值被设置为 0。当更新策略是 RollingUpdate 时，这也与开始更新机器的过程一致。当更新策略时，这个值将保持在 0，直到用户删除现有副本并且其替换就绪为止。

lastTransitionTime

字符串

lastTransitionTime 是条件从一个状态转换到另一个状态最后一次的时间。这应该是底层条件变化的时间。如果为未知，则使用 API 字段更改的时间是可以接受的。

message

字符串

Message 是人类可读的消息，指示有关转换的详细信息。这可能是一个空字符串。

observedGeneration

整数

observedGeneration 代表 .metadata.generation，这是条件设置所基于的条件。例如，如果 .metadata.generation 目前为 12，但 .status.conditions[x].observedGeneration 是 9，则代表条件与实例的当前状态已不匹配。

reason

字符串

reason 包含程序标识符，指示条件最后一次转换的原因。特定条件类型的制作者可能会定义预期的值和此字段的含义，以及这些值是否被视为有保证的 API。该值应该是 CamelCase 字符串。此字段可能不是空的。

status

字符串

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

type

字符串

CamelCase 或 foo.example.com/CamelCase 中的条件类型。-- Many .condition.type 值在资源间是一致的，但因为任意条件可能很有用（请参阅 .node.status.conditions），deconflict 的能力非常重要。它匹配的正则表达式是 (dns1123SubdomainFmt/)? (qualifiedNameFmt)