CSIStorageCapacity

    apiVersion: storage.k8s.io/v1

    import "k8s.io/api/storage/v1"

    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 when a CSI driver opts into capacity-aware scheduling with CSIDriverSpec.StorageCapacity. The scheduler compares the MaximumVolumeSize against the requested size of pending volumes to filter out unsuitable nodes. If MaximumVolumeSize is unset, it falls back to a comparison against the less precise Capacity. If that is also unset, the scheduler assumes that capacity is insufficient and tries some other node.

    • apiVersion: storage.k8s.io/v1

    • kind: CSIStorageCapacity

    • storageClassName (string), required

      storageClassName represents 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.

    • capacity ()

      capacity is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields.

      The semantic is currently (CSI spec 1.2) defined as: The available capacity, in bytes, of the storage that can be used to provision volumes. If not set, that information is currently unavailable.

    • maximumVolumeSize (Quantity)

      maximumVolumeSize is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields.

      This is defined since CSI spec 1.4.0 as the largest size that may be used in a CreateVolumeRequest.capacity_range.required_bytes field to create a volume with the same parameters as those in GetCapacityRequest. The corresponding value in the Kubernetes API is ResourceRequirements.Requests in a volume claim.

    • nodeTopology ()

      nodeTopology defines which nodes have access to the storage for which capacity was reported. If not set, the storage is not accessible from any node in the cluster. If empty, the storage is accessible from all nodes. This field is immutable.

    CSIStorageCapacityList is a collection of CSIStorageCapacity objects.

    HTTP Request

    GET /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name}

    Parameters

    • name (in path): string, required

      name of the CSIStorageCapacity

    • namespace (in path): string, required

      namespace

    • pretty (in query): string

    Response

    200 (): OK

    401: Unauthorized

    list list or watch objects of kind CSIStorageCapacity

    HTTP Request

    GET /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities

    Parameters

    • namespace (in path): string, required

    • allowWatchBookmarks (in query): boolean

      allowWatchBookmarks

    • continue (in query): string

    • fieldSelector (in query): string

      fieldSelector

    • labelSelector (in query): string

    • limit (in query): integer

      limit

    • pretty (in query): string

    • resourceVersion (in query): string

      resourceVersion

    • resourceVersionMatch (in query): string

    • sendInitialEvents (in query): boolean

      sendInitialEvents

    • timeoutSeconds (in query): integer

    • watch

    Response

    200 (CSIStorageCapacityList): OK

    401: Unauthorized

    HTTP Request

    GET /apis/storage.k8s.io/v1/csistoragecapacities

    Parameters

    • allowWatchBookmarks (in query): boolean

      allowWatchBookmarks

    • continue (in query): string

    • fieldSelector (in query): string

      fieldSelector

    • labelSelector (in query): string

    • limit (in query): integer

      limit

    • pretty (in query): string

    • resourceVersion (in query): string

      resourceVersion

    • resourceVersionMatch (in query): string

    • sendInitialEvents (in query): boolean

      sendInitialEvents

    • timeoutSeconds (in query): integer

    • watch (in query): boolean

      watch

    Response

    200 (CSIStorageCapacityList): OK

    401: Unauthorized

    create create a CSIStorageCapacity

    HTTP Request

    POST /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities

    Parameters

    • namespace (in path): string, required

      namespace

    • body: , required

    • dryRun (in query): string

      dryRun

    • fieldValidation (in query): string

    • pretty (in query): string

      pretty

    Response

    200 (CSIStorageCapacity): OK

    201 (): Created

    202 (CSIStorageCapacity): Accepted

    401: Unauthorized

    HTTP Request

    PUT /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name}

    Parameters

    • name (in path): string, required

      name of the CSIStorageCapacity

    • namespace (in path): string, required

      namespace

    • body: , required

    • dryRun (in query): string

      dryRun

    • fieldManager (in query): string

    • fieldValidation (in query): string

      fieldValidation

    • pretty (in query): string

    Response

    200 (): OK

    201 (CSIStorageCapacity): Created

    401: Unauthorized

    patch partially update the specified CSIStorageCapacity

    HTTP Request

    PATCH /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name}

    Parameters

    • name (in path): string, required

    • namespace (in path): string, required

      namespace

    • body: , required

    • dryRun (in query): string

      dryRun

    • fieldManager (in query): string

    • fieldValidation (in query): string

      fieldValidation

    • force (in query): boolean

    • pretty (in query): string

      pretty

    Response

    200 (CSIStorageCapacity): OK

    201 (): Created

    401: Unauthorized

    HTTP Request

    DELETE /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name}

    Parameters

    • name (in path): string, required

      name of the CSIStorageCapacity

    • namespace (in path): string, required

    • body: DeleteOptions

    • dryRun (in query): string

    • gracePeriodSeconds (in query): integer

      gracePeriodSeconds

    • pretty (in query): string

    • propagationPolicy (in query): string

      propagationPolicy

    Response

    200 (Status): OK

    202 (): Accepted

    401: Unauthorized

    deletecollection delete collection of CSIStorageCapacity

    HTTP Request

    DELETE /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities

    Parameters

    • namespace (in path): string, required

    • body: DeleteOptions

    • continue (in query): string

    • dryRun (in query): string

      dryRun

    • fieldSelector (in query): string

    • gracePeriodSeconds (in query): integer

      gracePeriodSeconds

    • labelSelector (in query): string

    • limit (in query): integer

      limit

    • pretty (in query): string

    • propagationPolicy (in query): string

      propagationPolicy

    • resourceVersion (in query): string

    • resourceVersionMatch (in query): string

      resourceVersionMatch

    • sendInitialEvents (in query): boolean

    Response

    200 (): OK

    401: Unauthorized