# CSIStorageCapacity

CSIStorageCapacityCSIStorageCapacity stores the result of one CSI GetCapacity call.apiVersion: storage.k8s.io/v1import "k8s.io/api/storage/v1"CSIStorageCapacityCSIStorageCapacity 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 zeroThe 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/v1kind: CSIStorageCapacitymetadata (ObjectMeta)Standard object's metadata. The name has no particular meaning. It must be a DNS subdomain (dots allowed, 253 characters). To ensure that there are no conflicts with other CSI drivers on the cluster, the recommendation is to use csisc-<uuid>, a generated name, or a reverse-domain name which ends with the unique CSI driver name.Objects are namespaced.More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadatastorageClassName (string), requiredstorageClassName 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 (Quantity)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 (LabelSelector)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.CSIStorageCapacityListCSIStorageCapacityList is a collection of CSIStorageCapacity objects.apiVersion: storage.k8s.io/v1kind: CSIStorageCapacityListmetadata (ListMeta)Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadataitems ([]CSIStorageCapacity), requireditems is the list of CSIStorageCapacity objects.Operationsget read the specified CSIStorageCapacityHTTP RequestGET /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name}Parametersname (in path): string, requiredname of the CSIStorageCapacitynamespace (in path): string, requirednamespacepretty (in query): stringprettyResponse200 (CSIStorageCapacity): OK401: Unauthorizedlist list or watch objects of kind CSIStorageCapacityHTTP RequestGET /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacitiesParametersnamespace (in path): string, requirednamespaceallowWatchBookmarks (in query): booleanallowWatchBookmarkscontinue (in query): stringcontinuefieldSelector (in query): stringfieldSelectorlabelSelector (in query): stringlabelSelectorlimit (in query): integerlimitpretty (in query): stringprettyresourceVersion (in query): stringresourceVersionresourceVersionMatch (in query): stringresourceVersionMatchsendInitialEvents (in query): booleansendInitialEventstimeoutSeconds (in query): integertimeoutSecondswatch (in query): booleanwatchResponse200 (CSIStorageCapacityList): OK401: Unauthorizedlist list or watch objects of kind CSIStorageCapacityHTTP RequestGET /apis/storage.k8s.io/v1/csistoragecapacitiesParametersallowWatchBookmarks (in query): booleanallowWatchBookmarkscontinue (in query): stringcontinuefieldSelector (in query): stringfieldSelectorlabelSelector (in query): stringlabelSelectorlimit (in query): integerlimitpretty (in query): stringprettyresourceVersion (in query): stringresourceVersionresourceVersionMatch (in query): stringresourceVersionMatchsendInitialEvents (in query): booleansendInitialEventstimeoutSeconds (in query): integertimeoutSecondswatch (in query): booleanwatchResponse200 (CSIStorageCapacityList): OK401: Unauthorizedcreate create a CSIStorageCapacityHTTP RequestPOST /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacitiesParametersnamespace (in path): string, requirednamespacebody: CSIStorageCapacity, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationpretty (in query): stringprettyResponse200 (CSIStorageCapacity): OK201 (CSIStorageCapacity): Created202 (CSIStorageCapacity): Accepted401: Unauthorizedupdate replace the specified CSIStorageCapacityHTTP RequestPUT /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name}Parametersname (in path): string, requiredname of the CSIStorageCapacitynamespace (in path): string, requirednamespacebody: CSIStorageCapacity, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationpretty (in query): stringprettyResponse200 (CSIStorageCapacity): OK201 (CSIStorageCapacity): Created401: Unauthorizedpatch partially update the specified CSIStorageCapacityHTTP RequestPATCH /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name}Parametersname (in path): string, requiredname of the CSIStorageCapacitynamespace (in path): string, requirednamespacebody: Patch, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationforce (in query): booleanforcepretty (in query): stringprettyResponse200 (CSIStorageCapacity): OK201 (CSIStorageCapacity): Created401: Unauthorizeddelete delete a CSIStorageCapacityHTTP RequestDELETE /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name}Parametersname (in path): string, requiredname of the CSIStorageCapacitynamespace (in path): string, requirednamespacebody: DeleteOptionsdryRun (in query): stringdryRungracePeriodSeconds (in query): integergracePeriodSecondsignoreStoreReadErrorWithClusterBreakingPotential (in query): booleanignoreStoreReadErrorWithClusterBreakingPotentialpretty (in query): stringprettypropagationPolicy (in query): stringpropagationPolicyResponse200 (Status): OK202 (Status): Accepted401: Unauthorizeddeletecollection delete collection of CSIStorageCapacityHTTP RequestDELETE /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacitiesParametersnamespace (in path): string, requirednamespacebody: DeleteOptionscontinue (in query): stringcontinuedryRun (in query): stringdryRunfieldSelector (in query): stringfieldSelectorgracePeriodSeconds (in query): integergracePeriodSecondsignoreStoreReadErrorWithClusterBreakingPotential (in query): booleanignoreStoreReadErrorWithClusterBreakingPotentiallabelSelector (in query): stringlabelSelectorlimit (in query): integerlimitpretty (in query): stringprettypropagationPolicy (in query): stringpropagationPolicyresourceVersion (in query): stringresourceVersionresourceVersionMatch (in query): stringresourceVersionMatchsendInitialEvents (in query): booleansendInitialEventstimeoutSeconds (in query): integertimeoutSecondsResponse200 (Status): OK401: UnauthorizedThis page is automatically generated.If you plan to report an issue with this page, mention that the page is auto-generated in your issue description. The fix may need to happen elsewhere in the Kubernetes project.