VolumeAttachment

apiVersion: storage.k8s.io/v1

import "k8s.io/api/storage/v1"

VolumeAttachment

VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node.

VolumeAttachment objects are non-namespaced.

• apiVersion: storage.k8s.io/v1

• kind: VolumeAttachment

• metadata (ObjectMeta)

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

• spec (VolumeAttachmentSpec), required

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

• status (VolumeAttachmentStatus)

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

VolumeAttachmentSpec

VolumeAttachmentSpec is the specification of a VolumeAttachment request.

• attacher (string), required

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

• nodeName (string), required

  The node that the volume should be attached to.

• source (VolumeAttachmentSource), required

  Source represents the volume that should be attached.

  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.

  • source.inlineVolumeSpec (PersistentVolumeSpec)

    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 beta-level and is only honored by servers that enabled the CSIMigration feature.

  • source.persistentVolumeName (string)

    Name of the persistent volume to attach.

VolumeAttachmentStatus

VolumeAttachmentStatus is the status of a VolumeAttachment request.

• attached (boolean), required

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

• attachError (VolumeError)

  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.

  VolumeError captures an error encountered during a volume operation.

  • attachError.message (string)

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

  • attachError.time (Time)

    Time the error was encountered.

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

• attachmentMetadata (map[string]string)

  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.

• detachError (VolumeError)

  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.

  VolumeError captures an error encountered during a volume operation.

  • detachError.message (string)

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

  • detachError.time (Time)

    Time the error was encountered.

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

VolumeAttachmentList

VolumeAttachmentList is a collection of VolumeAttachment objects.

• apiVersion: storage.k8s.io/v1

• kind: VolumeAttachmentList

• metadata (ListMeta)

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

• items ([]VolumeAttachment), required

  Items is the list of VolumeAttachments