Skip to content

Commit 5c93fee

Browse files
authored
Document StorageClass override (#441)
* draft * removed whitespace * More description * More description * typos * changed some formulation
1 parent 442947a commit 5c93fee

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

modules/concepts/pages/resources.adoc

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,3 +98,23 @@ In this case, the role group `resources-from-role` will inherit the resources sp
9898
The role group `resources-from-role-group` has maximum of `4Gi` storage space for `data` (which overrides the role resources).
9999

100100
IMPORTANT: Stackable operators use different names (`data` in this example) for their storage specification. This is documented in the operator specific documentation.
101+
102+
[#storageclass]
103+
==== StorageClass
104+
105+
A StorageClass defines a type of storage with certain properties.
106+
The StorageClasses that are available on a Kubernetes cluster are configured by the cluster administrator.
107+
Different classes can be configured to provide different levels of reliability or speed, or be configured to be more suited for read or write heavy loads.
108+
This configuration is either done in the storage backend or Kubernetes settings (find more information in the https://kubernetes.io/docs/concepts/storage/storage-classes/[Kubernetes documentation]).
109+
110+
For Stackable resources, setting a StorageClass is not mandatory; if not StorageClass is set, the https://kubernetes.io/docs/concepts/storage/storage-classes/#default-storageclass[default StorageClass] will be used. If you want to use a specific StorageClass for a particular storage, the StorageClass can be set on the resource:
111+
112+
[source,yaml]
113+
----
114+
...
115+
resources:
116+
storage:
117+
data: # name of the storage
118+
capacity: 4Gi
119+
storageClass: my-storage-class
120+
----

0 commit comments

Comments
 (0)