StorageClass

    apiVersion: storage.k8s.io/v1

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

    StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned.

    StorageClasses are non-namespaced; the name of the storage class according to etcd is in ObjectMeta.Name.


    • apiVersion: storage.k8s.io/v1

    • metadata ()

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

    • provisioner (string), required

      provisioner indicates the type of the provisioner.

    • allowVolumeExpansion (boolean)

      allowVolumeExpansion shows whether the storage class allow volume expand.

    • allowedTopologies ([]TopologySelectorTerm)

      Atomic: will be replaced during a merge

      allowedTopologies restrict the node topologies where volumes can be dynamically provisioned. Each volume plugin defines its own supported topology specifications. An empty TopologySelectorTerm list means there is no topology restriction. This field is only honored by servers that enable the VolumeScheduling feature.

      A topology selector term represents the result of label queries. A null or empty topology selector term matches no objects. The requirements of them are ANDed. It provides a subset of functionality as NodeSelectorTerm. This is an alpha feature and may change in the future.

      • allowedTopologies.matchLabelExpressions ([]TopologySelectorLabelRequirement)

        A list of topology selector requirements by labels.

        A topology selector requirement is a selector that matches given label. This is an alpha feature and may change in the future.

        • allowedTopologies.matchLabelExpressions.key (string), required

          The label key that the selector applies to.

        • allowedTopologies.matchLabelExpressions.values ([]string), required

          An array of string values. One value must match the label to be selected. Each entry in Values is ORed.

    • mountOptions ([]string)

      mountOptions controls the mountOptions for dynamically provisioned PersistentVolumes of this storage class. e.g. [“ro”, “soft”]. Not validated - mount of the PVs will simply fail if one is invalid.

    • parameters (map[string]string)

      parameters holds the parameters for the provisioner that should create volumes of this storage class.

    • reclaimPolicy (string)

      reclaimPolicy controls the reclaimPolicy for dynamically provisioned PersistentVolumes of this storage class. Defaults to Delete.

    • volumeBindingMode (string)

      volumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. When unset, VolumeBindingImmediate is used. This field is only honored by servers that enable the VolumeScheduling feature.

    StorageClassList is a collection of storage classes.


    • apiVersion: storage.k8s.io/v1

    • kind: StorageClassList

    • metadata (ListMeta)

      Standard list metadata More info:

    • items ([]StorageClass), required

      items is the list of StorageClasses


    HTTP Request

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

    Parameters

    • name (in path): string, required

      name of the StorageClass

    • pretty (in query): string

    Response

    200 (): OK

    401: Unauthorized

    list or watch objects of kind StorageClass

    HTTP Request

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

    Parameters

    • allowWatchBookmarks (in query): boolean

    • continue (in query): string

      continue

    • fieldSelector (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/storageclasses

    Parameters

    • body: , required

    • dryRun (in query): string

      dryRun

    • fieldManager (in query): string

    • fieldValidation (in query): string

      fieldValidation

    Response

    200 (StorageClass): OK

    201 (): Created

    202 (StorageClass): Accepted

    401: Unauthorized

    update replace the specified StorageClass

    HTTP Request

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

    Parameters

    • name (in path): string, required

      name of the StorageClass

    • body: StorageClass, required

    • dryRun (in query): string

    • fieldManager (in query): string

      fieldManager

    • fieldValidation (in query): string

    • pretty (in query): string

      pretty

    Response

    200 (StorageClass): OK

    201 (): Created

    401: Unauthorized

    HTTP Request

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

    Parameters

    • name (in path): string, required

      name of the StorageClass

    • body: , required

    • dryRun (in query): string

      dryRun

    • fieldValidation (in query): string

      fieldValidation

    • force (in query): boolean

    • pretty (in query): string

      pretty

    Response

    200 (StorageClass): OK

    201 (): Created

    401: Unauthorized

    delete delete a StorageClass

    HTTP Request

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

    Parameters

    • name (in path): string, required

      name of the StorageClass

    • body:

    • dryRun (in query): string

      dryRun

    • gracePeriodSeconds (in query): integer

    • pretty (in query): string

      pretty

    • propagationPolicy (in query): string

    Response

    200 (): OK

    202 (StorageClass): Accepted

    401: Unauthorized

    HTTP Request

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

    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

    • timeoutSeconds (in query): integer

      timeoutSeconds

    Response

    200 (Status): OK