Struct k8s_openapi::api::storage::v1::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 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§
source§impl CSIStorageCapacity
impl CSIStorageCapacity
sourcepub fn create(
namespace: &str,
body: &CSIStorageCapacity,
optional: CreateOptional<'_>
) -> Result<(Request<Vec<u8>>, fn(_: StatusCode) -> ResponseBody<CreateResponse<Self>>), RequestError>
pub fn create( namespace: &str, body: &CSIStorageCapacity, optional: CreateOptional<'_> ) -> Result<(Request<Vec<u8>>, fn(_: StatusCode) -> ResponseBody<CreateResponse<Self>>), RequestError>
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.
source§impl CSIStorageCapacity
impl CSIStorageCapacity
sourcepub fn delete_collection(
namespace: &str,
delete_optional: DeleteOptional<'_>,
list_optional: ListOptional<'_>
) -> Result<(Request<Vec<u8>>, fn(_: StatusCode) -> ResponseBody<DeleteResponse<List<Self>>>), RequestError>
pub fn delete_collection( namespace: &str, delete_optional: DeleteOptional<'_>, list_optional: ListOptional<'_> ) -> Result<(Request<Vec<u8>>, fn(_: StatusCode) -> ResponseBody<DeleteResponse<List<Self>>>), RequestError>
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.
source§impl CSIStorageCapacity
impl CSIStorageCapacity
sourcepub fn delete(
name: &str,
namespace: &str,
optional: DeleteOptional<'_>
) -> Result<(Request<Vec<u8>>, fn(_: StatusCode) -> ResponseBody<DeleteResponse<Self>>), RequestError>
pub fn delete( name: &str, namespace: &str, optional: DeleteOptional<'_> ) -> Result<(Request<Vec<u8>>, fn(_: StatusCode) -> ResponseBody<DeleteResponse<Self>>), RequestError>
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.
source§impl CSIStorageCapacity
impl CSIStorageCapacity
sourcepub fn list_for_all_namespaces(
optional: ListOptional<'_>
) -> Result<(Request<Vec<u8>>, fn(_: StatusCode) -> ResponseBody<ListResponse<Self>>), RequestError>
pub fn list_for_all_namespaces( optional: ListOptional<'_> ) -> Result<(Request<Vec<u8>>, fn(_: StatusCode) -> ResponseBody<ListResponse<Self>>), RequestError>
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.
source§impl CSIStorageCapacity
impl CSIStorageCapacity
sourcepub fn list(
namespace: &str,
optional: ListOptional<'_>
) -> Result<(Request<Vec<u8>>, fn(_: StatusCode) -> ResponseBody<ListResponse<Self>>), RequestError>
pub fn list( namespace: &str, optional: ListOptional<'_> ) -> Result<(Request<Vec<u8>>, fn(_: StatusCode) -> ResponseBody<ListResponse<Self>>), RequestError>
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.
source§impl CSIStorageCapacity
impl CSIStorageCapacity
sourcepub fn patch(
name: &str,
namespace: &str,
body: &Patch,
optional: PatchOptional<'_>
) -> Result<(Request<Vec<u8>>, fn(_: StatusCode) -> ResponseBody<PatchResponse<Self>>), RequestError>
pub fn patch( name: &str, namespace: &str, body: &Patch, optional: PatchOptional<'_> ) -> Result<(Request<Vec<u8>>, fn(_: StatusCode) -> ResponseBody<PatchResponse<Self>>), RequestError>
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.
source§impl CSIStorageCapacity
impl CSIStorageCapacity
sourcepub fn read(
name: &str,
namespace: &str
) -> Result<(Request<Vec<u8>>, fn(_: StatusCode) -> ResponseBody<ReadCSIStorageCapacityResponse>), RequestError>
pub fn read( name: &str, namespace: &str ) -> Result<(Request<Vec<u8>>, fn(_: StatusCode) -> ResponseBody<ReadCSIStorageCapacityResponse>), RequestError>
read the specified CSIStorageCapacity
Use the returned crate::ResponseBody
<
ReadCSIStorageCapacityResponse
>
constructor, or ReadCSIStorageCapacityResponse
directly, to parse the HTTP response.
Arguments
-
name
name of the CSIStorageCapacity
-
namespace
object name and auth scope, such as for teams and projects
source§impl CSIStorageCapacity
impl CSIStorageCapacity
sourcepub fn replace(
name: &str,
namespace: &str,
body: &CSIStorageCapacity,
optional: ReplaceOptional<'_>
) -> Result<(Request<Vec<u8>>, fn(_: StatusCode) -> ResponseBody<ReplaceResponse<Self>>), RequestError>
pub fn replace( name: &str, namespace: &str, body: &CSIStorageCapacity, optional: ReplaceOptional<'_> ) -> Result<(Request<Vec<u8>>, fn(_: StatusCode) -> ResponseBody<ReplaceResponse<Self>>), RequestError>
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.
source§impl CSIStorageCapacity
impl CSIStorageCapacity
sourcepub fn watch_for_all_namespaces(
optional: WatchOptional<'_>
) -> Result<(Request<Vec<u8>>, fn(_: StatusCode) -> ResponseBody<WatchResponse<Self>>), RequestError>
pub fn watch_for_all_namespaces( optional: WatchOptional<'_> ) -> Result<(Request<Vec<u8>>, fn(_: StatusCode) -> ResponseBody<WatchResponse<Self>>), RequestError>
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.
source§impl CSIStorageCapacity
impl CSIStorageCapacity
sourcepub fn watch(
namespace: &str,
optional: WatchOptional<'_>
) -> Result<(Request<Vec<u8>>, fn(_: StatusCode) -> ResponseBody<WatchResponse<Self>>), RequestError>
pub fn watch( namespace: &str, optional: WatchOptional<'_> ) -> Result<(Request<Vec<u8>>, fn(_: StatusCode) -> ResponseBody<WatchResponse<Self>>), RequestError>
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§
source§impl Clone for CSIStorageCapacity
impl Clone for CSIStorageCapacity
source§fn clone(&self) -> CSIStorageCapacity
fn clone(&self) -> CSIStorageCapacity
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for CSIStorageCapacity
impl Debug for CSIStorageCapacity
source§impl DeepMerge for CSIStorageCapacity
impl DeepMerge for CSIStorageCapacity
source§fn merge_from(&mut self, other: Self)
fn merge_from(&mut self, other: Self)
other
into self
.source§impl Default for CSIStorageCapacity
impl Default for CSIStorageCapacity
source§fn default() -> CSIStorageCapacity
fn default() -> CSIStorageCapacity
source§impl<'de> Deserialize<'de> for CSIStorageCapacity
impl<'de> Deserialize<'de> for CSIStorageCapacity
source§fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
D: Deserializer<'de>,
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where D: Deserializer<'de>,
source§impl Metadata for CSIStorageCapacity
impl Metadata for CSIStorageCapacity
source§impl PartialEq<CSIStorageCapacity> for CSIStorageCapacity
impl PartialEq<CSIStorageCapacity> for CSIStorageCapacity
source§fn eq(&self, other: &CSIStorageCapacity) -> bool
fn eq(&self, other: &CSIStorageCapacity) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl Resource for CSIStorageCapacity
impl Resource for CSIStorageCapacity
source§const API_VERSION: &'static str = "storage.k8s.io/v1"
const API_VERSION: &'static str = "storage.k8s.io/v1"
Resource::GROUP
and Resource::VERSION
(eg "apiextensions.k8s.io/v1beta1"
)
or just the version for resources without a group (eg "v1"
). Read more