TemplateInstance [template.openshift.io/v1] - template.openshift.io | API reference

Important

Azure Red Hat OpenShift 3.11 will be retired 30 June 2022. Support for creation of new Azure Red Hat OpenShift 3.11 clusters continues through 30 November 2020. Following retirement, remaining Azure Red Hat OpenShift 3.11 clusters will be shut down to prevent security vulnerabilities.

Follow this guide to create an Azure Red Hat OpenShift 4 cluster. If you have specific questions, please contact us

Specification
API endpoints

Description

TemplateInstance requests and records the instantiation of a Template. TemplateInstance is part of an experimental API.

Type

object

Required

spec

Specification

Property Type Description

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/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/api-conventions.md#types-kinds
`.metadata`	`ObjectMeta meta/v1`	Standard object metadata.
`.spec`	`object`	TemplateInstanceSpec describes the desired state of a TemplateInstance.
`.status`	`object`	TemplateInstanceStatus describes the current state of a TemplateInstance.

.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/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/api-conventions.md#types-kinds

.metadata

ObjectMeta meta/v1

Standard object metadata.

.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

Property	Type	Description
`requester`	`object`	TemplateInstanceRequester holds the identity of an agent requesting a template instantiation.
`secret`	`LocalObjectReference core/v1`	secret is a reference to a Secret object containing the necessary template parameters.
`template`	`object`	Template contains the inputs needed to produce a Config.

requester

object

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

secret

LocalObjectReference core/v1

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

template

object

Template contains the inputs needed to produce a Config.

.spec.requester

Description: TemplateInstanceRequester holds the identity of an agent requesting a template instantiation.
Type: object

Property Type Description

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.

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.

Type

object

Required

objects

Property Type Description

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/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/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`	Standard object’s metadata.
`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.

apiVersion

string

kind

string

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

Standard object’s metadata.

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.

.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

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.

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

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.

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

Property	Type	Description
`lastTransitionTime`	`Time meta/v1`	LastTransitionTime is the last time a condition status transitioned from one state to another.
`message`	`string`	Message is a human readable description of the details of the last transition, complementing reason.
`reason`	`string`	Reason is a brief machine readable explanation for the condition’s last transition.
`status`	`string`	Status of the condition, one of True, False or Unknown.
`type`	`string`	Type of the condition, currently Ready or InstantiateFailure.

lastTransitionTime

Time meta/v1

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

message

string

Message is a human readable description of the details of the last transition, complementing reason.

reason

string

Reason is a brief machine readable explanation for the condition’s last transition.

status

string

Status of the condition, one of True, False or Unknown.

type

string

Type of the condition, currently Ready or InstantiateFailure.

.status.objects

Description: Objects references the objects created by the TemplateInstance.
Type: array

.status.objects[]

Description: TemplateInstanceObject references an object created by a TemplateInstance.
Type: object

Property Type Description

Property	Type	Description
`ref`	`ObjectReference core/v1`	ref is a reference to the created object. When used under .spec, only name and namespace are used; these can contain references to parameters which will be substituted following the usual rules.

ref

ObjectReference core/v1

ref is a reference to the created object. When used under .spec, only name and namespace are used; these can contain references to parameters which will be substituted following the usual rules.

API endpoints

The following API endpoints are available:

/apis/template.openshift.io/v1/templateinstances
- GET: list or watch objects of kind TemplateInstance
/apis/template.openshift.io/v1/namespaces/{namespace}/templateinstances
- DELETE: delete collection of TemplateInstance
- GET: list or watch objects of kind TemplateInstance
- POST: create a TemplateInstance
/apis/template.openshift.io/v1/namespaces/{namespace}/templateinstances/{name}
- DELETE: delete a TemplateInstance
- GET: read the specified TemplateInstance
- PATCH: partially update the specified TemplateInstance
- PUT: replace the specified TemplateInstance
/apis/template.openshift.io/v1/namespaces/{namespace}/templateinstances/{name}/status
- GET: read status of the specified TemplateInstance
- PATCH: partially update status of the specified TemplateInstance
- PUT: replace status of the specified TemplateInstance

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

Table 1. Global guery parameters
Parameter	Type	Description
`continue`	`string`	The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector`	`string`	A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized`	`boolean`	If true, partially initialized resources are included in the response.
`labelSelector`	`string`	A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit`	`integer`	limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty`	`string`	If 'true', then the output is pretty printed.
`resourceVersion`	`string`	When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds`	`integer`	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch`	`boolean`	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

HTTP method: GET
Description: list or watch objects of kind TemplateInstance

Table 2. HTTP responses
HTTP code	Reponse body
200 - OK	`TemplateInstanceList template.openshift.io/v1`
401 - Unauthorized	Empty

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

Table 3. Global path parameters
Parameter	Type	Description
`namespace`	`string`	object name and auth scope, such as for teams and projects

Table 4. Global guery parameters
Parameter	Type	Description
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: DELETE
Description: delete collection of TemplateInstance

Table 5. Query parameters
Parameter	Type	Description
`continue`	`string`	The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector`	`string`	A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized`	`boolean`	If true, partially initialized resources are included in the response.
`labelSelector`	`string`	A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit`	`integer`	limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion`	`string`	When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds`	`integer`	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch`	`boolean`	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Table 6. HTTP responses
HTTP code	Reponse body
200 - OK	`Status meta/v1`
401 - Unauthorized	Empty

HTTP method: GET
Description: list or watch objects of kind TemplateInstance

Table 7. Query parameters
Parameter	Type	Description
`continue`	`string`	The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector`	`string`	A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized`	`boolean`	If true, partially initialized resources are included in the response.
`labelSelector`	`string`	A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit`	`integer`	limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion`	`string`	When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds`	`integer`	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch`	`boolean`	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Table 8. HTTP responses
HTTP code	Reponse body
200 - OK	`TemplateInstanceList template.openshift.io/v1`
401 - Unauthorized	Empty

HTTP method: POST
Description: create a TemplateInstance

Table 9. Body parameters
Parameter	Type	Description
`body`	`TemplateInstance template.openshift.io/v1`

Table 10. HTTP responses
HTTP code	Reponse body
200 - OK	`TemplateInstance template.openshift.io/v1`
201 - Created	`TemplateInstance template.openshift.io/v1`
202 - Accepted	`TemplateInstance template.openshift.io/v1`
401 - Unauthorized	Empty

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

Table 11. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the TemplateInstance
`namespace`	`string`	object name and auth scope, such as for teams and projects

Table 12. Global guery parameters
Parameter	Type	Description
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: DELETE
Description: delete a TemplateInstance

Table 13. Query parameters
Parameter	Type	Description
`gracePeriodSeconds`	`integer`	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents`	`boolean`	Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy`	`string`	Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

Table 14. Body parameters
Parameter	Type	Description
`body`	`DeleteOptions meta/v1`

Table 15. HTTP responses
HTTP code	Reponse body
200 - OK	`Status meta/v1`
401 - Unauthorized	Empty

HTTP method: GET
Description: read the specified TemplateInstance

Table 16. Query parameters
Parameter	Type	Description
`exact`	`boolean`	Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
`export`	`boolean`	Should this value be exported. Export strips fields that a user can not specify.

Table 17. HTTP responses
HTTP code	Reponse body
200 - OK	`TemplateInstance template.openshift.io/v1`
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update the specified TemplateInstance

Table 18. Body parameters
Parameter	Type	Description
`body`	`Patch meta/v1`

Table 19. HTTP responses
HTTP code	Reponse body
200 - OK	`TemplateInstance template.openshift.io/v1`
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace the specified TemplateInstance

Table 20. Body parameters
Parameter	Type	Description
`body`	`TemplateInstance template.openshift.io/v1`

Table 21. HTTP responses
HTTP code	Reponse body
200 - OK	`TemplateInstance template.openshift.io/v1`
201 - Created	`TemplateInstance template.openshift.io/v1`
401 - Unauthorized	Empty

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

Table 22. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the TemplateInstance
`namespace`	`string`	object name and auth scope, such as for teams and projects

Table 23. Global guery parameters
Parameter	Type	Description
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: GET
Description: read status of the specified TemplateInstance

Table 24. HTTP responses
HTTP code	Reponse body
200 - OK	`TemplateInstance template.openshift.io/v1`
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update status of the specified TemplateInstance

Table 25. Body parameters
Parameter	Type	Description
`body`	`Patch meta/v1`

Table 26. HTTP responses
HTTP code	Reponse body
200 - OK	`TemplateInstance template.openshift.io/v1`
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace status of the specified TemplateInstance

Table 27. Body parameters
Parameter	Type	Description
`body`	`TemplateInstance template.openshift.io/v1`

Table 28. HTTP responses
HTTP code	Reponse body
200 - OK	`TemplateInstance template.openshift.io/v1`
201 - Created	`TemplateInstance template.openshift.io/v1`
401 - Unauthorized	Empty