1. Documentation
×

ResourceClaimTemplate [resource.k8s.io/v1alpha2]

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

Standard object metadata

spec

object

ResourceClaimTemplateSpec contains the metadata and fields for a ResourceClaim.

.spec

Description

ResourceClaimTemplateSpec contains the metadata and fields for a ResourceClaim.

Type

object

Required

  • spec

Property Type Description

metadata

ObjectMeta

ObjectMeta may contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.

spec

object

ResourceClaimSpec defines how a resource is to be allocated.

.spec.spec

Description

ResourceClaimSpec defines how a resource is to be allocated.

Type

object

Required

  • resourceClassName

Property Type Description

allocationMode

string

Allocation can start immediately or when a Pod wants to use the resource. "WaitForFirstConsumer" is the default.

parametersRef

object

ResourceClaimParametersReference contains enough information to let you locate the parameters for a ResourceClaim. The object must be in the same namespace as the ResourceClaim.

resourceClassName

string

ResourceClassName references the driver and additional parameters via the name of a ResourceClass that was created as part of the driver deployment.

.spec.spec.parametersRef

Description

ResourceClaimParametersReference contains enough information to let you locate the parameters for a ResourceClaim. The object must be in the same namespace as the ResourceClaim.

Type

object

Required

  • kind

  • name

Property Type Description

apiGroup

string

APIGroup is the group for the resource being referenced. It is empty for the core API. This matches the group in the APIVersion that is used when creating the resources.

kind

string

Kind is the type of resource being referenced. This is the same value as in the parameter object’s metadata, for example "ConfigMap".

name

string

Name is the name of resource being referenced.

API endpoints

The following API endpoints are available:

  • /apis/resource.k8s.io/v1alpha2/resourceclaimtemplates

    • GET: list or watch objects of kind ResourceClaimTemplate

  • /apis/resource.k8s.io/v1alpha2/watch/resourceclaimtemplates

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

  • /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaimtemplates

    • DELETE: delete collection of ResourceClaimTemplate

    • GET: list or watch objects of kind ResourceClaimTemplate

    • POST: create a ResourceClaimTemplate

  • /apis/resource.k8s.io/v1alpha2/watch/namespaces/{namespace}/resourceclaimtemplates

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

  • /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaimtemplates/{name}

    • DELETE: delete a ResourceClaimTemplate

    • GET: read the specified ResourceClaimTemplate

    • PATCH: partially update the specified ResourceClaimTemplate

    • PUT: replace the specified ResourceClaimTemplate

  • /apis/resource.k8s.io/v1alpha2/watch/namespaces/{namespace}/resourceclaimtemplates/{name}

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

/apis/resource.k8s.io/v1alpha2/resourceclaimtemplates

HTTP method

GET

Description

list or watch objects of kind ResourceClaimTemplate

Table 1. HTTP responses
HTTP code Reponse body

200 - OK

ResourceClaimTemplateList schema

401 - Unauthorized

Empty

/apis/resource.k8s.io/v1alpha2/watch/resourceclaimtemplates

HTTP method

GET

Description

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

Table 2. HTTP responses
HTTP code Reponse body

200 - OK

WatchEvent schema

401 - Unauthorized

Empty

/apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaimtemplates

HTTP method

DELETE

Description

delete collection of ResourceClaimTemplate

Table 3. 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
Table 4. HTTP responses
HTTP code Reponse body

200 - OK

Status schema

401 - Unauthorized

Empty
HTTP method

GET

Description

list or watch objects of kind ResourceClaimTemplate

Table 5. HTTP responses
HTTP code Reponse body

200 - OK

ResourceClaimTemplateList schema

401 - Unauthorized

Empty
HTTP method

POST

Description

create a ResourceClaimTemplate

Table 6. 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.
Table 7. Body parameters
Parameter Type Description

body

ResourceClaimTemplate schema
Table 8. HTTP responses
HTTP code Reponse body

200 - OK

ResourceClaimTemplate schema

201 - Created

ResourceClaimTemplate schema

202 - Accepted

ResourceClaimTemplate schema

401 - Unauthorized

Empty

/apis/resource.k8s.io/v1alpha2/watch/namespaces/{namespace}/resourceclaimtemplates

HTTP method

GET

Description

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

Table 9. HTTP responses
HTTP code Reponse body

200 - OK

WatchEvent schema

401 - Unauthorized

Empty

/apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaimtemplates/{name}

Table 10. Global path parameters
Parameter Type Description

name

string

name of the ResourceClaimTemplate
HTTP method

DELETE

Description

delete a ResourceClaimTemplate

Table 11. 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
Table 12. HTTP responses
HTTP code Reponse body

200 - OK

ResourceClaimTemplate schema

202 - Accepted

ResourceClaimTemplate schema

401 - Unauthorized

Empty
HTTP method

GET

Description

read the specified ResourceClaimTemplate

Table 13. HTTP responses
HTTP code Reponse body

200 - OK

ResourceClaimTemplate schema

401 - Unauthorized

Empty
HTTP method

PATCH

Description

partially update the specified ResourceClaimTemplate

Table 14. 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.
Table 15. HTTP responses
HTTP code Reponse body

200 - OK

ResourceClaimTemplate schema

201 - Created

ResourceClaimTemplate schema

401 - Unauthorized

Empty
HTTP method

PUT

Description

replace the specified ResourceClaimTemplate

Table 16. 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.
Table 17. Body parameters
Parameter Type Description

body

ResourceClaimTemplate schema
Table 18. HTTP responses
HTTP code Reponse body

200 - OK

ResourceClaimTemplate schema

201 - Created

ResourceClaimTemplate schema

401 - Unauthorized

Empty

/apis/resource.k8s.io/v1alpha2/watch/namespaces/{namespace}/resourceclaimtemplates/{name}

Table 19. Global path parameters
Parameter Type Description

name

string

name of the ResourceClaimTemplate
HTTP method

GET

Description

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

Table 20. HTTP responses
HTTP code Reponse body

200 - OK

WatchEvent schema

401 - Unauthorized

Empty