CSIStorageCapacity v1beta1
apiVersion: storage.k8s.io/v1beta1
import "k8s.io/api/storage/v1beta1"
CSIStorageCapacity
CSIStorageCapacity stores the result of one CSI GetCapacity call. For a given StorageClass, this describes the available capacity in a particular topology segment. This can be used when considering where to instantiate new PersistentVolumes.
For example this can express things like: - StorageClass "standard" has "1234 GiB" available in "topology.kubernetes.io/zone=us-east1" - StorageClass "localssd" has "10 GiB" available in "kubernetes.io/hostname=knode-abc123"
The following three cases all imply that no capacity is available for a certain combination: - no object exists with suitable topology and storage class name - such an object exists, but the capacity is unset - such an object exists, but the capacity is zero
The producer of these objects can decide which approach is more suitable.
They are consumed by the kube-scheduler if the CSIStorageCapacity beta feature gate is enabled there and a CSI driver opts into capacity-aware scheduling with CSIDriver.StorageCapacity.
-
apiVersion: storage.k8s.io/v1beta1
-
kind: CSIStorageCapacity
-
storageClassName (string), required
The name of the StorageClass that the reported capacity applies to. It must meet the same requirements as the name of a StorageClass object (non-empty, DNS subdomain). If that object no longer exists, the CSIStorageCapacity object is obsolete and should be removed by its creator. This field is immutable.
CSIStorageCapacityList
CSIStorageCapacityList is a collection of CSIStorageCapacity objects.
Operations
get read the specified CSIStorageCapacity
HTTP Request
GET /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities/{name}
Parameters
-
name (in path): string, required
name of the CSIStorageCapacity
-
namespace (in path): string, required
-
pretty (in query): string
Response
200 (
401: Unauthorized GET /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities 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 200 (
401: Unauthorized GET /apis/storage.k8s.io/v1beta1/csistoragecapacities 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 200 (
401: Unauthorized POST /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities namespace (in path): string, required dryRun (in query): string fieldManager (in query): string fieldValidation (in query): string pretty (in query): string 200 (
201 (
202 (
401: Unauthorized PUT /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities/{name} name (in path): string, required name of the CSIStorageCapacity namespace (in path): string, required dryRun (in query): string fieldManager (in query): string fieldValidation (in query): string pretty (in query): string 200 (
201 (
401: Unauthorized PATCH /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities/{name} name (in path): string, required name of the CSIStorageCapacity namespace (in path): string, required dryRun (in query): string fieldManager (in query): string fieldValidation (in query): string force (in query): boolean pretty (in query): string 200 (
201 (
401: Unauthorized DELETE /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities/{name} name (in path): string, required name of the CSIStorageCapacity namespace (in path): string, required dryRun (in query): string gracePeriodSeconds (in query): integer pretty (in query): string propagationPolicy (in query): string 200 (
202 (
401: Unauthorized DELETE /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities namespace (in path): string, required 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 200 (
401: Unauthorizedlist list or watch objects of kind CSIStorageCapacityHTTP Request
Parameters
Response
list list or watch objects of kind CSIStorageCapacityHTTP Request
Parameters
Response
create create a CSIStorageCapacityHTTP Request
Parameters
Response
update replace the specified CSIStorageCapacityHTTP Request
Parameters
Response
patch partially update the specified CSIStorageCapacityHTTP Request
Parameters
Response
delete delete a CSIStorageCapacityHTTP Request
Parameters
Response
deletecollection delete collection of CSIStorageCapacityHTTP Request
Parameters
Response