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

Specification
API endpoints

Description

ResourceSlice provides information about available resources on individual nodes.

Type

object

Required

driverName

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
`driverName`	`string`	DriverName identifies the DRA driver providing the capacity information. A field selector can be used to list only ResourceSlice objects with a certain driver name.
`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
`namedResources`	`object`	NamedResourcesResources is used in ResourceModel.
`nodeName`	`string`	NodeName identifies the node which provides the resources if they are local to a node. A field selector can be used to list only ResourceSlice objects with a certain node name.

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 identifies the DRA driver providing the capacity information. A field selector can be used to list only ResourceSlice objects with a certain driver name.

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

namedResources

object

NamedResourcesResources is used in ResourceModel.

nodeName

string

NodeName identifies the node which provides the resources if they are local to a node.

A field selector can be used to list only ResourceSlice objects with a certain node name.

.namedResources

Description

NamedResourcesResources is used in ResourceModel.

Type

object

Required

instances

Property Type Description

Property	Type	Description
`instances`	`array`	The list of all individual resources instances currently available.
`instances[]`	`object`	NamedResourcesInstance represents one individual hardware instance that can be selected based on its attributes.

instances

array

The list of all individual resources instances currently available.

instances[]

object

NamedResourcesInstance represents one individual hardware instance that can be selected based on its attributes.

.namedResources.instances

Description: The list of all individual resources instances currently available.
Type: array

.namedResources.instances[]

Description

NamedResourcesInstance represents one individual hardware instance that can be selected based on its attributes.

Type

object

Required

name

Property Type Description

Property	Type	Description
`attributes`	`array`	Attributes defines the attributes of this resource instance. The name of each attribute must be unique.
`attributes[]`	`object`	NamedResourcesAttribute is a combination of an attribute name and its value.
`name`	`string`	Name is unique identifier among all resource instances managed by the driver on the node. It must be a DNS subdomain.

attributes

array

Attributes defines the attributes of this resource instance. The name of each attribute must be unique.

attributes[]

object

NamedResourcesAttribute is a combination of an attribute name and its value.

name

string

Name is unique identifier among all resource instances managed by the driver on the node. It must be a DNS subdomain.

.namedResources.instances[].attributes

Description: Attributes defines the attributes of this resource instance. The name of each attribute must be unique.
Type: array

.namedResources.instances[].attributes[]

Description

NamedResourcesAttribute is a combination of an attribute name and its value.

Type

object

Required

name

Property Type Description

Property	Type	Description
`bool`	`boolean`	BoolValue is a true/false value.
`int`	`integer`	IntValue is a 64-bit integer.
`intSlice`	`object`	NamedResourcesIntSlice contains a slice of 64-bit integers.
`name`	`string`	Name is unique identifier among all resource instances managed by the driver on the node. It must be a DNS subdomain.
`quantity`	`Quantity`	QuantityValue is a quantity.
`string`	`string`	StringValue is a string.
`stringSlice`	`object`	NamedResourcesStringSlice contains a slice of strings.
`version`	`string`	VersionValue is a semantic version according to semver.org spec 2.0.0.

bool

boolean

BoolValue is a true/false value.

int

integer

IntValue is a 64-bit integer.

intSlice

object

NamedResourcesIntSlice contains a slice of 64-bit integers.

name

string

Name is unique identifier among all resource instances managed by the driver on the node. It must be a DNS subdomain.

quantity

Quantity

QuantityValue is a quantity.

string

StringValue is a string.

stringSlice

object

NamedResourcesStringSlice contains a slice of strings.

version

string

VersionValue is a semantic version according to semver.org spec 2.0.0.

.namedResources.instances[].attributes[].intSlice

Description

NamedResourcesIntSlice contains a slice of 64-bit integers.

Type

object

Required

ints

Property Type Description

Property	Type	Description
`ints`	`array (integer)`	Ints is the slice of 64-bit integers.

ints

array (integer)

Ints is the slice of 64-bit integers.

.namedResources.instances[].attributes[].stringSlice

Description

NamedResourcesStringSlice contains a slice of strings.

Type

object

Required

strings

Property Type Description

Property	Type	Description
`strings`	`array (string)`	Strings is the slice of strings.

strings

array (string)

Strings is the slice of strings.

API endpoints

The following API endpoints are available:

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

/apis/resource.k8s.io/v1alpha2/resourceslices

HTTP method: DELETE
Description: delete collection of ResourceSlice

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 ResourceSlice

Table 3. HTTP responses
HTTP code	Reponse body
200 - OK	`ResourceSliceList` schema
401 - Unauthorized	Empty

HTTP method: POST
Description: create a ResourceSlice

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

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

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

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

Table 8. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the ResourceSlice

HTTP method: DELETE
Description: delete a ResourceSlice

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

HTTP method: GET
Description: read the specified ResourceSlice

Table 11. HTTP responses
HTTP code	Reponse body
200 - OK	`ResourceSlice` schema
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update the specified ResourceSlice

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

HTTP method: PUT
Description: replace the specified ResourceSlice

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

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

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

Table 17. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the ResourceSlice

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