Template [template.openshift.io/v1]

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 meta/v1

objects

array (RawExtension pkg/runtime)

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.

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.