Description

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

VolumeAttachment objects are non-namespaced.

Type

object

Required
  • spec

Specification

Property Type Description

.apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

.kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

.metadata

ObjectMeta meta/v1

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

.spec

object

VolumeAttachmentSpec is the specification of a VolumeAttachment request.

.status

object

VolumeAttachmentStatus is the status of a VolumeAttachment request.

.spec
Description

VolumeAttachmentSpec is the specification of a VolumeAttachment request.

Type

object

Required
  • attacher

  • source

  • nodeName

Property Type Description

attacher

string

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

nodeName

string

The node that the volume should be attached to.

source

object

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.

.spec.source
Description

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.

Type

object

Property Type Description

inlineVolumeSpec

PersistentVolumeSpec core/v1

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.

persistentVolumeName

string

Name of the persistent volume to attach.

.status
Description

VolumeAttachmentStatus is the status of a VolumeAttachment request.

Type

object

Required
  • attached

Property Type Description

attachError

object

VolumeError captures an error encountered during a volume operation.

attached

boolean

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

attachmentMetadata

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

object

VolumeError captures an error encountered during a volume operation.

.status.attachError
Description

VolumeError captures an error encountered during a volume operation.

Type

object

Property Type Description

message

string

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

time

Time meta/v1

Time the error was encountered.

.status.detachError
Description

VolumeError captures an error encountered during a volume operation.

Type

object

Property Type Description

message

string

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

time

Time meta/v1

Time the error was encountered.