Skip to content

Document StorageClass override #441

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Aug 22, 2023
Merged

Document StorageClass override #441

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5971787
draft
fhennig Aug 21, 2023
ec6d24c
removed whitespace
fhennig Aug 21, 2023
5715f27
More description
fhennig Aug 22, 2023
affbcdc
More description
fhennig Aug 22, 2023
c49f4b1
typos
fhennig Aug 22, 2023
4caaced
changed some formulation
fhennig Aug 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions modules/concepts/pages/resources.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,3 +98,23 @@ In this case, the role group `resources-from-role` will inherit the resources sp
The role group `resources-from-role-group` has maximum of `4Gi` storage space for `data` (which overrides the role resources).

IMPORTANT: Stackable operators use different names (`data` in this example) for their storage specification. This is documented in the operator specific documentation.

[#storageclass]
==== StorageClass

A StorageClass defines a type of storage with certain properties.
The StorageClasses that are available on a Kubernetes cluster are configured by the cluster administrator.
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.
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]).

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:

[source,yaml]
----
...
resources:
storage:
data: # name of the storage
capacity: 4Gi
storageClass: my-storage-class
----