×

Specification

Property Type Description

apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta_v3

spec

object

TemplateInstanceSpec describes the desired state of a TemplateInstance.

status

object

TemplateInstanceStatus describes the current state of a TemplateInstance.

.spec

Description

TemplateInstanceSpec describes the desired state of a TemplateInstance.

Type

object

Required
  • template

Property Type Description

requester

object

TemplateInstanceRequester holds the identity of an agent requesting a template instantiation.

secret

LocalObjectReference

secret is a reference to a Secret object containing the necessary template parameters.

template

object

Template contains the inputs needed to produce a Config.

Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

.spec.requester

Description

TemplateInstanceRequester holds the identity of an agent requesting a template instantiation.

Type

object

Property Type Description

extra

object

extra holds additional information provided by the authenticator.

extra{}

array (string)

groups

array (string)

groups represent the groups this user is a part of.

uid

string

uid is a unique value that identifies this user across time; if this user is deleted and another user by the same name is added, they will have different UIDs.

username

string

username uniquely identifies this user among all active users.

.spec.requester.extra

Description

extra holds additional information provided by the authenticator.

Type

object

.spec.template

Description

Template contains the inputs needed to produce a Config.

Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

Type

object

Required
  • objects

Property Type Description

apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

labels

object (string)

labels is a optional set of labels that are applied to every object during the Template to Config transformation.

message

string

message is an optional instructional message that will be displayed when this template is instantiated. This field should inform the user how to utilize the newly created resources. Parameter substitution will be performed on the message before being displayed so that generated credentials and other parameters can be included in the output.

metadata

ObjectMeta_v3

objects

array (RawExtension)

objects is an array of resources to include in this template. If a namespace value is hardcoded in the object, it will be removed during template instantiation, however if the namespace value is, or contains, a ${PARAMETER_REFERENCE}, the resolved value after parameter substitution will be respected and the object will be created in that namespace.

parameters

array

parameters is an optional array of Parameters used during the Template to Config transformation.

parameters[]

object

Parameter defines a name/value variable that is to be processed during the Template to Config transformation.

.spec.template.parameters

Description

parameters is an optional array of Parameters used during the Template to Config transformation.

Type

array

.spec.template.parameters[]

Description

Parameter defines a name/value variable that is to be processed during the Template to Config transformation.

Type

object

Required
  • name

Property Type Description

description

string

Description of a parameter. Optional.

displayName

string

Optional: The name that will show in UI instead of parameter 'Name'

from

string

From is an input value for the generator. Optional.

generate

string

generate specifies the generator to be used to generate random string from an input value specified by From field. The result string is stored into Value field. If empty, no generator is being used, leaving the result Value untouched. Optional.

The only supported generator is "expression", which accepts a "from" value in the form of a simple regular expression containing the range expression "[a-zA-Z0-9]", and the length expression "a{length}".

Examples:

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

string

Name must be set and it can be referenced in Template Items using ${PARAMETER_NAME}. Required.

required

boolean

Optional: Indicates the parameter must have a value. Defaults to false.

value

string

Value holds the Parameter data. If specified, the generator will be ignored. The value replaces all occurrences of the Parameter ${Name} expression during the Template to Config transformation. Optional.

.status

Description

TemplateInstanceStatus describes the current state of a TemplateInstance.

Type

object

Property Type Description

conditions

array

conditions represent the latest available observations of a TemplateInstance’s current state.

conditions[]

object

TemplateInstanceCondition contains condition information for a TemplateInstance.

objects

array

Objects references the objects created by the TemplateInstance.

objects[]

object

TemplateInstanceObject references an object created by a TemplateInstance.

.status.conditions

Description

conditions represent the latest available observations of a TemplateInstance’s current state.

Type

array

.status.conditions[]

Description

TemplateInstanceCondition contains condition information for a TemplateInstance.

Type

object

Required
  • type

  • status

  • lastTransitionTime

  • reason

  • message

Property Type Description

lastTransitionTime

Time

LastTransitionTime is the last time a condition status transitioned from one state to another.

message

string