主机固件组件 [metal3.io/v1alpha1] - 预配 API | API 参考 | OpenShift 容器平台 4.17

规范
API 端点

描述: HostFirmwareComponents 是 hostfirmwarecomponents API 的模式。
类型: 对象

规范

属性类型描述

属性	类型	描述
`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`	`对象`	HostFirmwareComponentsSpec 定义了 HostFirmwareComponents 的期望状态。
`status`	`对象`	HostFirmwareComponentsStatus 定义了 HostFirmwareComponents 的观察状态。

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

对象

HostFirmwareComponentsSpec 定义了 HostFirmwareComponents 的期望状态。

status

对象

HostFirmwareComponentsStatus 定义了 HostFirmwareComponents 的观察状态。

.spec

描述

HostFirmwareComponentsSpec 定义了 HostFirmwareComponents 的期望状态。

类型

对象

必需

updates

属性类型描述

属性	类型	描述
`updates`	`数组`
`updates[]`	`对象`	FirmwareUpdate 定义了固件更新规范。

updates

数组

updates[]

对象

FirmwareUpdate 定义了固件更新规范。

.spec.updates

描述
类型: 数组

.spec.updates[]

描述

FirmwareUpdate 定义了固件更新规范。

类型

对象

必需

component
url

属性类型描述

属性	类型	描述
`component`	`字符串`
`url`	`字符串`

component

字符串

url

字符串

.status

描述: HostFirmwareComponentsStatus 定义了 HostFirmwareComponents 的观察状态。
类型: 对象

属性类型描述

属性	类型	描述
`components`	`数组`	Components 是所有可用固件组件及其信息的列表。
`components[]`	`对象`	FirmwareComponentStatus 定义了固件组件的状态。
`conditions`	`数组`	跟踪根据模式存储在规范中的更新是否有效
`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"` // 其他字段 }
`lastUpdated`	`字符串`	上次更新状态的时间
`updates`	`数组`	Updates 是所有应更新的固件组件的列表，它们通过名称和 url 字段指定。
`updates[]`	`对象`	FirmwareUpdate 定义了固件更新规范。

components

数组

Components 是所有可用固件组件及其信息的列表。

components[]

对象

FirmwareComponentStatus 定义了固件组件的状态。

conditions

数组

跟踪根据模式存储在规范中的更新是否有效

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

lastUpdated

字符串

上次更新状态的时间

updates

数组

Updates 是所有应更新的固件组件的列表，它们通过名称和 url 字段指定。

updates[]

对象

FirmwareUpdate 定义了固件更新规范。

.status.components

描述: Components 是所有可用固件组件及其信息的列表。
类型: 数组

.status.components[]

描述

FirmwareComponentStatus 定义了固件组件的状态。

类型

对象

必需

component
initialVersion

属性类型描述

属性	类型	描述
`component`	`字符串`
`currentVersion`	`字符串`
`initialVersion`	`字符串`
`lastVersionFlashed`	`字符串`
`updatedAt`	`字符串`

component

字符串

currentVersion

字符串

initialVersion

字符串

lastVersionFlashed

字符串

updatedAt

字符串

.status.conditions

描述: 跟踪根据模式存储在规范中的更新是否有效
类型: 数组

.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.updates

描述: Updates 是所有应更新的固件组件的列表，它们通过名称和 url 字段指定。
类型: 数组

.status.updates[]

描述

FirmwareUpdate 定义了固件更新规范。

类型

对象

必需

component
url

属性类型描述

属性	类型	描述
`component`	`字符串`
`url`	`字符串`

component

字符串

url

字符串

API 端点

提供以下 API 端点

/apis/metal3.io/v1alpha1/hostfirmwarecomponents
- GET：列出 HostFirmwareComponents 类型的对象
/apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwarecomponents
- DELETE：删除 HostFirmwareComponents 集合
- GET：列出 HostFirmwareComponents 类型的对象
- POST：创建 HostFirmwareComponents
/apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwarecomponents/{name}
- DELETE：删除 HostFirmwareComponents
- GET：读取指定的 HostFirmwareComponents
- PATCH：部分更新指定的 HostFirmwareComponents
- PUT：替换指定的 HostFirmwareComponents
/apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwarecomponents/{name}/status
- GET：读取指定的 HostFirmwareComponents 的状态
- PATCH：部分更新指定的 HostFirmwareComponents 的状态
- PUT：替换指定的 HostFirmwareComponents 的状态

/apis/metal3.io/v1alpha1/hostfirmwarecomponents

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

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

/apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwarecomponents

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

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

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

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

HTTP 方法: POST
描述: 创建 HostFirmwareComponents

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

表 5. 请求体参数
参数	类型	描述
`body`	`HostFirmwareComponents` 模式

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

/apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwarecomponents/{name}

表 7. 全局路径参数
参数	类型	描述
`name`	`字符串`	HostFirmwareComponents 的名称

HTTP 方法: DELETE
描述: 删除 HostFirmwareComponents

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

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

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

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

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

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

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

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

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

表 14. 请求体参数
参数	类型	描述
`body`	`HostFirmwareComponents` 模式

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

/apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwarecomponents/{name}/status

表 16. 全局路径参数
参数	类型	描述
`name`	`字符串`	HostFirmwareComponents 的名称

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

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

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

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

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

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

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

表 21. 请求体参数
参数	类型	描述
`body`	`HostFirmwareComponents` 模式

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