package k8s.io.api.storage.v1alpha1

Get desktop application:
View/edit binary Protocol Buffers messages

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.

Used in: CSIStorageCapacityList

• optional apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1

  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

• optional apimachinery.pkg.apis.meta.v1.LabelSelector nodeTopology = 2

  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

• optional string storageClassName = 3

  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.

• optional apimachinery.pkg.api.resource.Quantity capacity = 4

  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. +optional

• optional apimachinery.pkg.api.resource.Quantity maximumVolumeSize = 5

  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

CSIStorageCapacityList is a collection of CSIStorageCapacity objects.

• optional apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1

  Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

• repeated CSIStorageCapacity items = 2

  Items is the list of CSIStorageCapacity objects. +listType=map +listMapKey=name

VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node. VolumeAttachment objects are non-namespaced.

Used in: VolumeAttachmentList

• optional apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1

  Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

• optional VolumeAttachmentSpec spec = 2

  Specification of the desired attach/detach volume behavior. Populated by the Kubernetes system.

• optional VolumeAttachmentStatus status = 3

  Status of the VolumeAttachment request. Populated by the entity completing the attach or detach operation, i.e. the external-attacher. +optional

VolumeAttachmentList is a collection of VolumeAttachment objects.

• optional apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1

  Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

• repeated VolumeAttachment items = 2

  Items is the list of VolumeAttachments

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.

Used in: VolumeAttachmentSpec

• optional string persistentVolumeName = 1

  Name of the persistent volume to attach. +optional

• optional core.v1.PersistentVolumeSpec inlineVolumeSpec = 2

  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

VolumeAttachmentSpec is the specification of a VolumeAttachment request.

Used in: VolumeAttachment

• optional string attacher = 1

  Attacher indicates the name of the volume driver that MUST handle this request. This is the name returned by GetPluginName().

• optional VolumeAttachmentSource source = 2

  Source represents the volume that should be attached.

• optional string nodeName = 3

  The node that the volume should be attached to.

VolumeAttachmentStatus is the status of a VolumeAttachment request.

Used in: VolumeAttachment

• optional bool attached = 1

  Indicates the volume is successfully attached. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.

• map<string, string> attachmentMetadata = 2

  Upon successful attach, this field is populated with any information returned by the attach operation 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

• optional VolumeError attachError = 3

  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

• optional VolumeError detachError = 4

  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

VolumeError captures an error encountered during a volume operation.

Used in: VolumeAttachmentStatus

• optional apimachinery.pkg.apis.meta.v1.Time time = 1

  Time the error was encountered. +optional

• optional string message = 2

  String detailing the error encountered during Attach or Detach operation. This string maybe logged, so it should not contain sensitive information. +optional