change openebs localpv storageclass name to 'local' from 'default'

also clarify docs on when openebs will be the default storageclass
replicatedhq · Feb 22, 2023 · b1da863 · b1da863
1 parent 69846a1
commit b1da863
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 19 deletions.
diff --git a/src/markdown-pages/add-ons/kotsadm.md b/src/markdown-pages/add-ons/kotsadm.md
@@ -83,7 +83,7 @@ spec:
   openebs:
     version: latest
     isLocalPVEnabled: true
-    localPVStorageClassName: default
+    localPVStorageClassName: local
   minio:
     version: latest
   registry:
@@ -107,7 +107,7 @@ spec:
   openebs:
     version: latest
     isLocalPVEnabled: true
-    localPVStorageClassName: default
+    localPVStorageClassName: local
   registry:
     version: latest
   kotsadm:

diff --git a/src/markdown-pages/add-ons/openebs.md b/src/markdown-pages/add-ons/openebs.md
@@ -17,7 +17,7 @@ spec:
     version: latest
     namespace: openebs
     isLocalPVEnabled: true
-    localPVStorageClassName: openebs
+    localPVStorageClassName: local
 ```
 
 flags-table
@@ -34,17 +34,11 @@ Additionally, Local Volumes are typically preferred for workloads like Cassandra
 
 ### Storage Class
 
-The OpenEBS Storage Class can be set as the default by setting the `openebs.localPVStorageClassName` property to `"default"` or when no other storage provisioner add-on is included in the spec.
+The OpenEBS Storage Class will be set as the default if:
 
-In this example, the Local PV provisioner would be used as the default provisioner for any Persistent Volume Claims that do not explicitly specify a `storageClassName`.
-
-```yaml
-spec:
-  openebs:
-    version: latest
-    isLocalPVEnabled: true
-    localPVStorageClassName: default
-```
+1. Rook is not included in the spec.
+2. There is no existing default Storage Class in the cluster.
+3. Longhorn is not included in the spec OR the `openebs.localPVStorageClassName` property is set to `"default"`.
 
 ### Limitations
 

diff --git a/src/markdown-pages/create-installer/choosing-a-pv-provisioner.md b/src/markdown-pages/create-installer/choosing-a-pv-provisioner.md
@@ -26,7 +26,7 @@ spec:
   openebs:
     version: "3.3.x"
     isLocalPVEnabled: true
-    localPVStorageClassName: "default"
+    localPVStorageClassName: "local"
 ```
 
 Conversely, [Rook](/docs/add-ons/rook) provides dynamic PV provisioning of distributed [Ceph](https://ceph.io/) storage.
@@ -62,7 +62,7 @@ spec:
   openebs:
     version: "3.3.x"
     isLocalPVEnabled: true
-    localPVStorageClassName: "default"
+    localPVStorageClassName: "local"
   minio:
     version: "2022-09-07T22-25-02Z"
 ```

diff --git a/src/markdown-pages/install-with-kurl/migrating.md b/src/markdown-pages/install-with-kurl/migrating.md
@@ -85,7 +85,7 @@ spec:
   openebs:
     version: 3.3.0
     isLocalPVEnabled: true
-    localPVStorageClassName: default
+    localPVStorageClassName: local
   registry:
     version: 2.8.1
   kotsadm:

diff --git a/src/markdown-pages/install-with-kurl/removing-object-storage.md b/src/markdown-pages/install-with-kurl/removing-object-storage.md
@@ -32,7 +32,7 @@ spec:
   openebs:
     version: 3.3.x
     isLocalPVEnabled: true
-    localPVStorageClassName: default
+    localPVStorageClassName: local
   registry:
     version: 2.8.x
   velero:

diff --git a/src/utils/__tests__/kurl-yaml.js b/src/utils/__tests__/kurl-yaml.js
@@ -27,7 +27,7 @@ spec:
   openebs:
     version: 3.3.x
     isLocalPVEnabled: true
-    localPVStorageClassName: default
+    localPVStorageClassName: local
 `;
         const expected = `apiVersion: cluster.kurl.sh/v1beta1
 kind: Installer
@@ -62,7 +62,7 @@ spec:
   openebs:
     version: 3.3.x
     isLocalPVEnabled: true
-    localPVStorageClassName: default
+    localPVStorageClassName: local
 `;
     const actual = injectYamlOpenebsComment(yaml);
     expect(actual).to.equal(expected);