VolumeAttachment

    apiVersion: storage.k8s.io/v1

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

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

    VolumeAttachment objects are non-namespaced.


    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

      nodeName represents 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)

        persistentVolumeName represents the name of the persistent volume to attach.

    VolumeAttachmentStatus is the status of a VolumeAttachment request.


    • attached (boolean), required

      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.

    • attachError (VolumeError)

      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.

      VolumeError captures an error encountered during a volume operation.

      • attachError.message (string)

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

      • attachError.time (Time)

        time represents the 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)

      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.

    • detachError (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.

      VolumeError captures an error encountered during a volume operation.

      • detachError.message (string)

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

      • detachError.time (Time)

        time represents the 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 is a collection of VolumeAttachment objects.



    HTTP Request

    GET /apis/storage.k8s.io/v1/volumeattachments/{name}

    Parameters

    • name (in path): string, required

      name of the VolumeAttachment

    • pretty (in query): string

      pretty

    Response

    200 (VolumeAttachment): OK

    401: Unauthorized

    get read status of the specified VolumeAttachment

    HTTP Request

    GET /apis/storage.k8s.io/v1/volumeattachments/{name}/status

    Parameters

    • name (in path): string, required

      name of the VolumeAttachment

    • pretty (in query): string

      pretty

    Response

    200 (VolumeAttachment): OK

    401: Unauthorized

    list or watch objects of kind VolumeAttachment

    HTTP Request

    GET /apis/storage.k8s.io/v1/volumeattachments

    Parameters

    • allowWatchBookmarks (in query): boolean

      allowWatchBookmarks

    • continue (in query): string

    • fieldSelector (in query): string

    • labelSelector (in query): string

      labelSelector

    • limit (in query): integer

    • pretty (in query): string

      pretty

    • resourceVersion (in query): string

    • resourceVersionMatch (in query): string

      resourceVersionMatch

    • sendInitialEvents (in query): boolean

    • timeoutSeconds (in query): integer

      timeoutSeconds

    • watch (in query): boolean

    Response

    200 (): OK

    401: Unauthorized

    HTTP Request

    POST /apis/storage.k8s.io/v1/volumeattachments

    Parameters

    • body: , required

    • dryRun (in query): string

      dryRun

    • fieldManager (in query): string

    • fieldValidation (in query): string

      fieldValidation

    • pretty (in query): string

    Response

    200 (): OK

    201 (VolumeAttachment): Created

    202 (): Accepted

    401: Unauthorized

    update replace the specified VolumeAttachment

    HTTP Request

    PUT /apis/storage.k8s.io/v1/volumeattachments/{name}

    Parameters

    • body: , required

    • dryRun (in query): string

      dryRun

    • fieldManager (in query): string

    • fieldValidation (in query): string

      fieldValidation

    • pretty (in query): string

    Response

    200 (): OK

    201 (VolumeAttachment): Created

    401: Unauthorized

    update replace status of the specified VolumeAttachment

    HTTP Request

    PUT /apis/storage.k8s.io/v1/volumeattachments/{name}/status

    Parameters

    • name (in path): string, required

      name of the VolumeAttachment

    • body: VolumeAttachment, required

    • dryRun (in query): string

    • fieldManager (in query): string

      fieldManager

    • fieldValidation (in query): string

    • pretty (in query): string

      pretty

    Response

    200 (VolumeAttachment): OK

    201 (): Created

    401: Unauthorized

    HTTP Request

    PATCH /apis/storage.k8s.io/v1/volumeattachments/{name}

    Parameters

    • name (in path): string, required

      name of the VolumeAttachment

    • body: , required

    • dryRun (in query): string

      dryRun

    • fieldValidation (in query): string

      fieldValidation

    • force (in query): boolean

    • pretty (in query): string

      pretty

    Response

    200 (VolumeAttachment): OK

    201 (): Created

    401: Unauthorized

    patch partially update status of the specified VolumeAttachment

    HTTP Request

    PATCH /apis/storage.k8s.io/v1/volumeattachments/{name}/status

    Parameters

    • name (in path): string, required

      name of the VolumeAttachment

    • body: , required

    • dryRun (in query): string

      dryRun

    • fieldManager (in query): string

    • fieldValidation (in query): string

      fieldValidation

    • force (in query): boolean

    • pretty (in query): string

      pretty

    Response

    200 (VolumeAttachment): OK

    201 (): Created

    401: Unauthorized

    delete delete a VolumeAttachment

    HTTP Request

    DELETE /apis/storage.k8s.io/v1/volumeattachments/{name}

    Parameters

    • name (in path): string, required

      name of the VolumeAttachment

    • body:

    • dryRun (in query): string

      dryRun

    • gracePeriodSeconds (in query): integer

    • pretty (in query): string

      pretty

    • propagationPolicy (in query): string

    Response

    200 (): OK

    202 (VolumeAttachment): Accepted

    401: Unauthorized

    HTTP Request

    DELETE /apis/storage.k8s.io/v1/volumeattachments

    Parameters

    • body: DeleteOptions

    • continue (in query): string

    • dryRun (in query): string

      dryRun

    • fieldSelector (in query): string

    • gracePeriodSeconds (in query): integer

      gracePeriodSeconds

    • labelSelector (in query): string

    • limit (in query): integer

      limit

    • pretty (in query): string

    • propagationPolicy (in query): string

      propagationPolicy

    • resourceVersion (in query): string

    • resourceVersionMatch (in query): string

      resourceVersionMatch

    • sendInitialEvents (in query): boolean

    Response

    200 (): OK

    401: Unauthorized