This is a cache of https://docs.openshift.com/container-platform/4.15/rest_api/storage_apis/storageclass-storage-k8s-io-v1.html. It is a snapshot of the page at 2024-11-29T13:59:07.967+0000.
Storag<strong>e</strong>Class [storag<strong>e</strong>.k8s.io/v1] - Storag<strong>e</strong> APIs | API r<strong>e</strong>f<strong>e</strong>r<strong>e</strong>nc<strong>e</strong> | Op<strong>e</strong>nShift Contain<strong>e</strong>r Platform 4.15
    OpenShift docs are moving and will soon only be available at docs.redhat.com, the home of all Red Hat product documentation. explore the new docs experience today.
  1. Documentation
    2. history bug_report picture_as_pdf
&times;

StorageClass [storage.k8s.io/v1]

Description

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.

Type

object

Required

  • provisioner

Specification

Property Type Description

allowVolumeexpansion

boolean

allowVolumeexpansion shows whether the storage class allow volume expand.

allowedTopologies

array (TopologySelectorTerm)

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.

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

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

mountOptions

array (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

object (string)

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

provisioner

string

provisioner indicates the type of the provisioner.

reclaimPolicy

string

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

Possible enum values: - "Delete" means the volume will be deleted from Kubernetes on release from its claim. The volume plugin must support Deletion. - "Recycle" means the volume will be recycled back into the pool of unbound persistent volumes on release from its claim. The volume plugin must support Recycling. - "Retain" means the volume will be left in its current phase (Released) for manual reclamation by the administrator. The default policy is Retain.

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.

Possible enum values: - "Immediate" indicates that PersistentVolumeClaims should be immediately provisioned and bound. This is the default mode. - "WaitForFirstConsumer" indicates that PersistentVolumeClaims should not be provisioned and bound until the first Pod is created that references the PeristentVolumeClaim. The volume provisioning and binding will occur during Pod scheduing.

API endpoints

The following API endpoints are available:

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

    • DeLeTe: delete collection of StorageClass

    • GeT: list or watch objects of kind StorageClass

    • POST: create a StorageClass

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

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

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

    • DeLeTe: delete a StorageClass

    • GeT: read the specified StorageClass

    • PATCH: partially update the specified StorageClass

    • PUT: replace the specified StorageClass

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

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

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

HTTP method

DeLeTe

Description

delete collection of StorageClass

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 StorageClass

Table 3. HTTP responses
HTTP code Reponse body

200 - OK

StorageClassList schema

401 - Unauthorized

empty
HTTP method

POST

Description

create a StorageClass

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

StorageClass schema
Table 6. HTTP responses
HTTP code Reponse body

200 - OK

StorageClass schema

201 - Created

StorageClass schema

202 - Accepted

StorageClass schema

401 - Unauthorized

empty

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

HTTP method

GeT

Description

watch individual changes to a list of StorageClass. 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/storageclasses/{name}

Table 8. Global path parameters
Parameter Type Description

name

string

name of the StorageClass
HTTP method

DeLeTe

Description

delete a StorageClass

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

StorageClass schema

202 - Accepted

StorageClass schema

401 - Unauthorized

empty
HTTP method

GeT

Description

read the specified StorageClass

Table 11. HTTP responses
HTTP code Reponse body

200 - OK

StorageClass schema

401 - Unauthorized

empty
HTTP method

PATCH

Description

partially update the specified StorageClass

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

StorageClass schema

201 - Created

StorageClass schema

401 - Unauthorized

empty
HTTP method

PUT

Description

replace the specified StorageClass

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

StorageClass schema
Table 16. HTTP responses
HTTP code Reponse body

200 - OK

StorageClass schema

201 - Created

StorageClass schema

401 - Unauthorized

empty

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

Table 17. Global path parameters
Parameter Type Description

name

string

name of the StorageClass
HTTP method

GeT

Description

watch changes to an object of kind StorageClass. 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