ResourceClassParameters [resource.k8s.io/v1alpha2] - Schedule and quota APIs | API reference

Specification
API endpoints

Description: ResourceClassParameters defines resource requests for a ResourceClass in an in-tree format understood by Kubernetes.
Type: object

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/sig-architecture/api-conventions.md#resources
`filters`	`array`	Filters describes additional contraints that must be met when using the class.
`filters[]`	`object`	ResourceFilter is a filter for resources from one particular driver.
`generatedFrom`	`object`	ResourceClassParametersReference contains enough information to let you locate the parameters for a ResourceClass.
`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
`vendorParameters`	`array`	VendorParameters are arbitrary setup parameters for all claims using this class. They are ignored while allocating the claim. There must not be more than one entry per driver.
`vendorParameters[]`	`object`	VendorParameters are opaque parameters for one particular driver.

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

filters

array

Filters describes additional contraints that must be met when using the class.

filters[]

object

ResourceFilter is a filter for resources from one particular driver.

generatedFrom

object

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

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

vendorParameters

array

VendorParameters are arbitrary setup parameters for all claims using this class. They are ignored while allocating the claim. There must not be more than one entry per driver.

vendorParameters[]

object

VendorParameters are opaque parameters for one particular driver.

.filters

Description: Filters describes additional contraints that must be met when using the class.
Type: array

.filters[]

Description: ResourceFilter is a filter for resources from one particular driver.
Type: object

Property Type Description

Property	Type	Description
`driverName`	`string`	DriverName is the name used by the DRA driver kubelet plugin.
`namedResources`	`object`	NamedResourcesFilter is used in ResourceFilterModel.

driverName

string

DriverName is the name used by the DRA driver kubelet plugin.

namedResources

object

NamedResourcesFilter is used in ResourceFilterModel.

.filters[].namedResources

Description

NamedResourcesFilter is used in ResourceFilterModel.

Type

object

Required

selector

Property Type Description

Property	Type	Description
`selector`	`string`	Selector is a CEL expression which must evaluate to true if a resource instance is suitable. The language is as defined in https://kubernetes.io/docs/reference/using-api/cel/ In addition, for each type NamedResourcesin AttributeValue there is a map that resolves to the corresponding value of the instance under evaluation. For example: attributes.quantity["a"].isGreaterThan(quantity("0")) && attributes.stringslice["b"].isSorted()

selector

string

Selector is a CEL expression which must evaluate to true if a resource instance is suitable. The language is as defined in https://kubernetes.io/docs/reference/using-api/cel/

In addition, for each type NamedResourcesin AttributeValue there is a map that resolves to the corresponding value of the instance under evaluation. For example:

attributes.quantity["a"].isGreaterThan(quantity("0")) && attributes.stringslice["b"].isSorted()

.generatedFrom

Description

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

Type

object

Required

kind
name

Property Type Description

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.

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.

.vendorParameters

Description: VendorParameters are arbitrary setup parameters for all claims using this class. They are ignored while allocating the claim. There must not be more than one entry per driver.
Type: array

.vendorParameters[]

Description: VendorParameters are opaque parameters for one particular driver.
Type: object

Property Type Description

Property	Type	Description
`driverName`	`string`	DriverName is the name used by the DRA driver kubelet plugin.
`parameters`	`RawExtension`	Parameters can be arbitrary setup parameters. They are ignored while allocating a claim.

driverName

string

DriverName is the name used by the DRA driver kubelet plugin.

parameters

RawExtension

Parameters can be arbitrary setup parameters. They are ignored while allocating a claim.

API endpoints

The following API endpoints are available:

/apis/resource.k8s.io/v1alpha2/resourceclassparameters
- GET: list or watch objects of kind ResourceClassParameters
/apis/resource.k8s.io/v1alpha2/watch/resourceclassparameters
- GET: watch individual changes to a list of ResourceClassParameters. deprecated: use the 'watch' parameter with a list operation instead.
/apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclassparameters
- DELETE: delete collection of ResourceClassParameters
- GET: list or watch objects of kind ResourceClassParameters
- POST: create ResourceClassParameters
/apis/resource.k8s.io/v1alpha2/watch/namespaces/{namespace}/resourceclassparameters
- GET: watch individual changes to a list of ResourceClassParameters. deprecated: use the 'watch' parameter with a list operation instead.
/apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclassparameters/{name}
- DELETE: delete ResourceClassParameters
- GET: read the specified ResourceClassParameters
- PATCH: partially update the specified ResourceClassParameters
- PUT: replace the specified ResourceClassParameters
/apis/resource.k8s.io/v1alpha2/watch/namespaces/{namespace}/resourceclassparameters/{name}
- GET: watch changes to an object of kind ResourceClassParameters. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

/apis/resource.k8s.io/v1alpha2/resourceclassparameters

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

Table 1. HTTP responses
HTTP code	Reponse body
200 - OK	`ResourceClassParametersList` schema
401 - Unauthorized	Empty

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

HTTP method: GET
Description: watch individual changes to a list of ResourceClassParameters. 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}/resourceclassparameters

HTTP method: DELETE
Description: delete collection of ResourceClassParameters

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 ResourceClassParameters

Table 5. HTTP responses
HTTP code	Reponse body
200 - OK	`ResourceClassParametersList` schema
401 - Unauthorized	Empty

HTTP method: POST
Description: create ResourceClassParameters

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`	`ResourceClassParameters` schema

Table 8. HTTP responses
HTTP code	Reponse body
200 - OK	`ResourceClassParameters` schema
201 - Created	`ResourceClassParameters` schema
202 - Accepted	`ResourceClassParameters` schema
401 - Unauthorized	Empty

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

HTTP method: GET
Description: watch individual changes to a list of ResourceClassParameters. 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}/resourceclassparameters/{name}

Table 10. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the ResourceClassParameters

HTTP method: DELETE
Description: delete ResourceClassParameters

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	`ResourceClassParameters` schema
202 - Accepted	`ResourceClassParameters` schema
401 - Unauthorized	Empty

HTTP method: GET
Description: read the specified ResourceClassParameters

Table 13. HTTP responses
HTTP code	Reponse body
200 - OK	`ResourceClassParameters` schema
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update the specified ResourceClassParameters

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	`ResourceClassParameters` schema
201 - Created	`ResourceClassParameters` schema
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace the specified ResourceClassParameters

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`	`ResourceClassParameters` schema

Table 18. HTTP responses
HTTP code	Reponse body
200 - OK	`ResourceClassParameters` schema
201 - Created	`ResourceClassParameters` schema
401 - Unauthorized	Empty

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

Table 19. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the ResourceClassParameters

HTTP method: GET
Description: watch changes to an object of kind ResourceClassParameters. 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