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 if the CSIStorageCapacity beta feature gate is enabled there and a CSI driver opts into capacity-aware scheduling with CSIDriver.StorageCapacity.

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 and treated like zero capacity.

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 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

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.

Implementations

create a CSIStorageCapacity

Use the returned crate::ResponseBody<crate::CreateResponse<Self>> constructor, or crate::CreateResponse<Self> directly, to parse the HTTP response.

Arguments
  • namespace

    object name and auth scope, such as for teams and projects

  • body

  • optional

    Optional parameters. Use Default::default() to not pass any.

delete collection of CSIStorageCapacity

Use the returned crate::ResponseBody<crate::DeleteResponse<crate::List<Self>>> constructor, or crate::DeleteResponse<crate::List<Self>> directly, to parse the HTTP response.

Arguments
  • namespace

    object name and auth scope, such as for teams and projects

  • delete_optional

    Delete options. Use Default::default() to not pass any.

  • list_optional

    List options. Use Default::default() to not pass any.

delete a CSIStorageCapacity

Use the returned crate::ResponseBody<crate::DeleteResponse<Self>> constructor, or crate::DeleteResponse<Self> directly, to parse the HTTP response.

Arguments
  • name

    name of the CSIStorageCapacity

  • namespace

    object name and auth scope, such as for teams and projects

  • optional

    Optional parameters. Use Default::default() to not pass any.

list or watch objects of kind CSIStorageCapacity

This operation only supports listing all items of this type.

Use the returned crate::ResponseBody<crate::ListResponse<Self>> constructor, or crate::ListResponse<Self> directly, to parse the HTTP response.

Arguments
  • optional

    Optional parameters. Use Default::default() to not pass any.

list or watch objects of kind CSIStorageCapacity

This operation only supports listing all items of this type.

Use the returned crate::ResponseBody<crate::ListResponse<Self>> constructor, or crate::ListResponse<Self> directly, to parse the HTTP response.

Arguments
  • namespace

    object name and auth scope, such as for teams and projects

  • optional

    Optional parameters. Use Default::default() to not pass any.

partially update the specified CSIStorageCapacity

Use the returned crate::ResponseBody<crate::PatchResponse<Self>> constructor, or crate::PatchResponse<Self> directly, to parse the HTTP response.

Arguments
  • name

    name of the CSIStorageCapacity

  • namespace

    object name and auth scope, such as for teams and projects

  • body

  • optional

    Optional parameters. Use Default::default() to not pass any.

read the specified CSIStorageCapacity

Use the returned crate::ResponseBody<ReadNamespacedCSIStorageCapacityResponse> constructor, or ReadNamespacedCSIStorageCapacityResponse directly, to parse the HTTP response.

Arguments
  • name

    name of the CSIStorageCapacity

  • namespace

    object name and auth scope, such as for teams and projects

  • optional

    Optional parameters. Use Default::default() to not pass any.

replace the specified CSIStorageCapacity

Use the returned crate::ResponseBody<crate::ReplaceResponse<Self>> constructor, or crate::ReplaceResponse<Self> directly, to parse the HTTP response.

Arguments
  • name

    name of the CSIStorageCapacity

  • namespace

    object name and auth scope, such as for teams and projects

  • body

  • optional

    Optional parameters. Use Default::default() to not pass any.

list or watch objects of kind CSIStorageCapacity

This operation only supports watching one item, or a list of items, of this type for changes.

Use the returned crate::ResponseBody<crate::WatchResponse<Self>> constructor, or crate::WatchResponse<Self> directly, to parse the HTTP response.

Arguments
  • optional

    Optional parameters. Use Default::default() to not pass any.

list or watch objects of kind CSIStorageCapacity

This operation only supports watching one item, or a list of items, of this type for changes.

Use the returned crate::ResponseBody<crate::WatchResponse<Self>> constructor, or crate::WatchResponse<Self> directly, to parse the HTTP response.

Arguments
  • namespace

    object name and auth scope, such as for teams and projects

  • optional

    Optional parameters. Use Default::default() to not pass any.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

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

Deserialize this value from the given Serde deserializer. Read more

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

The type of the metadata object.

Gets a reference to the metadata of this resource value.

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

This method tests for self and other values to be equal, and is used by ==. Read more

This method tests for !=.

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

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

The kind of the resource. Read more

The version of the resource.

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

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

Performs the conversion.

The resulting type after obtaining ownership.

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.