TemplateInstance [template.openshift.io/v1]

Description

TemplateInstance requests and records the instantiation of a Template. TemplateInstance is part of an experimental API. Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

Type

`object`

Required

• spec

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	metadata is the standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#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
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	metadata is the standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
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	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
ref	ObjectReference	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/watch/templateinstances
  • GET: watch individual changes to a list of TemplateInstance. deprecated: use the 'watch' parameter with a list operation instead.
• /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/watch/namespaces/{namespace}/templateinstances
  • GET: watch individual changes to a list of TemplateInstance. deprecated: use the 'watch' parameter with a list operation instead.
• /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/watch/namespaces/{namespace}/templateinstances/{name}
  • GET: watch changes to an object of kind TemplateInstance. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
• /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

HTTP method

`GET`

Description

list or watch objects of kind TemplateInstance

HTTP responses

HTTP code	Reponse body
200 - OK	TemplateInstanceList schema
401 - Unauthorized	Empty

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

HTTP method

`GET`

Description

watch individual changes to a list of TemplateInstance. deprecated: use the 'watch' parameter with a list operation instead.

HTTP responses

HTTP code	Reponse body
200 - OK	WatchEvent schema
401 - Unauthorized	Empty

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

HTTP method

`DELETE`

Description

delete collection of TemplateInstance

Query parameters

Parameter	Type	Description
dryRun	string	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

HTTP responses

HTTP code	Reponse body
200 - OK	Status_v2 schema
401 - Unauthorized	Empty

HTTP method

`GET`

Description

list or watch objects of kind TemplateInstance

HTTP responses

HTTP code	Reponse body
200 - OK	TemplateInstanceList schema
401 - Unauthorized	Empty

HTTP method

`POST`

Description

create a TemplateInstance

Query parameters

Parameter	Type	Description
dryRun	string	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidation	string	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Body parameters

Parameter	Type	Description
body	TemplateInstance schema

HTTP responses

HTTP code	Reponse body
200 - OK	TemplateInstance schema
201 - Created	TemplateInstance schema
202 - Accepted	TemplateInstance schema
401 - Unauthorized	Empty

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

HTTP method

`GET`

Description

watch individual changes to a list of TemplateInstance. deprecated: use the 'watch' parameter with a list operation instead.

HTTP responses

HTTP code	Reponse body
200 - OK	WatchEvent schema
401 - Unauthorized	Empty

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

Global path parameters

Parameter	Type	Description
name	string	name of the TemplateInstance

HTTP method

`DELETE`

Description

delete a TemplateInstance

Query parameters

Parameter	Type	Description
dryRun	string	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

HTTP responses

HTTP code	Reponse body
200 - OK	Status_v2 schema
202 - Accepted	Status_v2 schema
401 - Unauthorized	Empty

HTTP method

`GET`

Description

read the specified TemplateInstance

HTTP responses

HTTP code	Reponse body
200 - OK	TemplateInstance schema
401 - Unauthorized	Empty

HTTP method

`PATCH`

Description

partially update the specified TemplateInstance

Query parameters

Parameter	Type	Description
dryRun	string	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidation	string	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

HTTP responses

HTTP code	Reponse body
200 - OK	TemplateInstance schema
201 - Created	TemplateInstance schema
401 - Unauthorized	Empty

HTTP method

`PUT`

Description

replace the specified TemplateInstance

Query parameters

Parameter	Type	Description
dryRun	string	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidation	string	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Body parameters

Parameter	Type	Description
body	TemplateInstance schema

HTTP responses

HTTP code	Reponse body
200 - OK	TemplateInstance schema
201 - Created	TemplateInstance schema
401 - Unauthorized	Empty

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

Global path parameters

Parameter	Type	Description
name	string	name of the TemplateInstance

HTTP method

`GET`

Description

watch changes to an object of kind TemplateInstance. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

HTTP responses

HTTP code	Reponse body
200 - OK	WatchEvent schema
401 - Unauthorized	Empty

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

Global path parameters

Parameter	Type	Description
name	string	name of the TemplateInstance

HTTP method

`GET`

Description

read status of the specified TemplateInstance

HTTP responses

HTTP code	Reponse body
200 - OK	TemplateInstance schema
401 - Unauthorized	Empty

HTTP method

`PATCH`

Description

partially update status of the specified TemplateInstance

Query parameters

Parameter	Type	Description
dryRun	string	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidation	string	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

HTTP responses

HTTP code	Reponse body
200 - OK	TemplateInstance schema
201 - Created	TemplateInstance schema
401 - Unauthorized	Empty

HTTP method

`PUT`

Description

replace status of the specified TemplateInstance

Query parameters

Parameter	Type	Description
dryRun	string	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidation	string	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Body parameters

Parameter	Type	Description
body	TemplateInstance schema

HTTP responses

HTTP code	Reponse body
200 - OK	TemplateInstance schema
201 - Created	TemplateInstance schema
401 - Unauthorized	Empty