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

对象

PreprovisioningImageSpec 定义了 PreprovisioningImage 的期望状态。

status

对象

PreprovisioningImageStatus 定义了 PreprovisioningImage 的观察状态。

.spec

描述

PreprovisioningImageSpec 定义了 PreprovisioningImage 的期望状态。

类型

对象

属性 类型 描述

acceptFormats

数组 (字符串)

acceptFormats 是可接受的镜像格式列表。

architecture

字符串

architecture 是要为其构建镜像的处理器架构。

networkDataName

字符串

networkDataName是在本地命名空间中包含用于构建镜像的网络数据的密钥名称。

.status

描述

PreprovisioningImageStatus 定义了 PreprovisioningImage 的观察状态。

类型

对象

属性 类型 描述

architecture

字符串

architecture是为其构建镜像的处理器架构。

conditions

数组

conditions描述了已构建镜像的状态。

conditions[]

对象

Condition包含此API资源当前状态的一个方面的详细信息。--- 此结构旨在直接用作字段路径.status.conditions的数组。例如，类型FooStatus结构体{ // 表示对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" // 其他字段}

extraKernelParams

字符串

extraKernelParams是一个字符串，包含在通过网络启动镜像时传递给内核的额外参数。仅对initrd镜像有意义。

format

字符串

format是可在下载URL中获得的镜像类型：iso或initrd。

imageUrl

字符串

imageUrl是可从中下载已构建镜像的URL。

kernelUrl

字符串

kernelUrl是可从中下载镜像内核的URL。仅对initrd镜像有意义。

networkData

对象

networkData是对包含用于构建镜像的网络数据的密钥版本的引用。

.status.conditions

描述

conditions描述了已构建镜像的状态。

类型

数组

.status.conditions[]

描述

Condition包含此API资源当前状态的一个方面的详细信息。--- 此结构旨在直接用作字段路径.status.conditions的数组。例如，类型FooStatus结构体{ // 表示对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/驼峰式。--- 许多.condition.type值在资源中是一致的，例如Available，但是由于任意条件可能很有用（参见.node.status.conditions），因此消除冲突的能力非常重要。它匹配的正则表达式是(dns1123SubdomainFmt/)?(qualifiedNameFmt)

.status.networkData

描述

networkData是对包含用于构建镜像的网络数据的密钥版本的引用。

类型

对象

属性 类型 描述

name

字符串

version

字符串

API端点

提供以下API端点：

  • /apis/metal3.io/v1alpha1/preprovisioningimages

    • GET：列出PreprovisioningImage类型的对象

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

    • DELETE：删除PreprovisioningImage集合

    • GET：列出PreprovisioningImage类型的对象

    • POST：创建一个PreprovisioningImage

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

    • DELETE：删除一个PreprovisioningImage

    • GET：读取指定的PreprovisioningImage

    • PATCH：部分更新指定的PreprovisioningImage

    • PUT：替换指定的PreprovisioningImage

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

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

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

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

/apis/metal3.io/v1alpha1/preprovisioningimages

HTTP方法

GET

描述

列出PreprovisioningImage类型的对象

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

200 - OK

PreprovisioningImageList模式

401 - 未授权

空

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

HTTP方法

DELETE

描述

删除PreprovisioningImage集合

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

200 - OK

Status模式

401 - 未授权

空
HTTP方法

GET

描述

列出PreprovisioningImage类型的对象

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

200 - OK

PreprovisioningImageList模式

401 - 未授权

空
HTTP方法

POST

描述

创建一个PreprovisioningImage

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

dryRun

字符串

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

fieldValidation

字符串

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

请求体

PreprovisioningImage模式
表6. HTTP响应
HTTP代码 响应体

200 - OK

PreprovisioningImage模式

201 - 已创建

PreprovisioningImage模式

202 - 已接受

PreprovisioningImage模式

401 - 未授权

空

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

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

name

字符串

PreprovisioningImage的名称
HTTP方法

DELETE

描述

删除一个PreprovisioningImage

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

dryRun

字符串

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

200 - OK

Status模式

202 - 已接受

Status模式

401 - 未授权

空
HTTP方法

GET

描述

读取指定的PreprovisioningImage

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

200 - OK

PreprovisioningImage模式

401 - 未授权

空
HTTP方法

PATCH

描述

部分更新指定的PreprovisioningImage

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

dryRun

字符串

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

fieldValidation

字符串

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

200 - OK

PreprovisioningImage模式

401 - 未授权

空
HTTP方法

PUT

描述

替换指定的PreprovisioningImage

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

dryRun

字符串

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

fieldValidation

字符串

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

请求体

PreprovisioningImage模式
表15. HTTP响应
HTTP代码 响应体

200 - OK

PreprovisioningImage模式

201 - 已创建

PreprovisioningImage模式

401 - 未授权

空

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

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

name

字符串

PreprovisioningImage的名称
HTTP方法

GET

描述

读取指定的PreprovisioningImage的状态

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

200 - OK

PreprovisioningImage模式

401 - 未授权

空
HTTP方法

PATCH

描述

部分更新指定的PreprovisioningImage的状态

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

dryRun

字符串

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

fieldValidation

字符串

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

200 - OK

PreprovisioningImage模式

401 - 未授权

空
HTTP方法

PUT

描述

替换指定的PreprovisioningImage的状态

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

dryRun

字符串

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

fieldValidation

字符串

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

请求体

PreprovisioningImage模式
表22. HTTP响应
HTTP代码 响应体

200 - OK

PreprovisioningImage模式

201 - 已创建

PreprovisioningImage模式

401 - 未授权

空