## CSIStorageCapacity

# Struct CSIStorageCapacity

Source

    pub struct CSIStorageCapacity {
        pub capacity: Option<Quantity>,
        pub maximum_volume_size: Option<Quantity>,
        pub metadata: ObjectMeta,
        pub node_topology: Option<LabelSelector>,
        pub storage_class_name: String,
    }

Expand description

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.

## Fields§

§`capacity: Option<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.

§`maximum_volume_size: Option<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.

§`metadata: 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#metadata

§`node_topology: Option<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.

§`storage_class_name: String`

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.

## Trait Implementations§

Source§

### impl Clone for CSIStorageCapacity

Source§

#### fn clone(&self) -> CSIStorageCapacity

Returns a duplicate of the value. Read more
1.0.0 · Source§

#### fn clone_from(&mut self, source: &Self)

Performs copy-assignment from `source`. Read more
Source§

### impl Debug for CSIStorageCapacity

Source§

#### fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

### impl DeepMerge for CSIStorageCapacity

Source§

#### fn merge_from(&mut self, other: Self)

Merge `other` into `self`.
Source§

### impl Default for CSIStorageCapacity

Source§

#### fn default() -> CSIStorageCapacity

Returns the “default value” for a type. Read more
Source§

### impl<'de> Deserialize<'de> for CSIStorageCapacity

Source§

#### fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

### impl ListableResource for CSIStorageCapacity

Source§

#### const LIST_KIND: &'static str = "CSIStorageCapacityList"

The kind of the list type of the resource. Read more
Source§

### impl Metadata for CSIStorageCapacity

Source§

#### type Ty = ObjectMeta

The type of the metadata object.
Source§

#### fn metadata(&self) -> &<Self as Metadata>::Ty

Gets a reference to the metadata of this resource value.
Source§

#### fn metadata_mut(&mut self) -> &mut <Self as Metadata>::Ty

Gets a mutable reference to the metadata of this resource value.
Source§

### impl PartialEq for CSIStorageCapacity

Source§

#### fn eq(&self, other: &CSIStorageCapacity) -> bool

Tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 · Source§

#### fn ne(&self, other: &Rhs) -> bool

Tests for `!=`. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

### impl Resource for CSIStorageCapacity

Source§

#### const API_VERSION: &'static str = "storage.k8s.io/v1"

The API version of the resource. This is a composite of `Resource::GROUP` and `Resource::VERSION` (eg `"apiextensions.k8s.io/v1beta1"`) or just the version for resources without a group (eg `"v1"`). Read more
Source§

#### const GROUP: &'static str = "storage.k8s.io"

The group of the resource, or the empty string if the resource doesn’t have a group.
Source§

#### const KIND: &'static str = "CSIStorageCapacity"

The kind of the resource. Read more
Source§

#### const VERSION: &'static str = "v1"

The version of the resource.
Source§

#### const URL_PATH_SEGMENT: &'static str = "csistoragecapacities"

The URL path segment used to construct URLs related to this resource. Read more
Source§

#### type Scope = NamespaceResourceScope

Indicates whether the resource is namespace-scoped or cluster-scoped or a subresource. Read more
Source§

### impl Serialize for CSIStorageCapacity

Source§

#### fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

### impl StructuralPartialEq for CSIStorageCapacity

## Auto Trait Implementations§

§

### impl Freeze for CSIStorageCapacity

§

### impl RefUnwindSafe for CSIStorageCapacity

§

### impl Send for CSIStorageCapacity

§

### impl Sync for CSIStorageCapacity

§

### impl Unpin for CSIStorageCapacity

§

### impl UnwindSafe for CSIStorageCapacity

## Blanket Implementations§

Source§

### impl<T> Any for T
where T: 'static + ?Sized,

Source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
Source§

### impl<T> Borrow<T> for T
where T: ?Sized,

Source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

### impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

### impl<T> CloneToUninit for T
where T: Clone,

Source§

#### unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (`clone_to_uninit`)
Performs copy-assignment from `self` to `dest`. Read more
Source§

### impl<T> From<T> for T

Source§

#### fn from(t: T) -> T

Returns the argument unchanged.

Source§

### impl<T, U> Into<U> for T
where U: From<T>,

Source§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

Source§

### impl<T> ToOwned for T
where T: Clone,

Source§

#### type Owned = T

The resulting type after obtaining ownership.
Source§

#### fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

#### fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

### impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

#### type Error = Infallible

The type returned in the event of a conversion error.
Source§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

### impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

### impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,