1. Documentation
×

ResourceClass [resource.k8s.io/v1alpha2]

Description

ResourceClass is used by administrators to influence how resources are allocated.

This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.

Type

object

Required

  • driverName

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

driverName

string

DriverName defines the name of the dynamic resource driver that is used for allocation of a ResourceClaim that uses this class.

Resource drivers have a unique name in forward domain order (acme.example.com).

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

parametersRef

object

ResourceClassParametersReference contains enough information to let you locate the parameters for a ResourceClass.

structuredParameters

boolean

If and only if allocation of claims using this class is handled via structured parameters, then StructuredParameters must be set to true.

suitableNodes

NodeSelector

Only nodes matching the selector will be considered by the scheduler when trying to find a Node that fits a Pod when that Pod uses a ResourceClaim that has not been allocated yet.

Setting this field is optional. If null, all nodes are candidates.

.parametersRef

Description

ResourceClassParametersReference contains enough information to let you locate the parameters for a ResourceClass.

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.

name

string

Name is the name of resource being referenced.

namespace

string

Namespace that contains the referenced resource. Must be empty for cluster-scoped resources and non-empty for namespaced resources.

API endpoints

The following API endpoints are available:

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

    • DELETE: delete collection of ResourceClass

    • GET: list or watch objects of kind ResourceClass

    • POST: create a ResourceClass

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

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

  • /apis/resource.k8s.io/v1alpha2/resourceclasses/{name}

    • DELETE: delete a ResourceClass

    • GET: read the specified ResourceClass

    • PATCH: partially update the specified ResourceClass

    • PUT: replace the specified ResourceClass

  • /apis/resource.k8s.io/v1alpha2/watch/resourceclasses/{name}

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

/apis/resource.k8s.io/v1alpha2/resourceclasses

HTTP method

DELETE

Description

delete collection of ResourceClass

Table 1. 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 2. HTTP responses
HTTP code Reponse body

200 - OK

Status schema

401 - Unauthorized

Empty
HTTP method

GET

Description

list or watch objects of kind ResourceClass

Table 3. HTTP responses
HTTP code Reponse body

200 - OK

ResourceClassList schema

401 - Unauthorized

Empty
HTTP method

POST

Description

create a ResourceClass

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

body

ResourceClass schema
Table 6. HTTP responses
HTTP code Reponse body

200 - OK

ResourceClass schema

201 - Created

ResourceClass schema

202 - Accepted

ResourceClass schema

401 - Unauthorized

Empty

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

HTTP method

GET

Description

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

Table 7. HTTP responses
HTTP code Reponse body

200 - OK

WatchEvent schema

401 - Unauthorized

Empty

/apis/resource.k8s.io/v1alpha2/resourceclasses/{name}

Table 8. Global path parameters
Parameter Type Description

name

string

name of the ResourceClass
HTTP method

DELETE

Description

delete a ResourceClass

Table 9. 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 10. HTTP responses
HTTP code Reponse body

200 - OK

ResourceClass schema

202 - Accepted

ResourceClass schema

401 - Unauthorized

Empty
HTTP method

GET

Description

read the specified ResourceClass

Table 11. HTTP responses
HTTP code Reponse body

200 - OK

ResourceClass schema

401 - Unauthorized

Empty
HTTP method

PATCH

Description

partially update the specified ResourceClass

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

200 - OK

ResourceClass schema

201 - Created

ResourceClass schema

401 - Unauthorized

Empty
HTTP method

PUT

Description

replace the specified ResourceClass

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

body

ResourceClass schema
Table 16. HTTP responses
HTTP code Reponse body

200 - OK

ResourceClass schema

201 - Created

ResourceClass schema

401 - Unauthorized

Empty

/apis/resource.k8s.io/v1alpha2/watch/resourceclasses/{name}

Table 17. Global path parameters
Parameter Type Description

name

string

name of the ResourceClass
HTTP method

GET

Description

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

Table 18. HTTP responses
HTTP code Reponse body

200 - OK

WatchEvent schema

401 - Unauthorized

Empty