1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-06 15:46:57 +01:00
Files
openshift-docs/modules/dynamic-provisioning-annotations.adoc
2019-05-13 13:57:48 +10:00

57 lines
1.2 KiB
Plaintext

// Module included in the following assemblies
//
// * storage/dynamic-provisioning.adoc
[id="storage-class-annotations_{context}"]
= StorageClass annotations
To set a StorageClass as the cluster-wide default, add
the following annotation to your StorageClass's metadata:
[source.yaml]
----
storageclass.kubernetes.io/is-default-class: "true"
----
For example:
[source.yaml]
----
apiVersion: storage.k8s.io/v1
kind: StorageClass
metadata:
annotations:
storageclass.kubernetes.io/is-default-class: "true"
...
----
This enables any Persistent Volume Claim (PVC) that does not specify a
specific volume to automatically be provisioned through the
default StorageClass.
[NOTE]
====
The beta annotation `storageclass.beta.kubernetes.io/is-default-class` is
still working; however, it will be removed in a future release.
====
To set a StorageClass description, add the following annotation
to your StorageClass's metadata:
[source.yaml]
----
kubernetes.io/description: My StorageClass Description
----
For example:
[source.yaml]
----
apiVersion: storage.k8s.io/v1
kind: StorageClass
metadata:
annotations:
kubernetes.io/description: My StorageClass Description
...
----