特性开关 [config.openshift.io/v1] - 配置 API | API 参考 | OpenShift Container Platform 4.17

规范
API 端点

描述

Feature 保持关于特性开关的集群范围信息。规范名称是 cluster 兼容性级别 1：在一个主要版本中稳定至少 12 个月或 3 个次要版本（以较长者为准）。

类型

对象

必需

spec

规范

属性类型描述

属性	类型	描述
`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`	`对象`	spec 包含用户可设置的配置值
`status`	`对象`	status 包含从集群观察到的值。它们不能被覆盖。

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

对象

spec 包含用户可设置的配置值

status

对象

status 包含从集群观察到的值。它们不能被覆盖。

.spec

描述: spec 包含用户可设置的配置值
类型: 对象

属性类型描述

属性	类型	描述
`customNoUpgrade`	``	customNoUpgrade 允许启用或禁用任何功能。启用此功能集不受支持，无法撤消，并且阻止升级。由于其性质，此设置无法验证。如果您有任何错别字或意外应用无效组合，您的集群可能会以无法恢复的方式失败。featureSet 必须等于“CustomNoUpgrade”才能使用此字段。
`featureSet`	`字符串`	featureSet 更改集群中功能的列表。默认值为空。调整此设置时务必小心。启用或禁用功能可能会导致集群中无法撤消的不可逆转更改。

customNoUpgrade

customNoUpgrade 允许启用或禁用任何功能。启用此功能集**不受支持**，**无法撤消**，并且**阻止升级**。由于其性质，此设置无法验证。如果您有任何错别字或意外应用无效组合，您的集群可能会以无法恢复的方式失败。featureSet 必须等于“CustomNoUpgrade”才能使用此字段。

featureSet

字符串

featureSet 更改集群中功能的列表。默认值为空。调整此设置时务必小心。启用或禁用功能可能会导致集群中无法撤消的不可逆转更改。

.status

描述: status 包含从集群观察到的值。它们不能被覆盖。
类型: 对象

属性类型描述

属性	类型	描述
`conditions`	`数组`	conditions 表示当前状态的观察结果。已知的 .status.conditions.type 为：“DeterminationDegraded”
`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"` // 其他字段 }
`featureGates`	`数组`	featureGates 包含已启用和已禁用的 featureGates 列表，这些列表按 payloadVersion 键控。除 CVO 和 cluster-config-operator 之外的运算符必须读取 .status.featureGates，找到他们正在管理的版本，找到已启用/已禁用的 featureGates 并使操作数和运算符匹配。特定版本的已启用/已禁用值在集群的生命周期中可能会发生变化，因为选择了各种 .spec.featureSet 值。运算符可以选择重新启动其进程以获取这些更改，但记住过去的启用/禁用列表超出了此 API 的范围，并且是各个运算符的责任。此列表中只会显示 ClusterVersion.status 中包含 .version 的 featureGates。
`featureGates[]`	`对象`

conditions

数组

conditions 表示当前状态的观察结果。已知的 .status.conditions.type 为：“DeterminationDegraded”

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" // 其他字段 }

featureGates

数组

featureGates 包含已启用和已禁用的 featureGates 列表，这些列表按 payloadVersion 键控。除 CVO 和 cluster-config-operator 之外的运算符必须读取 .status.featureGates，找到他们正在管理的版本，找到已启用/已禁用的 featureGates 并使操作数和运算符匹配。特定版本的已启用/已禁用值在集群的生命周期中可能会发生变化，因为选择了各种 .spec.featureSet 值。运算符可以选择重新启动其进程以获取这些更改，但记住过去的启用/禁用列表超出了此 API 的范围，并且是各个运算符的责任。此列表中只会显示 ClusterVersion.status 中包含 .version 的 featureGates。

featureGates[]

对象

.status.conditions

描述: conditions 表示当前状态的观察结果。已知的 .status.conditions.type 为：“DeterminationDegraded”
类型: 数组

.status.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)

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)

.status.featureGates

描述: featureGates 包含已启用和已禁用的 featureGates 列表，这些列表按 payloadVersion 键控。除 CVO 和 cluster-config-operator 之外的运算符必须读取 .status.featureGates，找到他们正在管理的版本，找到已启用/已禁用的 featureGates 并使操作数和运算符匹配。特定版本的已启用/已禁用值在集群的生命周期中可能会发生变化，因为选择了各种 .spec.featureSet 值。运算符可以选择重新启动其进程以获取这些更改，但记住过去的启用/禁用列表超出了此 API 的范围，并且是各个运算符的责任。此列表中只会显示 ClusterVersion.status 中包含 .version 的 featureGates。
类型: 数组

.status.featureGates[]

描述

类型

对象

必需

版本

属性类型描述

属性	类型	描述
`已禁用`	`数组`	disabled 是在集群中为指定版本禁用的所有特性开关的列表。
`disabled[]`	`对象`
`已启用`	`数组`	enabled 是在集群中为指定版本启用的所有特性开关的列表。
`enabled[]`	`对象`
`版本`	`字符串`	version 与 ClusterVersion 和 ClusterOperator.Status.Versions 字段提供的版本匹配。

已禁用

数组

disabled 是在集群中为指定版本禁用的所有特性开关的列表。

disabled[]

对象

已启用

数组

enabled 是在集群中为指定版本启用的所有特性开关的列表。

enabled[]

对象

版本

字符串

version 与 ClusterVersion 和 ClusterOperator.Status.Versions 字段提供的版本匹配。

.status.featureGates[].disabled

描述: disabled 是在集群中为指定版本禁用的所有特性开关的列表。
类型: 数组

.status.featureGates[].disabled[]

描述

类型

对象

必需

名称

属性类型描述

属性	类型	描述
`名称`	`字符串`	name 是 FeatureGate 的名称。

名称

字符串

name 是 FeatureGate 的名称。

.status.featureGates[].enabled

描述: enabled 是在集群中为指定版本启用的所有特性开关的列表。
类型: 数组

.status.featureGates[].enabled[]

描述

类型

对象

必需

名称

属性类型描述

属性	类型	描述
`名称`	`字符串`	name 是 FeatureGate 的名称。

名称

字符串

name 是 FeatureGate 的名称。

API 端点

提供以下 API 端点

/apis/config.openshift.io/v1/featuregates
- DELETE：删除 FeatureGate 集合
- GET：列出 FeatureGate 类型的对象
- POST：创建一个 FeatureGate
/apis/config.openshift.io/v1/featuregates/{name}
- DELETE：删除一个 FeatureGate
- GET：读取指定的 FeatureGate
- PATCH：部分更新指定的 FeatureGate
- PUT：替换指定的 FeatureGate
/apis/config.openshift.io/v1/featuregates/{name}/status
- GET：读取指定 FeatureGate 的状态
- PATCH：部分更新指定 FeatureGate 的状态
- PUT：替换指定 FeatureGate 的状态

/apis/config.openshift.io/v1/featuregates

HTTP 方法: DELETE
描述: 删除 FeatureGate 集合

表 1. HTTP 响应
HTTP 代码	响应体
200 - OK	`Status` 模式
401 - 未授权	空

HTTP 方法: GET
描述: 列出 FeatureGate 类型的对象

表 2. HTTP 响应
HTTP 代码	响应体
200 - OK	`FeatureGateList` 模式
401 - 未授权	空

HTTP 方法: POST
描述: 创建一个 FeatureGate

表 3. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何被对象静默丢弃的未知字段，并将忽略解码器遇到的所有重复字段（只保留最后一个）。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中丢弃的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍将成功，并且只保留任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 4. 请求体参数
参数	类型	描述
`body`	`FeatureGate` 模式

表 5. HTTP 响应
HTTP 代码	响应体
200 - OK	`FeatureGate` 模式
201 - 已创建	`FeatureGate` 模式
202 - 已接受	`FeatureGate` 模式
401 - 未授权	空

/apis/config.openshift.io/v1/featuregates/{name}

表 6. 全局路径参数
参数	类型	描述
`名称`	`字符串`	FeatureGate 的名称

HTTP 方法: DELETE
描述: 删除一个 FeatureGate

表 7. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

表 8. HTTP 响应
HTTP 代码	响应体
200 - OK	`Status` 模式
202 - 已接受	`Status` 模式
401 - 未授权	空

HTTP 方法: GET
描述: 读取指定的 FeatureGate

表 9. HTTP 响应
HTTP 代码	响应体
200 - OK	`FeatureGate` 模式
401 - 未授权	空

HTTP 方法: PATCH
描述: 部分更新指定的 FeatureGate

表 10. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何被对象静默丢弃的未知字段，并将忽略解码器遇到的所有重复字段（只保留最后一个）。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中丢弃的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍将成功，并且只保留任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 11. HTTP 响应
HTTP 代码	响应体
200 - OK	`FeatureGate` 模式
401 - 未授权	空

HTTP 方法: PUT
描述: 替换指定的 FeatureGate

表 12. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何被对象静默丢弃的未知字段，并将忽略解码器遇到的所有重复字段（只保留最后一个）。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中丢弃的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍将成功，并且只保留任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 13. 请求体参数
参数	类型	描述
`body`	`FeatureGate` 模式

表 14. HTTP 响应
HTTP 代码	响应体
200 - OK	`FeatureGate` 模式
201 - 已创建	`FeatureGate` 模式
401 - 未授权	空

/apis/config.openshift.io/v1/featuregates/{name}/status

表 15. 全局路径参数
参数	类型	描述
`名称`	`字符串`	FeatureGate 的名称

HTTP 方法: GET
描述: 读取指定 FeatureGate 的状态

表 16. HTTP 响应
HTTP 代码	响应体
200 - OK	`FeatureGate` 模式
401 - 未授权	空

HTTP 方法: PATCH
描述: 部分更新指定 FeatureGate 的状态

表 17. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何被对象静默丢弃的未知字段，并将忽略解码器遇到的所有重复字段（只保留最后一个）。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中丢弃的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍将成功，并且只保留任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 18. HTTP 响应
HTTP 代码	响应体
200 - OK	`FeatureGate` 模式
401 - 未授权	空

HTTP 方法: PUT
描述: 替换指定 FeatureGate 的状态

表 19. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何被对象静默丢弃的未知字段，并将忽略解码器遇到的所有重复字段（只保留最后一个）。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中丢弃的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍将成功，并且只保留任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 20. 请求体参数
参数	类型	描述
`body`	`FeatureGate` 模式

表 21. HTTP 响应
HTTP 代码	响应体
200 - OK	`FeatureGate` 模式
201 - 已创建	`FeatureGate` 模式
401 - 未授权	空