docs: remove '-a' from 'helm get values' command in upgrade doc

Signed-off-by: Niladri Halder <[email protected]>
openebs · Apr 17, 2024 · 3183a3a · 3183a3a
1 parent 64e3fa1
commit 3183a3a
Show file tree

Hide file tree

Showing 2 changed files with 56 additions and 42 deletions.
diff --git a/docs/main/user-guides/upgrades.md b/docs/main/user-guides/upgrades.md
@@ -49,20 +49,30 @@ helm repo add openebs https://openebs.github.io/openebs
 helm repo update
 ```
 
-## Local Storage
-
-This section describes the Local Storage upgrade from OpenEBS chart 3.x to OpenEBS 4.0.0. The upgrade process for Local PV Hostpath, Local PV LVM and Local PV ZFS are largely identical, with a few changes in helm values depending on the Local PV Storage variant we are upgrading from.
+## Extract Helm Values
 
-1. Before upgrading to OpenEBS 4.0.0, write the existing helm values from your OpenEBS helm release to a local YAML file.
+Execute the following command to capture the helm values configuration of your helm release.
 
 ```
-helm get values openebs -n openebs -a -o yaml > old-values.yaml 
+helm get values openebs -n openebs -o yaml > old-values.yaml 
 ```
 
-2. Execute the 4.0.0 upgrade command. 
+:::note
+If you're using a custom helm chart to use OpenEBS, you'd want to compare your set of helm values against the new helm values and the values of the dependency helm charts, [here](https://github.com/openebs/openebs/blob/HEAD/charts/values.yaml).
+
+For some users who used helm v3.13 to install their chart, it might be advisable to use the `-a` option with their `helm get values` command. This might be especially useful if they have not used helm's `--set` and/or `-f` options to configure their chart values.
+
+Feel free to reach out via our communication channels.
+:::
+
+
+## Local Storage
+
+This section describes the Local Storage upgrade from OpenEBS chart 3.x to OpenEBS 4.0.0. The upgrade process for Local PV Hostpath, Local PV LVM and Local PV ZFS are largely identical, with a few changes in helm values depending on the Local PV Storage variant we are upgrading from.
+
+1. Execute the 4.0.0 upgrade command. 
 
 ```
-helm repo update
 helm upgrade openebs openebs/openebs -n openebs -f old-values.yaml --version 4.0.0
 ```
 
@@ -81,6 +91,8 @@ If the upgrade is from Local PV LVM or Local PV ZFS storage solution, additional
 ```
 --set zfs-localpv.crds.zfsLocalPv.enabled=false
 ```
+
+Add both of these options, if your chart has both of these enabled.
 :::
 
 3. Verify that the CRDs, Volumes, Snapshots and StoragePools are unaffected by the upgrade process.
@@ -89,28 +101,23 @@ If the upgrade is from Local PV LVM or Local PV ZFS storage solution, additional
 
 This section describes the Replicated Storage upgrade from OpenEBS Umbrella chart 3.x to OpenEBS 4.0.0.
 
-1. Before upgrading to OpenEBS 4.0.0, write the existing helm values from your OpenEBS helm release to a local YAML file.
-
-```
-helm get values openebs -n openebs -a -o yaml > old-values.yaml 
-```
-
-2. Start the helm upgrade process with the new chart, i.e. 4.0.0 by using the below command:
+1. Start the helm upgrade process with the new chart, i.e. 4.0.0 by using the below command:
 
 :::caution
 Disable the partial rebuild during the upgrade from specific versions of OpenEBS (3.7.0, 3.8.0, 3.9.0 and 3.10.0) to OpenEBS 4.0.0 to ensure data consistency during upgrade. Input the value `--set mayastor.agents.core.rebuild.partial.enabled=false` in the **helm upgrade** command.
-This applies to the **kubectl mayastor upgrade** command as well `kubectl mayastor upgrade --set agents.core.rebuild.partial.enabled=false`.
+
+This applies to the **kubectl mayastor upgrade** command as well, if you're using the `mayastor/mayastor` chart and not the `openebs/openebs` chart: `kubectl mayastor upgrade --set agents.core.rebuild.partial.enabled=false`
 :::
 
 ```
 helm upgrade openebs openebs/openebs -n openebs -f old-values.yaml --version 4.0.0 \
-  --set mayastor.crds.enabled=false \
-  --set mayastor.agents.core.rebuild.partial.enabled=false
+  --set mayastor.agents.core.rebuild.partial.enabled=false \
+  --set openebs-crds.csi.volumeSnapshots.enabled=false
 ```
 
-3. Verify that the CRDs, Volumes, Snapshots and StoragePools are unaffected by the upgrade process.
+2. Verify that the CRDs, Volumes, Snapshots and StoragePools are unaffected by the upgrade process.
 
-4. Start the Replicated Storage upgrade process by using the kubectl mayastor plugin v2.6.0.
+3. Start the Replicated Storage upgrade process by using the kubectl mayastor plugin v2.6.0.
 
 ```
 kubectl mayastor upgrade -n openebs --set 'mayastor.agents.core.rebuild.partial.enabled=false'
@@ -133,9 +140,9 @@ kubectl get pods -n openebs
 openebs-upgrade-v2-6-0-s58xl                   0/1     Completed   0          7m4s
 ```
 
-5. Once the upgrade process completes, all the volumes and pools should be online.
+4. Once the upgrade process completes, all the volumes and pools should be online.
 
-6. If you have disabled the partial rebuild during the upgrade, re-enable it by adding the value `--set mayastor.agents.core.rebuild.partial.enabled=true` in the upgrade command.
+5. If you have disabled the partial rebuild during the upgrade, re-enable it by adding the value `--set mayastor.agents.core.rebuild.partial.enabled=true` in the upgrade command.
 
 ```
 helm upgrade openebs openebs/openebs -n openebs --reuse-values --version 4.0.0 \

diff --git a/docs/versioned_docs/version-4.0.x/user-guides/upgrades.md b/docs/versioned_docs/version-4.0.x/user-guides/upgrades.md
@@ -49,20 +49,30 @@ helm repo add openebs https://openebs.github.io/openebs
 helm repo update
 ```
 
-## Local Storage
-
-This section describes the Local Storage upgrade from OpenEBS chart 3.x to OpenEBS 4.0.0. The upgrade process for Local PV Hostpath, Local PV LVM and Local PV ZFS are largely identical, with a few changes in helm values depending on the Local PV Storage variant we are upgrading from.
+## Extract Helm Values
 
-1. Before upgrading to OpenEBS 4.0.0, write the existing helm values from your OpenEBS helm release to a local YAML file.
+Execute the following command to capture the helm values configuration of your helm release.
 
 ```
-helm get values openebs -n openebs -a -o yaml > old-values.yaml 
+helm get values openebs -n openebs -o yaml > old-values.yaml 
 ```
 
-2. Execute the 4.0.0 upgrade command. 
+:::note
+If you're using a custom helm chart to use OpenEBS, you'd want to compare your set of helm values against the new helm values and the values of the dependency helm charts, [here](https://github.com/openebs/openebs/blob/HEAD/charts/values.yaml).
+
+For some users who used helm v3.13 to install their chart, it might be advisable to use the `-a` option with their `helm get values` command. This might be especially useful if they have not used helm's `--set` and/or `-f` options to configure their chart values.
+
+Feel free to reach out via our communication channels.
+:::
+
+
+## Local Storage
+
+This section describes the Local Storage upgrade from OpenEBS chart 3.x to OpenEBS 4.0.0. The upgrade process for Local PV Hostpath, Local PV LVM and Local PV ZFS are largely identical, with a few changes in helm values depending on the Local PV Storage variant we are upgrading from.
+
+1. Execute the 4.0.0 upgrade command. 
 
 ```
-helm repo update
 helm upgrade openebs openebs/openebs -n openebs -f old-values.yaml --version 4.0.0
 ```
 
@@ -81,6 +91,8 @@ If the upgrade is from Local PV LVM or Local PV ZFS storage solution, additional
 ```
 --set zfs-localpv.crds.zfsLocalPv.enabled=false
 ```
+
+Add both of these options, if your chart has both of these enabled.
 :::
 
 3. Verify that the CRDs, Volumes, Snapshots and StoragePools are unaffected by the upgrade process.
@@ -89,28 +101,23 @@ If the upgrade is from Local PV LVM or Local PV ZFS storage solution, additional
 
 This section describes the Replicated Storage upgrade from OpenEBS Umbrella chart 3.x to OpenEBS 4.0.0.
 
-1. Before upgrading to OpenEBS 4.0.0, write the existing helm values from your OpenEBS helm release to a local YAML file.
-
-```
-helm get values openebs -n openebs -a -o yaml > old-values.yaml 
-```
-
-2. Start the helm upgrade process with the new chart, i.e. 4.0.0 by using the below command:
+1. Start the helm upgrade process with the new chart, i.e. 4.0.0 by using the below command:
 
 :::caution
 Disable the partial rebuild during the upgrade from specific versions of OpenEBS (3.7.0, 3.8.0, 3.9.0 and 3.10.0) to OpenEBS 4.0.0 to ensure data consistency during upgrade. Input the value `--set mayastor.agents.core.rebuild.partial.enabled=false` in the **helm upgrade** command.
-This applies to the **kubectl mayastor upgrade** command as well `kubectl mayastor upgrade --set agents.core.rebuild.partial.enabled=false`.
+
+This applies to the **kubectl mayastor upgrade** command as well, if you're using the `mayastor/mayastor` chart and not the `openebs/openebs` chart: `kubectl mayastor upgrade --set agents.core.rebuild.partial.enabled=false`
 :::
 
 ```
 helm upgrade openebs openebs/openebs -n openebs -f old-values.yaml --version 4.0.0 \
-  --set mayastor.crds.enabled=false \
-  --set mayastor.agents.core.rebuild.partial.enabled=false
+  --set mayastor.agents.core.rebuild.partial.enabled=false \
+  --set openebs-crds.csi.volumeSnapshots.enabled=false
 ```
 
-3. Verify that the CRDs, Volumes, Snapshots and StoragePools are unaffected by the upgrade process.
+2. Verify that the CRDs, Volumes, Snapshots and StoragePools are unaffected by the upgrade process.
 
-4. Start the Replicated Storage upgrade process by using the kubectl mayastor plugin v2.6.0.
+3. Start the Replicated Storage upgrade process by using the kubectl mayastor plugin v2.6.0.
 
 ```
 kubectl mayastor upgrade -n openebs --set 'mayastor.agents.core.rebuild.partial.enabled=false'
@@ -133,9 +140,9 @@ kubectl get pods -n openebs
 openebs-upgrade-v2-6-0-s58xl                   0/1     Completed   0          7m4s
 ```
 
-5. Once the upgrade process completes, all the volumes and pools should be online.
+4. Once the upgrade process completes, all the volumes and pools should be online.
 
-6. If you have disabled the partial rebuild during the upgrade, re-enable it by adding the value `--set mayastor.agents.core.rebuild.partial.enabled=true` in the upgrade command.
+5. If you have disabled the partial rebuild during the upgrade, re-enable it by adding the value `--set mayastor.agents.core.rebuild.partial.enabled=true` in the upgrade command.
 
 ```
 helm upgrade openebs openebs/openebs -n openebs --reuse-values --version 4.0.0 \