VolumeAttachment [storage.k8s.io/v1beta1] - storage.k8s.io | API reference

Important

Azure Red Hat OpenShift 3.11 will be retired 30 June 2022. Support for creation of new Azure Red Hat OpenShift 3.11 clusters continues through 30 November 2020. Following retirement, remaining Azure Red Hat OpenShift 3.11 clusters will be shut down to prevent security vulnerabilities.

Follow this guide to create an Azure Red Hat OpenShift 4 cluster. If you have specific questions, please contact us

Specification
API endpoints
- /apis/storage.k8s.io/v1beta1/volumeattachments
- /apis/storage.k8s.io/v1beta1/volumeattachments/{name}

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

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/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/api-conventions.md#types-kinds
`.metadata`	`ObjectMeta meta/v1`	Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
`.spec`	`object`	VolumeAttachmentSpec is the specification of a VolumeAttachment request.
`.status`	`object`	VolumeAttachmentStatus is the status of a VolumeAttachment request.

.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/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/api-conventions.md#types-kinds

.metadata

ObjectMeta meta/v1

Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/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

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.

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

Property	Type	Description
`persistentVolumeName`	`string`	Name of the persistent volume to attach.

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

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.

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

Property	Type	Description
`message`	`string`	String detailing the error encountered during Attach or Detach operation. This string maybe logged, so it should not contain sensitive information.
`time`	`Time meta/v1`	Time the error was encountered.

message

string

String detailing the error encountered during Attach or Detach operation. This string maybe 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

Property	Type	Description
`message`	`string`	String detailing the error encountered during Attach or Detach operation. This string maybe logged, so it should not contain sensitive information.
`time`	`Time meta/v1`	Time the error was encountered.

message

string

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

time

Time meta/v1

Time the error was encountered.

API endpoints

The following API endpoints are available:

/apis/storage.k8s.io/v1beta1/volumeattachments
- DELETE: delete collection of VolumeAttachment
- GET: list or watch objects of kind VolumeAttachment
- POST: create a VolumeAttachment
/apis/storage.k8s.io/v1beta1/volumeattachments/{name}
- DELETE: delete a VolumeAttachment
- GET: read the specified VolumeAttachment
- PATCH: partially update the specified VolumeAttachment
- PUT: replace the specified VolumeAttachment

/apis/storage.k8s.io/v1beta1/volumeattachments

Table 1. Global guery parameters
Parameter	Type	Description
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: DELETE
Description: delete collection of VolumeAttachment

Table 2. Query parameters
Parameter	Type	Description
`continue`	`string`	The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector`	`string`	A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized`	`boolean`	If true, partially initialized resources are included in the response.
`labelSelector`	`string`	A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit`	`integer`	limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion`	`string`	When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds`	`integer`	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch`	`boolean`	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Table 3. HTTP responses
HTTP code	Reponse body
200 - OK	`Status meta/v1`
401 - Unauthorized	Empty

HTTP method: GET
Description: list or watch objects of kind VolumeAttachment

Table 4. Query parameters
Parameter	Type	Description
`continue`	`string`	The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector`	`string`	A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized`	`boolean`	If true, partially initialized resources are included in the response.
`labelSelector`	`string`	A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit`	`integer`	limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion`	`string`	When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds`	`integer`	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch`	`boolean`	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Table 5. HTTP responses
HTTP code	Reponse body
200 - OK	`VolumeAttachmentList storage.k8s.io/v1beta1`
401 - Unauthorized	Empty

HTTP method: POST
Description: create a VolumeAttachment

Table 6. Body parameters
Parameter	Type	Description
`body`	`VolumeAttachment storage.k8s.io/v1beta1`

Table 7. HTTP responses
HTTP code	Reponse body
200 - OK	`VolumeAttachment storage.k8s.io/v1beta1`
201 - Created	`VolumeAttachment storage.k8s.io/v1beta1`
202 - Accepted	`VolumeAttachment storage.k8s.io/v1beta1`
401 - Unauthorized	Empty

/apis/storage.k8s.io/v1beta1/volumeattachments/{name}

Table 8. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the VolumeAttachment

Table 9. Global guery parameters
Parameter	Type	Description
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: DELETE
Description: delete a VolumeAttachment

Table 10. Query parameters
Parameter	Type	Description
`gracePeriodSeconds`	`integer`	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents`	`boolean`	Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy`	`string`	Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

Table 11. Body parameters
Parameter	Type	Description
`body`	`DeleteOptions meta/v1`

Table 12. HTTP responses
HTTP code	Reponse body
200 - OK	`Status meta/v1`
401 - Unauthorized	Empty

HTTP method: GET
Description: read the specified VolumeAttachment

Table 13. Query parameters
Parameter	Type	Description
`exact`	`boolean`	Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
`export`	`boolean`	Should this value be exported. Export strips fields that a user can not specify.

Table 14. HTTP responses
HTTP code	Reponse body
200 - OK	`VolumeAttachment storage.k8s.io/v1beta1`
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update the specified VolumeAttachment

Table 15. Body parameters
Parameter	Type	Description
`body`	`Patch meta/v1`

Table 16. HTTP responses
HTTP code	Reponse body
200 - OK	`VolumeAttachment storage.k8s.io/v1beta1`
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace the specified VolumeAttachment

Table 17. Body parameters
Parameter	Type	Description
`body`	`VolumeAttachment storage.k8s.io/v1beta1`

Table 18. HTTP responses
HTTP code	Reponse body
200 - OK	`VolumeAttachment storage.k8s.io/v1beta1`
201 - Created	`VolumeAttachment storage.k8s.io/v1beta1`
401 - Unauthorized	Empty