我的书签
添加书签
移除书签ResourceClaim v1alpha1
apiVersion: resource.k8s.io/v1alpha1
import "k8s.io/api/resource/v1alpha1"
ResourceClaim describes which resources are needed by a resource consumer. Its status tracks whether the resource has been allocated and what the resulting attributes are.
This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.
apiVersion: resource.k8s.io/v1alpha1
kind: ResourceClaim
metadata ()
Standard object metadata
spec (ResourceClaimSpec), required
Spec describes the desired attributes of a resource that then needs to be allocated. It can only be set once when creating the ResourceClaim.
ResourceClaimSpec defines how a resource is to be allocated.
resourceClassName (string), required
ResourceClassName references the driver and additional parameters via the name of a ResourceClass that was created as part of the driver deployment.
allocationMode (string)
Allocation can start immediately or when a Pod wants to use the resource. “WaitForFirstConsumer” is the default.
parametersRef (ResourceClaimParametersReference)
ParametersRef references a separate object with arbitrary parameters that will be used by the driver when allocating a resource for the claim.
The object must be in the same namespace as the ResourceClaim.
ResourceClaimParametersReference contains enough information to let you locate the parameters for a ResourceClaim. The object must be in the same namespace as the ResourceClaim.
parametersRef.kind (string), required
Kind is the type of resource being referenced. This is the same value as in the parameter object’s metadata, for example “ConfigMap”.
parametersRef.name (string), required
Name is the name of resource being referenced.
parametersRef.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.
ResourceClaimStatus tracks whether the resource has been allocated and what the resulting attributes are.
allocation (AllocationResult)
Allocation is set by the resource driver once a resource has been allocated successfully. If this is not specified, the resource is not yet allocated.
AllocationResult contains attributed of an allocated resource.
allocation.availableOnNodes (NodeSelector)
This field will get set by the resource driver after it has allocated the resource driver to inform the scheduler where it can schedule Pods using the ResourceClaim.
Setting this field is optional. If null, the resource is available everywhere.
A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.
allocation.availableOnNodes.nodeSelectorTerms ([]NodeSelectorTerm), required
Required. A list of node selector terms. The terms are ORed.
A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.
allocation.availableOnNodes.nodeSelectorTerms.matchExpressions ([])
A list of node selector requirements by node’s labels.
allocation.availableOnNodes.nodeSelectorTerms.matchFields ([]NodeSelectorRequirement)
A list of node selector requirements by node’s fields.
allocation.resourceHandle (string)
ResourceHandle contains arbitrary data returned by the driver after a successful allocation. This is opaque for Kubernetes. Driver documentation may explain to users how to interpret this data if needed.
The maximum size of this field is 16KiB. This may get increased in the future, but not reduced.
allocation.shareable (boolean)
Shareable determines whether the resource supports more than one consumer at a time.
deallocationRequested (boolean)
DeallocationRequested indicates that a ResourceClaim is to be deallocated.
The driver then must deallocate this claim and reset the field together with clearing the Allocation field.
While DeallocationRequested is set, no new consumers may be added to ReservedFor.
driverName (string)
DriverName is a copy of the driver name from the ResourceClass at the time when allocation started.
reservedFor ([]ResourceClaimConsumerReference)
Set: unique values will be kept during a merge
ReservedFor indicates which entities are currently allowed to use the claim. A Pod which references a ResourceClaim which is not reserved for that Pod will not be started.
There can be at most 32 such reservations. This may get increased in the future, but not reduced.
ResourceClaimConsumerReference contains enough information to let you locate the consumer of a ResourceClaim. The user must be a resource in the same namespace as the ResourceClaim.
reservedFor.name (string), required
Name is the name of resource being referenced.
reservedFor.resource (string), required
Resource is the type of resource being referenced, for example “pods”.
reservedFor.uid (string), required
UID identifies exactly one incarnation of the resource.
reservedFor.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.
ResourceClaimList is a collection of claims.
apiVersion: resource.k8s.io/v1alpha1
kind: ResourceClaimList
metadata (ListMeta)
Standard list metadata
items ([]), required
Items is the list of resource claims.
HTTP Request
GET /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaims/{name}
Parameters
name (in path): string, required
name of the ResourceClaim
namespace (in path): string, required
pretty (in query): string
Response
200 (): OK
401: Unauthorized
get read status of the specified ResourceClaim
HTTP Request
GET /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaims/{name}/status
Parameters
name (in path): string, required
name of the ResourceClaim
namespace (in path): string, required
pretty (in query): string
Response
200 (ResourceClaim): OK
list list or watch objects of kind ResourceClaim
HTTP Request
GET /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaims
Parameters
namespace (in path): string, required
allowWatchBookmarks (in query): boolean
continue (in query): string
fieldSelector (in query): string
labelSelector (in query): string
limit (in query): integer
pretty (in query): string
resourceVersion (in query): string
resourceVersionMatch (in query): string
timeoutSeconds (in query): integer
watch (in query): boolean
Response
200 (ResourceClaimList): OK
401: Unauthorized
HTTP Request
GET /apis/resource.k8s.io/v1alpha1/resourceclaims
Parameters
allowWatchBookmarks (in query): boolean
continue (in query): string
fieldSelector (in query): string
labelSelector (in query): string
limit (in query): integer
pretty (in query): string
resourceVersion (in query): string
resourceVersionMatch (in query): string
timeoutSeconds (in query): integer
watch (in query): boolean
Response
200 (): OK
401: Unauthorized
create create a ResourceClaim
HTTP Request
POST /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaims
Parameters
namespace (in path): string, required
body: ResourceClaim, required
fieldManager (in query): string
fieldValidation (in query): string
pretty (in query): string
Response
200 (): OK
201 (ResourceClaim): Created
202 (): Accepted
401: Unauthorized
update replace the specified ResourceClaim
HTTP Request
PUT /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaims/{name}
Parameters
name (in path): string, required
name of the ResourceClaim
namespace (in path): string, required
body: ResourceClaim, required
dryRun (in query): string
fieldManager (in query): string
fieldValidation (in query): string
pretty (in query): string
Response
200 (ResourceClaim): OK
201 (): Created
401: Unauthorized
HTTP Request
PUT /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaims/{name}/status
Parameters
name (in path): string, required
name of the ResourceClaim
namespace (in path): string, required
body: ResourceClaim, required
dryRun (in query): string
fieldManager (in query): string
fieldValidation (in query): string
pretty (in query): string
Response
200 (): OK
201 (ResourceClaim): Created
401: Unauthorized
patch partially update the specified ResourceClaim
HTTP Request
PATCH /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaims/{name}
Parameters
name (in path): string, required
name of the ResourceClaim
namespace (in path): string, required
body: , required
dryRun (in query): string
fieldManager (in query): string
fieldValidation (in query): string
force (in query): boolean
pretty (in query): string
Response
200 (ResourceClaim): OK
201 (): Created
401: Unauthorized
patch partially update status of the specified ResourceClaim
HTTP Request
PATCH /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaims/{name}/status
Parameters
name (in path): string, required
name of the ResourceClaim
namespace (in path): string, required
body: Patch, required
dryRun (in query): string
fieldManager (in query): string
fieldValidation (in query): string
force (in query): boolean
pretty (in query): string
Response
200 (): OK
201 (ResourceClaim): Created
401: Unauthorized
HTTP Request
DELETE /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaims/{name}
Parameters
name (in path): string, required
name of the ResourceClaim
namespace (in path): string, required
body:
dryRun (in query): string
gracePeriodSeconds (in query): integer
pretty (in query): string
propagationPolicy (in query): string
Response
200 (): OK
202 (ResourceClaim): Accepted
401: Unauthorized
deletecollection delete collection of ResourceClaim
HTTP Request
DELETE /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaims
Parameters
namespace (in path): string, required
body:
continue (in query): string
dryRun (in query): string
fieldSelector (in query): string
gracePeriodSeconds (in query): integer
labelSelector (in query): string
limit (in query): integer
pretty (in query): string
propagationPolicy (in query): string
resourceVersion (in query): string
resourceVersionMatch (in query): string
timeoutSeconds (in query): integer
Response
200 (Status): OK
401: Unauthorized
