1. Documentation
×

VolumeAttributesClass [storage.k8s.io/v1]

Description

VolumeAttributesClass represents a specification of mutable volume attributes defined by the CSI driver. The class can be specified during dynamic provisioning of PersistentVolumeClaims, and changed in the PersistentVolumeClaim spec after provisioning.

Type

object

Required

  • driverName

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

driverName

string

Name of the CSI driver This field is immutable.

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

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

parameters

object (string)

parameters hold volume attributes defined by the CSI driver. These values are opaque to the Kubernetes and are passed directly to the CSI driver. The underlying storage provider supports changing these attributes on an existing volume, however the parameters field itself is immutable. To invoke a volume update, a new VolumeAttributesClass should be created with new parameters, and the PersistentVolumeClaim should be updated to reference the new VolumeAttributesClass.

This field is required and must contain at least one key/value pair. The keys cannot be empty, and the maximum number of parameters is 512, with a cumulative max size of 256K. If the CSI driver rejects invalid parameters, the target PersistentVolumeClaim will be set to an "Infeasible" state in the modifyVolumeStatus field.

API endpoints

The following API endpoints are available:

  • /apis/storage.k8s.io/v1/volumeattributesclasses

    • DELETE: delete collection of VolumeAttributesClass

    • GET: list or watch objects of kind VolumeAttributesClass

    • POST: create a VolumeAttributesClass

  • /apis/storage.k8s.io/v1/watch/volumeattributesclasses

    • GET: watch individual changes to a list of VolumeAttributesClass. deprecated: use the 'watch' parameter with a list operation instead.

  • /apis/storage.k8s.io/v1/volumeattributesclasses/{name}

    • DELETE: delete a VolumeAttributesClass

    • GET: read the specified VolumeAttributesClass

    • PATCH: partially update the specified VolumeAttributesClass

    • PUT: replace the specified VolumeAttributesClass

  • /apis/storage.k8s.io/v1/watch/volumeattributesclasses/{name}

    • GET: watch changes to an object of kind VolumeAttributesClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

/apis/storage.k8s.io/v1/volumeattributesclasses

HTTP method

DELETE

Description

delete collection of VolumeAttributesClass

Table 1. Query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
Table 2. HTTP responses
HTTP code Reponse body

200 - OK

Status schema

401 - Unauthorized

Empty
HTTP method

GET

Description

list or watch objects of kind VolumeAttributesClass

Table 3. HTTP responses
HTTP code Reponse body

200 - OK

VolumeAttributesClassList schema

401 - Unauthorized

Empty
HTTP method

POST

Description

create a VolumeAttributesClass

Table 4. Query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Table 5. Body parameters
Parameter Type Description

body

VolumeAttributesClass schema
Table 6. HTTP responses
HTTP code Reponse body

200 - OK

VolumeAttributesClass schema

201 - Created

VolumeAttributesClass schema

202 - Accepted

VolumeAttributesClass schema

401 - Unauthorized

Empty

/apis/storage.k8s.io/v1/watch/volumeattributesclasses

HTTP method

GET

Description

watch individual changes to a list of VolumeAttributesClass. deprecated: use the 'watch' parameter with a list operation instead.

Table 7. HTTP responses
HTTP code Reponse body

200 - OK

WatchEvent schema

401 - Unauthorized

Empty

/apis/storage.k8s.io/v1/volumeattributesclasses/{name}

Table 8. Global path parameters
Parameter Type Description

name

string

name of the VolumeAttributesClass
HTTP method

DELETE

Description

delete a VolumeAttributesClass

Table 9. Query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
Table 10. HTTP responses
HTTP code Reponse body

200 - OK

VolumeAttributesClass schema

202 - Accepted

VolumeAttributesClass schema

401 - Unauthorized

Empty
HTTP method

GET

Description

read the specified VolumeAttributesClass

Table 11. HTTP responses
HTTP code Reponse body

200 - OK

VolumeAttributesClass schema

401 - Unauthorized

Empty
HTTP method

PATCH

Description

partially update the specified VolumeAttributesClass

Table 12. Query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Table 13. HTTP responses
HTTP code Reponse body

200 - OK

VolumeAttributesClass schema

201 - Created

VolumeAttributesClass schema

401 - Unauthorized

Empty
HTTP method

PUT

Description

replace the specified VolumeAttributesClass

Table 14. Query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Table 15. Body parameters
Parameter Type Description

body

VolumeAttributesClass schema
Table 16. HTTP responses
HTTP code Reponse body

200 - OK

VolumeAttributesClass schema

201 - Created

VolumeAttributesClass schema

401 - Unauthorized

Empty

/apis/storage.k8s.io/v1/watch/volumeattributesclasses/{name}

Table 17. Global path parameters
Parameter Type Description

name

string

name of the VolumeAttributesClass
HTTP method

GET

Description

watch changes to an object of kind VolumeAttributesClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

Table 18. HTTP responses
HTTP code Reponse body

200 - OK

WatchEvent schema

401 - Unauthorized

Empty