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

Specification
API endpoints

Description

PodSchedulingContext objects hold information that is needed to schedule a Pod with ResourceClaims that use "WaitForFirstConsumer" allocation mode.

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

Type

object

Required

spec

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
`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`	PodSchedulingContextSpec describes where resources for the Pod are needed.
`status`	`object`	PodSchedulingContextStatus describes where resources for the Pod can be allocated.

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

PodSchedulingContextSpec describes where resources for the Pod are needed.

status

object

PodSchedulingContextStatus describes where resources for the Pod can be allocated.

.spec

Description: PodSchedulingContextSpec describes where resources for the Pod are needed.
Type: object

Property Type Description

Property	Type	Description
`potentialNodes`	`array (string)`	PotentialNodes lists nodes where the Pod might be able to run. The size of this field is limited to 128. This is large enough for many clusters. Larger clusters may need more attempts to find a node that suits all pending resources. This may get increased in the future, but not reduced.
`selectedNode`	`string`	SelectedNode is the node for which allocation of ResourceClaims that are referenced by the Pod and that use "WaitForFirstConsumer" allocation is to be attempted.

potentialNodes

array (string)

PotentialNodes lists nodes where the Pod might be able to run.

The size of this field is limited to 128. This is large enough for many clusters. Larger clusters may need more attempts to find a node that suits all pending resources. This may get increased in the future, but not reduced.

selectedNode

string

SelectedNode is the node for which allocation of ResourceClaims that are referenced by the Pod and that use "WaitForFirstConsumer" allocation is to be attempted.

.status

Description: PodSchedulingContextStatus describes where resources for the Pod can be allocated.
Type: object

Property Type Description

Property	Type	Description
`resourceClaims`	`array`	ResourceClaims describes resource availability for each pod.spec.resourceClaim entry where the corresponding ResourceClaim uses "WaitForFirstConsumer" allocation mode.
`resourceClaims[]`	`object`	ResourceClaimSchedulingStatus contains information about one particular ResourceClaim with "WaitForFirstConsumer" allocation mode.

resourceClaims

array

ResourceClaims describes resource availability for each pod.spec.resourceClaim entry where the corresponding ResourceClaim uses "WaitForFirstConsumer" allocation mode.

resourceClaims[]

object

ResourceClaimSchedulingStatus contains information about one particular ResourceClaim with "WaitForFirstConsumer" allocation mode.

.status.resourceClaims

Description: ResourceClaims describes resource availability for each pod.spec.resourceClaim entry where the corresponding ResourceClaim uses "WaitForFirstConsumer" allocation mode.
Type: array

.status.resourceClaims[]

Description: ResourceClaimSchedulingStatus contains information about one particular ResourceClaim with "WaitForFirstConsumer" allocation mode.
Type: object

Property Type Description

Property	Type	Description
`name`	`string`	Name matches the pod.spec.resourceClaims[*].Name field.
`unsuitableNodes`	`array (string)`	UnsuitableNodes lists nodes that the ResourceClaim cannot be allocated for. The size of this field is limited to 128, the same as for PodSchedulingSpec.PotentialNodes. This may get increased in the future, but not reduced.

name

string

Name matches the pod.spec.resourceClaims[*].Name field.

unsuitableNodes

array (string)

UnsuitableNodes lists nodes that the ResourceClaim cannot be allocated for.

The size of this field is limited to 128, the same as for PodSchedulingSpec.PotentialNodes. This may get increased in the future, but not reduced.

API endpoints

The following API endpoints are available:

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

/apis/resource.k8s.io/v1alpha2/podschedulingcontexts

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

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

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

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

HTTP method: DELETE
Description: delete collection of PodSchedulingContext

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 PodSchedulingContext

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

HTTP method: POST
Description: create a PodSchedulingContext

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

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

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

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

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

HTTP method: DELETE
Description: delete a PodSchedulingContext

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

HTTP method: GET
Description: read the specified PodSchedulingContext

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

HTTP method: PATCH
Description: partially update the specified PodSchedulingContext

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

HTTP method: PUT
Description: replace the specified PodSchedulingContext

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

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

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

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

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

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

Table 21. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the PodSchedulingContext

HTTP method: GET
Description: read status of the specified PodSchedulingContext

Table 22. HTTP responses
HTTP code	Reponse body
200 - OK	`PodSchedulingContext` schema
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update status of the specified PodSchedulingContext

Table 23. 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 24. HTTP responses
HTTP code	Reponse body
200 - OK	`PodSchedulingContext` schema
201 - Created	`PodSchedulingContext` schema
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace status of the specified PodSchedulingContext

Table 25. 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 26. Body parameters
Parameter	Type	Description
`body`	`PodSchedulingContext` schema

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