VolumeAttributesClass v1beta1

VolumeAttributesClass represents a specification of mutable volume attributes defined by the CSI driver.

apiVersion: storage.k8s.io/v1beta1

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

VolumeAttributesClass

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.

  • apiVersion: storage.k8s.io/v1beta1

  • kind: VolumeAttributesClass

  • metadata (ObjectMeta)

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

  • driverName (string), required

    Name of the CSI driver This field is immutable.

  • parameters (map[string]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.

VolumeAttributesClassList

VolumeAttributesClassList is a collection of VolumeAttributesClass objects.

Operations

get read the specified VolumeAttributesClass

HTTP Request

GET /apis/storage.k8s.io/v1beta1/volumeattributesclasses/{name}

Parameters

  • name (in path): string, required

    name of the VolumeAttributesClass

  • pretty (in query): string

    pretty

Response

200 (VolumeAttributesClass): OK

401: Unauthorized

list list or watch objects of kind VolumeAttributesClass

HTTP Request

GET /apis/storage.k8s.io/v1beta1/volumeattributesclasses

Parameters

Response

200 (VolumeAttributesClassList): OK

401: Unauthorized

create create a VolumeAttributesClass

HTTP Request

POST /apis/storage.k8s.io/v1beta1/volumeattributesclasses

Parameters

Response

200 (VolumeAttributesClass): OK

201 (VolumeAttributesClass): Created

202 (VolumeAttributesClass): Accepted

401: Unauthorized

update replace the specified VolumeAttributesClass

HTTP Request

PUT /apis/storage.k8s.io/v1beta1/volumeattributesclasses/{name}

Parameters

Response

200 (VolumeAttributesClass): OK

201 (VolumeAttributesClass): Created

401: Unauthorized

patch partially update the specified VolumeAttributesClass

HTTP Request

PATCH /apis/storage.k8s.io/v1beta1/volumeattributesclasses/{name}

Parameters

  • name (in path): string, required

    name of the VolumeAttributesClass

  • body: Patch, required

  • dryRun (in query): string

    dryRun

  • fieldManager (in query): string

    fieldManager

  • fieldValidation (in query): string

    fieldValidation

  • force (in query): boolean

    force

  • pretty (in query): string

    pretty

Response

200 (VolumeAttributesClass): OK

201 (VolumeAttributesClass): Created

401: Unauthorized

delete delete a VolumeAttributesClass

HTTP Request

DELETE /apis/storage.k8s.io/v1beta1/volumeattributesclasses/{name}

Parameters

Response

200 (VolumeAttributesClass): OK

202 (VolumeAttributesClass): Accepted

401: Unauthorized

deletecollection delete collection of VolumeAttributesClass

HTTP Request

DELETE /apis/storage.k8s.io/v1beta1/volumeattributesclasses

Parameters

Response

200 (Status): OK

401: Unauthorized