模板 [template.openshift.io/v1] - 模板 API | API 参考 | OpenShift 容器平台 4.17

规范
- .parameters
- .parameters[]
API 端点

描述

模板包含生成配置所需的输入。

兼容性级别 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`	`对象（字符串）`	labels 是在模板到配置转换期间应用于每个对象的可选标签集。
`message`	`字符串`	message 是一个可选的指导性消息，在实例化此模板时将显示。此字段应告知用户如何使用新创建的资源。在显示之前，将对消息执行参数替换，以便生成的凭据和其他参数可以包含在输出中。
`metadata`	`ObjectMeta_v2`	metadata 是标准对象的元数据。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`对象`	`数组 (RawExtension)`	objects 是要包含在此模板中的资源数组。如果在对象中硬编码了命名空间值，则在模板实例化期间将将其删除，但是如果命名空间值是或包含 ${PARAMETER_REFERENCE}，则参数替换后的解析值将被尊重，并且对象将在该命名空间中创建。
`parameters`	`数组`	参数是一个可选的 Parameter 数组，在模板到配置转换过程中使用。
`parameters[]`	`对象`	Parameter 定义一个名称/值变量，在模板到配置转换过程中进行处理。

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

对象（字符串）

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

message

字符串

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

metadata

ObjectMeta_v2

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

对象

数组 (RawExtension)

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

parameters

数组

参数是一个可选的 Parameter 数组，在模板到配置转换过程中使用。

parameters[]

对象

Parameter 定义一个名称/值变量，在模板到配置转换过程中进行处理。

.parameters

描述: 参数是一个可选的 Parameter 数组，在模板到配置转换过程中使用。
类型: 数组

.parameters[]

描述

Parameter 定义一个名称/值变量，在模板到配置转换过程中进行处理。

类型

对象

必需

name

属性类型描述

属性	类型	描述
`description`	`字符串`	参数描述。可选。
`displayName`	`字符串`	可选：在 UI 中显示的名称，替代参数“Name”。
`from`	`字符串`	From 是生成器的输入值。可选。
`generate`	`字符串`	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`	`字符串`	必须设置 Name，并且可以在模板项中使用 ${PARAMETER_NAME} 来引用它。必填。
`required`	`boolean`	可选：指示参数必须具有值。默认为 false。
`value`	`字符串`	Value 保存参数数据。如果指定了 Value，则将忽略生成器。该值替换模板到配置转换过程中参数 ${Name} 表达式的所有出现。可选。

description

字符串

参数描述。可选。

displayName

字符串

可选：在 UI 中显示的名称，替代参数“Name”。

from

字符串

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

generate

字符串

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

字符串

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

required

boolean

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

value

字符串

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

API 端点

提供以下 API 端点

/apis/template.openshift.io/v1/templates
- GET：列出或监视 Template 类型的对象
/apis/template.openshift.io/v1/watch/templates
- GET：监视 Template 列表的单个更改。已弃用：请改用列表操作中的“watch”参数。
/apis/template.openshift.io/v1/namespaces/{namespace}/templates
- DELETE：删除 Template 集合
- GET：列出或监视 Template 类型的对象
- POST：创建 Template
/apis/template.openshift.io/v1/watch/namespaces/{namespace}/templates
- GET：监视 Template 列表的单个更改。已弃用：请改用列表操作中的“watch”参数。
/apis/template.openshift.io/v1/namespaces/{namespace}/templates/{name}
- DELETE：删除 Template
- GET：读取指定的 Template
- PATCH：部分更新指定的 Template
- PUT：替换指定的 Template
/apis/template.openshift.io/v1/namespaces/{namespace}/processedtemplates
- POST：创建 Template
/apis/template.openshift.io/v1/watch/namespaces/{namespace}/templates/{name}
- GET：监视 Template 类型的对象的更改。已弃用：请改用列表操作中的“watch”参数，并使用“fieldSelector”参数将其过滤为单个项目。

/apis/template.openshift.io/v1/templates

HTTP 方法: GET
描述: 列出或监视 Template 类型的对象

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

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

HTTP 方法: GET
描述: 监视 Template 列表的单个更改。已弃用：请改用列表操作中的“watch”参数。

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

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

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

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

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

HTTP 方法: GET
描述: 列出或监视 Template 类型的对象

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

HTTP 方法: POST
描述: 创建 Template

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

表 7. 体参数
参数	类型	描述
`body`	`Template` 模式

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

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

HTTP 方法: GET
描述: 监视 Template 列表的单个更改。已弃用：请改用列表操作中的“watch”参数。

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

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

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

HTTP 方法: DELETE
描述: 删除 Template

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

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

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

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

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

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

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

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

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

表 17. 体参数
参数	类型	描述
`body`	`Template` 模式

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

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

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

HTTP 方法: POST
描述: 创建 Template

表 20. 体参数
参数	类型	描述
`body`	`Template` 模式

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

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

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

HTTP 方法: GET
描述: 监视 Template 类型的对象的更改。已弃用：请改用列表操作中的“watch”参数，并使用“fieldSelector”参数将其过滤为单个项目。

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