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

模板实例 [template.openshift.io/v1]

规范

属性 类型 描述

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_v2

metadata 是标准对象的元数据。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

对象

TemplateInstanceSpec 描述了 TemplateInstance 的期望状态。

status

对象

TemplateInstanceStatus 描述了 TemplateInstance 的当前状态。

.spec

描述

TemplateInstanceSpec 描述了 TemplateInstance 的期望状态。

类型

对象

必需

  • template

属性 类型 描述

requester

对象

TemplateInstanceRequester 保存请求模板实例化的代理的身份。

secret

LocalObjectReference_v2

secret 是对 Secret 对象的引用，其中包含必要的模板参数。

template

对象

Template 包含生成 Config 所需的输入。

兼容性级别 1：在主要版本中稳定至少 12 个月或 3 个次要版本（以较长者为准）。

.spec.requester

描述

TemplateInstanceRequester 保存请求模板实例化的代理的身份。

类型

对象

属性 类型 描述

extra

对象

extra 包含身份验证器提供的其他信息。

extra{}

数组 (字符串)

groups

数组 (字符串)

groups 代表此用户所属的组。

uid

字符串

uid 是一个唯一值，用于跨时间标识此用户；如果此用户被删除，并且添加了另一个同名用户，他们将拥有不同的 UID。

用户名

字符串

用户名唯一地标识所有活跃用户中的此用户。

.spec.requester.extra

描述

extra 包含身份验证器提供的其他信息。

类型

对象

.spec.template

描述

Template 包含生成 Config 所需的输入。

兼容性级别 1：在主要版本中稳定至少 12 个月或 3 个次要版本（以较长者为准）。

类型

对象

必需

  • 对象

属性 类型 描述

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

标签

对象 (字符串)

labels 是一个可选的标签集，在模板到配置转换期间应用于每个对象。

消息

字符串

message 是一个可选的指示性消息，在实例化此模板时将显示。此字段应告知用户如何使用新创建的资源。参数替换将在显示之前对消息执行，以便生成的凭据和其他参数可以包含在输出中。

metadata

ObjectMeta_v2

metadata 是标准对象的元数据。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

对象

数组 (RawExtension)

objects 是一个资源数组，包含在此模板中。如果在对象中硬编码了命名空间值，则在模板实例化期间将删除它，但是如果命名空间值是或包含 ${PARAMETER_REFERENCE}，则参数替换后的解析值将被尊重，并且对象将在该命名空间中创建。

参数

数组

parameters 是在模板到配置转换期间使用的参数的可选数组。

parameters[]

对象

Parameter 定义一个名称/值变量，该变量将在模板到配置转换期间进行处理。

.spec.template.parameters

描述

parameters 是在模板到配置转换期间使用的参数的可选数组。

类型

数组

.spec.template.parameters[]

描述

Parameter 定义一个名称/值变量，该变量将在模板到配置转换期间进行处理。

类型

对象

必需

  • 名称

属性 类型 描述

描述

字符串

参数的描述。可选。

显示名称

字符串

可选：在 UI 中显示的名称，而不是参数“名称”。

来自

字符串

From 是生成器的输入值。可选。

生成

字符串

generate 指定用于根据 From 字段指定的输入值生成随机字符串的生成器。结果字符串存储在 Value 字段中。如果为空，则不使用生成器，结果 Value 保持不变。可选。

唯一支持的生成器是“expression”，它接受“from”值，该值采用包含范围表达式“[a-zA-Z0-9]”和长度表达式“a{length}”的简单正则表达式的形式。

示例

from | value ----------------------------- "test[0-9]{1}x" | "test7x" "[0-1]{8}" | "01001100" "0x[A-F0-9]{4}" | "0xB3AF" "[a-zA-Z0-9]{8}" | "hW4yQU5i"

名称

字符串

必须设置 Name，并且可以使用 ${PARAMETER_NAME} 在模板项目中引用它。必需。

必需

布尔值

可选：指示参数必须具有值。默认为 false。

值

字符串

Value 保存参数数据。如果指定，则将忽略生成器。该值替换模板到配置转换期间参数 ${Name} 表达式的所有出现。可选。

.status

描述

TemplateInstanceStatus 描述了 TemplateInstance 的当前状态。

类型

对象

属性 类型 描述

条件

数组

conditions 代表 TemplateInstance 当前状态的最新可用观测值。

conditions[]

对象

TemplateInstanceCondition 包含 TemplateInstance 的条件信息。

对象

数组

Objects 引用由 TemplateInstance 创建的对象。

objects[]

对象

TemplateInstanceObject 引用由 TemplateInstance 创建的对象。

.status.conditions

描述

conditions 代表 TemplateInstance 当前状态的最新可用观测值。

类型

数组

.status.conditions[]

描述

TemplateInstanceCondition 包含 TemplateInstance 的条件信息。

类型

对象

必需

  • 类型

  • status

  • 最后转换时间

  • 原因

  • 消息

属性 类型 描述

最后转换时间

时间

LastTransitionTime 是条件状态从一个状态转换到另一个状态的最后时间。

消息

字符串

Message 是对最后转换细节的人类可读描述，补充了原因。

原因

字符串

Reason 是对条件最后转换的简短机器可读解释。

status

字符串

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

类型

字符串

条件的类型，当前为 Ready 或 InstantiateFailure。

.status.objects

描述

Objects 引用由 TemplateInstance 创建的对象。

类型

数组

.status.objects[]

描述

TemplateInstanceObject 引用由 TemplateInstance 创建的对象。

类型

对象

属性 类型 描述

引用

ObjectReference

ref 是对已创建对象的引用。在 .spec 下使用时，仅使用 name 和 namespace；这些可以包含对参数的引用，这些参数将按照通常的规则进行替换。

API 端点

提供以下 API 端点

  • /apis/template.openshift.io/v1/templateinstances

    • GET：列出或监视 TemplateInstance 类型对象

  • /apis/template.openshift.io/v1/watch/templateinstances

    • GET：监视对 TemplateInstance 列表的单个更改。已弃用：改为使用列表操作中的“watch”参数。

  • /apis/template.openshift.io/v1/namespaces/{namespace}/templateinstances

    • DELETE：删除 TemplateInstance 集合

    • GET：列出或监视 TemplateInstance 类型对象

    • POST：创建 TemplateInstance

  • /apis/template.openshift.io/v1/watch/namespaces/{namespace}/templateinstances

    • GET：监视对 TemplateInstance 列表的单个更改。已弃用：改为使用列表操作中的“watch”参数。

  • /apis/template.openshift.io/v1/namespaces/{namespace}/templateinstances/{name}

    • DELETE：删除 TemplateInstance

    • GET：读取指定的 TemplateInstance

    • PATCH：部分更新指定的 TemplateInstance

    • PUT：替换指定的 TemplateInstance

  • /apis/template.openshift.io/v1/watch/namespaces/{namespace}/templateinstances/{name}

    • GET：监视 TemplateInstance 类型对象的更改。已弃用：改为使用列表操作中的“watch”参数，并使用“fieldSelector”参数过滤为单个项目。

  • /apis/template.openshift.io/v1/namespaces/{namespace}/templateinstances/{name}/status

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

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

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

/apis/template.openshift.io/v1/templateinstances

HTTP 方法

GET

描述

列出或监视 TemplateInstance 类型对象

表 1. HTTP 响应
HTTP 代码 响应正文

200 - OK

TemplateInstanceList 模式

401 - 未授权

空

/apis/template.openshift.io/v1/watch/templateinstances

HTTP 方法

GET

描述

监视对 TemplateInstance 列表的单个更改。已弃用：改为使用列表操作中的“watch”参数。

表 2. HTTP 响应
HTTP 代码 响应正文

200 - OK

WatchEvent 模式

401 - 未授权

空

/apis/template.openshift.io/v1/namespaces/{namespace}/templateinstances

HTTP 方法

DELETE

描述

删除 TemplateInstance 集合

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

dryRun

字符串

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

200 - OK

Status_v10 模式

401 - 未授权

空
HTTP 方法

GET

描述

列出或监视 TemplateInstance 类型对象

表 5. HTTP 响应
HTTP 代码 响应正文

200 - OK

TemplateInstanceList 模式

401 - 未授权

空
HTTP 方法

POST

描述

创建 TemplateInstance

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

dryRun

字符串

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

fieldValidation

字符串

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

主体

TemplateInstance 模式
表 8. HTTP 响应
HTTP 代码 响应正文

200 - OK

TemplateInstance 模式

201 - 已创建

TemplateInstance 模式

202 - 已接受

TemplateInstance 模式

401 - 未授权

空

/apis/template.openshift.io/v1/watch/namespaces/{namespace}/templateinstances

HTTP 方法

GET

描述

监视对 TemplateInstance 列表的单个更改。已弃用：改为使用列表操作中的“watch”参数。

表 9. HTTP 响应
HTTP 代码 响应正文

200 - OK

WatchEvent 模式

401 - 未授权

空

/apis/template.openshift.io/v1/namespaces/{namespace}/templateinstances/{name}

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

名称

字符串

TemplateInstance 的名称
HTTP 方法

DELETE

描述

删除 TemplateInstance

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

dryRun

字符串

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

200 - OK

Status_v10 模式

202 - 已接受

Status_v10 模式

401 - 未授权

空
HTTP 方法

GET

描述

读取指定的 TemplateInstance

表 13. HTTP 响应
HTTP 代码 响应正文

200 - OK

TemplateInstance 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定的 TemplateInstance

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

dryRun

字符串

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

fieldValidation

字符串

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

200 - OK

TemplateInstance 模式

201 - 已创建

TemplateInstance 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定的 TemplateInstance

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

dryRun

字符串

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

fieldValidation

字符串

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

主体

TemplateInstance 模式
表 18. HTTP 响应
HTTP 代码 响应正文

200 - OK

TemplateInstance 模式

201 - 已创建

TemplateInstance 模式

401 - 未授权

空

/apis/template.openshift.io/v1/watch/namespaces/{namespace}/templateinstances/{name}

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

名称

字符串

TemplateInstance 的名称
HTTP 方法

GET

描述

监听 TemplateInstance 对象的更改。已弃用：请改用列表操作中的“watch”参数，并使用“fieldSelector”参数将其过滤为单个项目。

表 20. HTTP 响应
HTTP 代码 响应正文

200 - OK

WatchEvent 模式

401 - 未授权

空

/apis/template.openshift.io/v1/namespaces/{namespace}/templateinstances/{name}/status

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

名称

字符串

TemplateInstance 的名称
HTTP 方法

GET

描述

读取指定的 TemplateInstance 的状态

表 22. HTTP 响应
HTTP 代码 响应正文

200 - OK

TemplateInstance 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定的 TemplateInstance 的状态

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

dryRun

字符串

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

fieldValidation

字符串

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

200 - OK

TemplateInstance 模式

201 - 已创建

TemplateInstance 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定的 TemplateInstance 的状态

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

dryRun

字符串

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

fieldValidation

字符串

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

主体

TemplateInstance 模式
表 27. HTTP 响应
HTTP 代码 响应正文

200 - OK

TemplateInstance 模式

201 - 已创建

TemplateInstance 模式

401 - 未授权

空