1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
/// 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.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CsiStorageCapacity {
/// 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>
/// +optional
#[prost(message, optional, tag = "1")]
pub metadata: ::core::option::Option<
super::super::super::apimachinery::pkg::apis::meta::v1::ObjectMeta,
>,
/// 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.
///
/// +optional
#[prost(message, optional, tag = "2")]
pub node_topology: ::core::option::Option<
super::super::super::apimachinery::pkg::apis::meta::v1::LabelSelector,
>,
/// 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.
#[prost(string, optional, tag = "3")]
pub storage_class_name: ::core::option::Option<::prost::alloc::string::String>,
/// 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.
///
/// +optional
#[prost(message, optional, tag = "4")]
pub capacity: ::core::option::Option<
super::super::super::apimachinery::pkg::api::resource::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.
///
/// +optional
#[prost(message, optional, tag = "5")]
pub maximum_volume_size: ::core::option::Option<
super::super::super::apimachinery::pkg::api::resource::Quantity,
>,
}
/// CSIStorageCapacityList is a collection of CSIStorageCapacity objects.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CsiStorageCapacityList {
/// Standard list metadata
/// More info: <https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata>
/// +optional
#[prost(message, optional, tag = "1")]
pub metadata: ::core::option::Option<
super::super::super::apimachinery::pkg::apis::meta::v1::ListMeta,
>,
/// items is the list of CSIStorageCapacity objects.
/// +listType=map
/// +listMapKey=name
#[prost(message, repeated, tag = "2")]
pub items: ::prost::alloc::vec::Vec<CsiStorageCapacity>,
}
/// VolumeAttachment captures the intent to attach or detach the specified volume
/// to/from the specified node.
///
/// VolumeAttachment objects are non-namespaced.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct VolumeAttachment {
/// Standard object metadata.
/// More info: <https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata>
/// +optional
#[prost(message, optional, tag = "1")]
pub metadata: ::core::option::Option<
super::super::super::apimachinery::pkg::apis::meta::v1::ObjectMeta,
>,
/// spec represents specification of the desired attach/detach volume behavior.
/// Populated by the Kubernetes system.
#[prost(message, optional, tag = "2")]
pub spec: ::core::option::Option<VolumeAttachmentSpec>,
/// status represents status of the VolumeAttachment request.
/// Populated by the entity completing the attach or detach
/// operation, i.e. the external-attacher.
/// +optional
#[prost(message, optional, tag = "3")]
pub status: ::core::option::Option<VolumeAttachmentStatus>,
}
/// VolumeAttachmentList is a collection of VolumeAttachment objects.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct VolumeAttachmentList {
/// Standard list metadata
/// More info: <https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata>
/// +optional
#[prost(message, optional, tag = "1")]
pub metadata: ::core::option::Option<
super::super::super::apimachinery::pkg::apis::meta::v1::ListMeta,
>,
/// items is the list of VolumeAttachments
#[prost(message, repeated, tag = "2")]
pub items: ::prost::alloc::vec::Vec<VolumeAttachment>,
}
/// VolumeAttachmentSource represents a volume that should be attached.
/// Right now only PersistenVolumes can be attached via external attacher,
/// in future we may allow also inline volumes in pods.
/// Exactly one member can be set.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct VolumeAttachmentSource {
/// persistentVolumeName represents the name of the persistent volume to attach.
/// +optional
#[prost(string, optional, tag = "1")]
pub persistent_volume_name: ::core::option::Option<::prost::alloc::string::String>,
/// inlineVolumeSpec contains all the information necessary to attach
/// a persistent volume defined by a pod's inline VolumeSource. This field
/// is populated only for the CSIMigration feature. It contains
/// translated fields from a pod's inline VolumeSource to a
/// PersistentVolumeSpec. This field is alpha-level and is only
/// honored by servers that enabled the CSIMigration feature.
/// +optional
#[prost(message, optional, tag = "2")]
pub inline_volume_spec: ::core::option::Option<
super::super::core::v1::PersistentVolumeSpec,
>,
}
/// VolumeAttachmentSpec is the specification of a VolumeAttachment request.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct VolumeAttachmentSpec {
/// attacher indicates the name of the volume driver that MUST handle this
/// request. This is the name returned by GetPluginName().
#[prost(string, optional, tag = "1")]
pub attacher: ::core::option::Option<::prost::alloc::string::String>,
/// source represents the volume that should be attached.
#[prost(message, optional, tag = "2")]
pub source: ::core::option::Option<VolumeAttachmentSource>,
/// nodeName represents the node that the volume should be attached to.
#[prost(string, optional, tag = "3")]
pub node_name: ::core::option::Option<::prost::alloc::string::String>,
}
/// VolumeAttachmentStatus is the status of a VolumeAttachment request.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct VolumeAttachmentStatus {
/// attached indicates the volume is successfully attached.
/// This field must only be set by the entity completing the attach
/// operation, i.e. the external-attacher.
#[prost(bool, optional, tag = "1")]
pub attached: ::core::option::Option<bool>,
/// attachmentMetadata is populated with any
/// information returned by the attach operation, upon successful attach, that must be passed
/// into subsequent WaitForAttach or Mount calls.
/// This field must only be set by the entity completing the attach
/// operation, i.e. the external-attacher.
/// +optional
#[prost(map = "string, string", tag = "2")]
pub attachment_metadata: ::std::collections::HashMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// attachError represents the last error encountered during attach operation, if any.
/// This field must only be set by the entity completing the attach
/// operation, i.e. the external-attacher.
/// +optional
#[prost(message, optional, tag = "3")]
pub attach_error: ::core::option::Option<VolumeError>,
/// detachError represents the last error encountered during detach operation, if any.
/// This field must only be set by the entity completing the detach
/// operation, i.e. the external-attacher.
/// +optional
#[prost(message, optional, tag = "4")]
pub detach_error: ::core::option::Option<VolumeError>,
}
/// VolumeAttributesClass represents a specification of mutable volume attributes
/// defined by the CSI driver. The class can be specified during dynamic provisioning
/// of PersistentVolumeClaims, and changed in the PersistentVolumeClaim spec after provisioning.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct VolumeAttributesClass {
/// Standard object's metadata.
/// More info: <https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata>
/// +optional
#[prost(message, optional, tag = "1")]
pub metadata: ::core::option::Option<
super::super::super::apimachinery::pkg::apis::meta::v1::ObjectMeta,
>,
/// Name of the CSI driver
/// This field is immutable.
#[prost(string, optional, tag = "2")]
pub driver_name: ::core::option::Option<::prost::alloc::string::String>,
/// parameters hold volume attributes defined by the CSI driver. These values
/// are opaque to the Kubernetes and are passed directly to the CSI driver.
/// The underlying storage provider supports changing these attributes on an
/// existing volume, however the parameters field itself is immutable. To
/// invoke a volume update, a new VolumeAttributesClass should be created with
/// new parameters, and the PersistentVolumeClaim should be updated to reference
/// the new VolumeAttributesClass.
///
/// This field is required and must contain at least one key/value pair.
/// The keys cannot be empty, and the maximum number of parameters is 512, with
/// a cumulative max size of 256K. If the CSI driver rejects invalid parameters,
/// the target PersistentVolumeClaim will be set to an "Infeasible" state in the
/// modifyVolumeStatus field.
#[prost(map = "string, string", tag = "3")]
pub parameters: ::std::collections::HashMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
}
/// VolumeAttributesClassList is a collection of VolumeAttributesClass objects.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct VolumeAttributesClassList {
/// Standard list metadata
/// More info: <https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata>
/// +optional
#[prost(message, optional, tag = "1")]
pub metadata: ::core::option::Option<
super::super::super::apimachinery::pkg::apis::meta::v1::ListMeta,
>,
/// items is the list of VolumeAttributesClass objects.
#[prost(message, repeated, tag = "2")]
pub items: ::prost::alloc::vec::Vec<VolumeAttributesClass>,
}
/// VolumeError captures an error encountered during a volume operation.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct VolumeError {
/// time represents the time the error was encountered.
/// +optional
#[prost(message, optional, tag = "1")]
pub time: ::core::option::Option<
super::super::super::apimachinery::pkg::apis::meta::v1::Time,
>,
/// message represents the error encountered during Attach or Detach operation.
/// This string maybe logged, so it should not contain sensitive
/// information.
/// +optional
#[prost(string, optional, tag = "2")]
pub message: ::core::option::Option<::prost::alloc::string::String>,
}
impl crate::Resource for VolumeAttributesClass {
const API_VERSION: &'static str = "storage.k8s.io/v1alpha1";
const GROUP: &'static str = "storage.k8s.io";
const VERSION: &'static str = "v1alpha1";
const KIND: &'static str = "VolumeAttributesClass";
const URL_PATH_SEGMENT: &'static str = "volumeattributesclasses";
type Scope = crate::ClusterResourceScope;
}
impl crate::HasMetadata for VolumeAttributesClass {
type Metadata = crate::apimachinery::pkg::apis::meta::v1::ObjectMeta;
fn metadata(&self) -> Option<&<Self as crate::HasMetadata>::Metadata> {
self.metadata.as_ref()
}
fn metadata_mut(&mut self) -> Option<&mut <Self as crate::HasMetadata>::Metadata> {
self.metadata.as_mut()
}
}