From 59717874c0fd56716f5c5c76c1d7934ebd173684 Mon Sep 17 00:00:00 2001 From: Felix Hennig Date: Mon, 21 Aug 2023 15:47:20 +0200 Subject: [PATCH 1/6] draft --- modules/concepts/pages/resources.adoc | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/modules/concepts/pages/resources.adoc b/modules/concepts/pages/resources.adoc index 380fb4b45..7aa62eae1 100644 --- a/modules/concepts/pages/resources.adoc +++ b/modules/concepts/pages/resources.adoc @@ -98,3 +98,18 @@ 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. + +==== Storage class + +A Kubernetes cluster is configured with a https://kubernetes.io/docs/concepts/storage/storage-classes/#default-storageclass[default StorageClass], which gets used if no other StorageClass is specified. The storage configuration also supports configuring a non-default StorageClass: + +[source,yaml] +---- +... + resources: + storage: + data: # name of the storage + capacity: 4Gi + storageClass: my-storage-class +... +---- From ec6d24cd3875963dbd6cab6fd77b2ce0b8dbaccf Mon Sep 17 00:00:00 2001 From: Felix Hennig Date: Mon, 21 Aug 2023 15:55:12 +0200 Subject: [PATCH 2/6] removed whitespace --- modules/concepts/pages/resources.adoc | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/modules/concepts/pages/resources.adoc b/modules/concepts/pages/resources.adoc index 7aa62eae1..edaf4d301 100644 --- a/modules/concepts/pages/resources.adoc +++ b/modules/concepts/pages/resources.adoc @@ -106,10 +106,9 @@ A Kubernetes cluster is configured with a https://kubernetes.io/docs/concepts/st [source,yaml] ---- ... - resources: - storage: - data: # name of the storage - capacity: 4Gi - storageClass: my-storage-class -... +resources: + storage: + data: # name of the storage + capacity: 4Gi + storageClass: my-storage-class ---- From 5715f279671ef41d4da04f478b4d1f97e44489bf Mon Sep 17 00:00:00 2001 From: Felix Hennig Date: Tue, 22 Aug 2023 13:05:23 +0200 Subject: [PATCH 3/6] More description --- modules/concepts/pages/resources.adoc | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/modules/concepts/pages/resources.adoc b/modules/concepts/pages/resources.adoc index edaf4d301..9c7b2d19e 100644 --- a/modules/concepts/pages/resources.adoc +++ b/modules/concepts/pages/resources.adoc @@ -99,7 +99,12 @@ The role group `resources-from-role-group` has maximum of `4Gi` storage space fo IMPORTANT: Stackable operators use different names (`data` in this example) for their storage specification. This is documented in the operator specific documentation. -==== Storage class +[#storageclass] +==== StorageClass + +From the https://kubernetes.io/docs/concepts/storage/storage-classes/[Kubernetes documentation]: + +> A StorageClass provides a way for administrators to describe the "classes" of storage they offer. Different classes might map to quality-of-service levels, or to backup policies, or to arbitrary policies determined by the cluster administrators. A Kubernetes cluster is configured with a https://kubernetes.io/docs/concepts/storage/storage-classes/#default-storageclass[default StorageClass], which gets used if no other StorageClass is specified. The storage configuration also supports configuring a non-default StorageClass: From affbcdcdb95a09e05f99c1bbdaa3550b7812473c Mon Sep 17 00:00:00 2001 From: Felix Hennig Date: Tue, 22 Aug 2023 13:20:09 +0200 Subject: [PATCH 4/6] More description --- modules/concepts/pages/resources.adoc | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/modules/concepts/pages/resources.adoc b/modules/concepts/pages/resources.adoc index 9c7b2d19e..d17522d83 100644 --- a/modules/concepts/pages/resources.adoc +++ b/modules/concepts/pages/resources.adoc @@ -102,11 +102,11 @@ IMPORTANT: Stackable operators use different names (`data` in this example) for [#storageclass] ==== StorageClass -From the https://kubernetes.io/docs/concepts/storage/storage-classes/[Kubernetes documentation]: +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, based on the underlying storage technology (SSD, HDD, NAS) or by adjusing Kubernetes settings for different classes (Find more information in the https://kubernetes.io/docs/concepts/storage/storage-classes/[Kubernetes documentation]). -> A StorageClass provides a way for administrators to describe the "classes" of storage they offer. Different classes might map to quality-of-service levels, or to backup policies, or to arbitrary policies determined by the cluster administrators. - -A Kubernetes cluster is configured with a https://kubernetes.io/docs/concepts/storage/storage-classes/#default-storageclass[default StorageClass], which gets used if no other StorageClass is specified. The storage configuration also supports configuring a non-default StorageClass: +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] ---- From c49f4b1a6d3a9b7c58288f27d11d0a1c459c0191 Mon Sep 17 00:00:00 2001 From: Felix Hennig Date: Tue, 22 Aug 2023 13:23:52 +0200 Subject: [PATCH 5/6] typos --- modules/concepts/pages/resources.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/concepts/pages/resources.adoc b/modules/concepts/pages/resources.adoc index d17522d83..982df654a 100644 --- a/modules/concepts/pages/resources.adoc +++ b/modules/concepts/pages/resources.adoc @@ -104,9 +104,9 @@ IMPORTANT: Stackable operators use different names (`data` in this example) for 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, based on the underlying storage technology (SSD, HDD, NAS) or by adjusing Kubernetes settings for different classes (Find more information in the https://kubernetes.io/docs/concepts/storage/storage-classes/[Kubernetes documentation]). +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, based on the underlying storage technology (SSD, HDD, NAS) or by adjusing Kubernetes settings for different classes (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: +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] ---- From 4caaceddc20cd561be4ee38aa463bd7e7b2ab12c Mon Sep 17 00:00:00 2001 From: Felix Hennig Date: Tue, 22 Aug 2023 14:55:53 +0200 Subject: [PATCH 6/6] changed some formulation --- modules/concepts/pages/resources.adoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/modules/concepts/pages/resources.adoc b/modules/concepts/pages/resources.adoc index 982df654a..20457f100 100644 --- a/modules/concepts/pages/resources.adoc +++ b/modules/concepts/pages/resources.adoc @@ -104,7 +104,8 @@ IMPORTANT: Stackable operators use different names (`data` in this example) for 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, based on the underlying storage technology (SSD, HDD, NAS) or by adjusing Kubernetes settings for different classes (find more information in the https://kubernetes.io/docs/concepts/storage/storage-classes/[Kubernetes documentation]). +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: