OpenShift 文档正在迁移，很快将只在 docs.redhat.com（所有 Red Hat 产品文档的所在地）提供。立即体验 新的文档体验。
  1. 文档
    2. history bug_report picture_as_pdf
×

主机固件设置 [metal3.io/v1alpha1]

规格

属性 类型 描述

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

对象

HostFirmwareSettingsSpec 定义了 HostFirmwareSettings 的期望状态。

status

对象

HostFirmwareSettingsStatus 定义了 HostFirmwareSettings 的观察状态。

.spec

描述

HostFirmwareSettingsSpec 定义了 HostFirmwareSettings 的期望状态。

类型

对象

必需

  • settings

属性 类型 描述

settings

整数或字符串

Settings 是作为名称/值对存储的期望固件设置。

.status

描述

HostFirmwareSettingsStatus 定义了 HostFirmwareSettings 的观察状态。

类型

对象

必需

  • settings

属性 类型 描述

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

字符串

状态最后更新的时间

schema

对象

FirmwareSchema 是对用于描述每个 FirmwareSetting 的模式的引用。默认情况下，这将是与设置在相同命名空间中的模式，但可以在规范中覆盖它。

settings

对象 (字符串)

Settings 是作为名称/值对存储的固件设置。

.status.conditions

描述

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

类型

数组

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

.status.schema

描述

FirmwareSchema 是对用于描述每个 FirmwareSetting 的模式的引用。默认情况下，这将是与设置在相同命名空间中的模式，但可以在规范中覆盖它。

类型

对象

必需

  • 名称

  • 命名空间

属性 类型 描述

名称

字符串

name 是对架构的引用。

命名空间

字符串

namespace 是存储架构的命名空间。

API 端点

提供以下 API 端点：

  • /apis/metal3.io/v1alpha1/hostfirmwaresettings

    • GET：列出 HostFirmwareSettings 类型的对象

  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwaresettings

    • DELETE：删除 HostFirmwareSettings 集合

    • GET：列出 HostFirmwareSettings 类型的对象

    • POST：创建 HostFirmwareSettings

  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwaresettings/{name}

    • DELETE：删除 HostFirmwareSettings

    • GET：读取指定的 HostFirmwareSettings

    • PATCH：部分更新指定的 HostFirmwareSettings

    • PUT：替换指定的 HostFirmwareSettings

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

    • GET：读取指定的 HostFirmwareSettings 的状态

    • PATCH：部分更新指定的 HostFirmwareSettings 的状态

    • PUT：替换指定的 HostFirmwareSettings 的状态

/apis/metal3.io/v1alpha1/hostfirmwaresettings

HTTP 方法

GET

描述

列出 HostFirmwareSettings 类型的对象

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

200 - OK

HostFirmwareSettingsList 架构

401 - 未授权

空

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

HTTP 方法

DELETE

描述

删除 HostFirmwareSettings 集合

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

200 - OK

Status 架构

401 - 未授权

空
HTTP 方法

GET

描述

列出 HostFirmwareSettings 类型的对象

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

200 - OK

HostFirmwareSettingsList 架构

401 - 未授权

空
HTTP 方法

POST

描述

创建 HostFirmwareSettings

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

dryRun

字符串

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

fieldValidation

字符串

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

请求体

HostFirmwareSettings 架构
表 6. HTTP 响应
HTTP 代码 响应体

200 - OK

HostFirmwareSettings 架构

201 - 已创建

HostFirmwareSettings 架构

202 - 已接受

HostFirmwareSettings 架构

401 - 未授权

空

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

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

名称

字符串

HostFirmwareSettings 的名称
HTTP 方法

DELETE

描述

删除 HostFirmwareSettings

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

dryRun

字符串

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

200 - OK

Status 架构

202 - 已接受

Status 架构

401 - 未授权

空
HTTP 方法

GET

描述

读取指定的 HostFirmwareSettings

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

200 - OK

HostFirmwareSettings 架构

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定的 HostFirmwareSettings

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

dryRun

字符串

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

fieldValidation

字符串

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

200 - OK

HostFirmwareSettings 架构

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定的 HostFirmwareSettings

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

dryRun

字符串

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

fieldValidation

字符串

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

请求体

HostFirmwareSettings 架构
表 15. HTTP 响应
HTTP 代码 响应体

200 - OK

HostFirmwareSettings 架构

201 - 已创建

HostFirmwareSettings 架构

401 - 未授权

空

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

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

名称

字符串

HostFirmwareSettings 的名称
HTTP 方法

GET

描述

读取指定的 HostFirmwareSettings 的状态

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

200 - OK

HostFirmwareSettings 架构

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定的 HostFirmwareSettings 的状态

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

dryRun

字符串

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

fieldValidation

字符串

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

200 - OK

HostFirmwareSettings 架构

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定的 HostFirmwareSettings 的状态

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

dryRun

字符串

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

fieldValidation

字符串

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

请求体

HostFirmwareSettings 架构
表 22. HTTP 响应
HTTP 代码 响应体

200 - OK

HostFirmwareSettings 架构

201 - 已创建

HostFirmwareSettings 架构

401 - 未授权

空