第 5 章 TemplateInstance [template.openshift.io/v1]


描述

TemplateInstance 请求并记录模板的实例化。TemplateInstance 是实验性 API 的一部分。

兼容性级别 1:在主发行版本中至少提供 12 个月或 3 个次版本(以更长的时间为准)。

类型
object
必填
  • spec

5.1. 规格

属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: 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

object

TemplateInstanceSpec 描述了 TemplateInstance 的所需状态。

status

object

TemplateInstanceStatus 描述了 TemplateInstance 的当前状态。

5.1.1. .spec

描述
TemplateInstanceSpec 描述了 TemplateInstance 的所需状态。
类型
object
必填
  • 模板
属性类型描述

requester

object

TemplateInstanceRequester 包含请求模板实例化的代理的身份。

secret

LocalObjectReference_v2

Secret 是引用包含所需模板参数的 Secret 对象。

模板

object

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

兼容性级别 1:在主发行版本中至少提供 12 个月或 3 个次版本(以更长的时间为准)。

5.1.2. .spec.requester

描述
TemplateInstanceRequester 包含请求模板实例化的代理的身份。
类型
object
属性类型描述

extra

object

额外包含验证器提供的其他信息。

extra{}

数组(字符串)

 

groups

数组(字符串)

组代表此用户所属的组。

uid

string

UID 是一个在一段时间内标识此用户的唯一值;如果删除了此用户,并且添加了相同名称的另一个用户,则它们具有不同的 UID。

username

string

在所有活动用户中唯一标识此用户的用户名。

5.1.3. .spec.requester.extra

描述
额外包含验证器提供的其他信息。
类型
object

5.1.4. .spec.template

描述

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

兼容性级别 1:在主发行版本中至少提供 12 个月或 3 个次版本(以更长的时间为准)。

类型
object
必填
  • objects
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

labels

对象(字符串)

labels 是一个可选的标签,在 Template 到 Config 转换过程中应用于每个对象。

message

string

Message 是可选的说明消息,将在此模板实例化时显示该消息。此字段应告知用户如何使用新创建的资源。在显示之前,将在消息上执行参数替换,以便输出中包含生成的凭证和其他参数。

metadata

ObjectMeta_v2

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

objects

数组(RawExtension)

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

parameters

数组

参数是模板期间使用的可选参数数组。

parameters[]

object

参数定义要在模板到配置转换期间处理的名称/值变量。

5.1.5. .spec.template.parameters

描述
参数是模板期间使用的可选参数数组。
类型
数组

5.1.6. .spec.template.parameters[]

描述
参数定义要在模板到配置转换期间处理的名称/值变量。
类型
object
必填
  • name
属性类型描述

description

string

参数的描述。可选。

displayName

string

可选:在 UI 中显示的名称而不是参数 'Name'

from

string

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

generate

string

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

唯一支持的生成器是 "expression",它接受一个 "from" 值,格式为包含范围表达式 "[a-zA-Z0-9]",长度表达式 "a{length}"。

示例:

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

名称

string

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

required

布尔值

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

value

string

value 包含参数数据。如果指定了,则忽略生成器。该值替换模板到配置转换期间出现的所有 Parameter ${Name} 表达式。可选。

5.1.7. .status

描述
TemplateInstanceStatus 描述了 TemplateInstance 的当前状态。
类型
object
属性类型描述

conditions

数组

条件代表 TemplateInstance 当前状态的最新可用影响。

conditions[]

object

TemplateInstanceCondition 包含 TemplateInstance 的条件信息。

objects

数组

对象引用 TemplateInstance 创建的对象。

objects[]

object

TemplateInstanceObject 引用 TemplateInstance 创建的对象。

5.1.8. .status.conditions

描述
条件代表 TemplateInstance 当前状态的最新可用影响。
类型
array

5.1.9. .status.conditions[]

描述
TemplateInstanceCondition 包含 TemplateInstance 的条件信息。
类型
object
必填
  • type
  • status
  • lastTransitionTime
  • reason
  • message
属性类型描述

lastTransitionTime

时间

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

message

string

Message 是最后一次转换的详细信息的人类可读描述,补充原因。

reason

字符串

原因是对条件最后一次转换的简短机器可读说明。

status

string

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

type

string

条件的类型,当前 Ready 或 InstantiateFailure。

5.1.10. .status.objects

描述
对象引用 TemplateInstance 创建的对象。
类型
数组

5.1.11. .status.objects[]

描述
TemplateInstanceObject 引用 TemplateInstance 创建的对象。
类型
object
属性类型描述

ref

ObjectReference

ref 是对创建的对象的引用。在 .spec 下使用时,只使用 name 和 namespace;它们可以包含对参数的引用,这些参数将按照常规规则替换。

Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

© 2024 Red Hat, Inc.