Skip to content

Commit 86eba98

Browse files
committed
docs: modified the docs
Signed-off-by: Bala Harish <[email protected]>
1 parent c196c0e commit 86eba98

File tree

1 file changed

+55
-48
lines changed

1 file changed

+55
-48
lines changed

docs/main/user-guides/upgrades.md

Lines changed: 55 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -65,35 +65,26 @@ If you have used helm v3.13 or above to install their chart, and not used helm's
6565
Feel free to reach out via our [communication channels](../community.md).
6666
:::
6767

68-
6968
## Local Storage Upgrade
7069

7170
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.
7271

73-
### From 4.x to 4.1.1 or Higher
74-
75-
This section describes the Local Storage upgrade from OpenEBS chart 4.x to OpenEBS 4.1.1 or higher.
76-
77-
1. Execute the 4.1.1 upgrade command.
78-
79-
```
80-
helm upgrade openebs openebs/openebs -n openebs -f old-values.yaml --version 4.1.1
81-
```
82-
83-
2. Verify that the CRDs, Volumes, Snapshots, and StoragePools are not affected by the upgrade process.
72+
:::note
73+
Downgrades are not supported.
74+
:::
8475

85-
### From 3.x to 4.1.1
76+
### From 3.x to 4.2
8677

87-
This section describes the Local Storage upgrade from OpenEBS chart 3.x to OpenEBS 4.1.1.
78+
This section describes the Local Storage upgrade from OpenEBS chart 3.x to OpenEBS 4.2.
8879

89-
1. Execute the 4.1.1 upgrade command.
80+
1. Execute the 4.2 upgrade command.
9081

9182
```
92-
helm upgrade openebs openebs/openebs -n openebs -f old-values.yaml --version 4.1.1
83+
helm upgrade openebs openebs/openebs -n openebs -f old-values.yaml --version 4.2
9384
```
9485

9586
:::note
96-
If upgrading from Local PV LVM or Local PV ZFS storage solution, additional helm values must be specified with the above command to prevent upgrade process conflicts. The installed CRDs in 3.x would conflict with the CRDs in 4.1.1 as the chart structure has changed. Hence, they must be disabled.
87+
If upgrading from Local PV LVM or Local PV ZFS storage solution, additional helm values must be specified with the above command to prevent upgrade process conflicts. The installed CRDs in 3.x would conflict with the CRDs in 4.2 as the chart structure has changed. Hence, they must be disabled.
9788

9889
- For Upgrade from Local PV LVM, use
9990

@@ -112,24 +103,53 @@ Add both of these options, if your chart has both of these enabled.
112103

113104
2. Verify that the CRDs, Volumes, Snapshots, and StoragePools are not affected by the upgrade process.
114105

106+
### From 4.x to 4.2
107+
108+
This section describes the Local Storage upgrade from OpenEBS chart 4.x to OpenEBS 4.2.
109+
110+
1. Execute the 4.2 upgrade command.
111+
112+
```
113+
helm upgrade openebs openebs/openebs -n openebs -f old-values.yaml --version 4.2
114+
```
115+
116+
2. Verify that the CRDs, Volumes, Snapshots, and StoragePools are not affected by the upgrade process.
117+
115118
## Replicated Storage Upgrade
116119

117-
### From 4.x to 4.1.1 or Higher
120+
:::note
121+
Downgrades are not supported.
122+
:::
123+
124+
### From 3.x to 4.2
125+
126+
This section describes the Replicated Storage upgrade from OpenEBS Umbrella chart 3.x to OpenEBS 4.2.
118127

119-
This section describes the Replicated Storage upgrade from OpenEBS Umbrella chart 4.x to OpenEBS 4.1.1 or higher.
128+
1. Start the helm upgrade process with the new chart, i.e. 4.2 by using the below command:
129+
130+
:::caution
131+
Upgrades from 3.x to 4.x require the option `--set mayastor.agents.core.rebuild.partial.enabled=false` in the **helm upgrade** command to ensure data consistency during the upgrade. Upgrades from 4.x onwards to newer versions do not require it.
120132

121-
1. Start the helm upgrade process with the new chart, i.e. 4.1.1 by using the below command:
133+
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`
134+
:::
122135

123136
```
124-
helm upgrade openebs openebs/openebs -n openebs -f old-values.yaml --version 4.1.1
137+
# Add the option --set mayastor.agents.core.rebuild.partial.enabled=false if
138+
# the source version is a 3.x release.
139+
helm upgrade openebs openebs/openebs -n openebs -f old-values.yaml --version 4.2 \
140+
--set openebs-crds.csi.volumeSnapshots.enabled=false
125141
```
126142

127-
2. Verify that the CRDs, Volumes, Snapshots and StoragePools are unaffected by the upgrade process.
143+
:::important
144+
The `--reuse-values` option should not be used with `helm upgrade`, as it may cause the pre-upgrade images to be used instead of the new images. Instead the `--reset-then-reuse-values` option is recommended.
145+
:::
146+
147+
2. Verify that the CRDs, Volumes, Snapshots, and StoragePools are not affected by the upgrade process.
128148

129149
3. Start the Replicated Storage upgrade process by using the kubectl mayastor plugin v2.7.1.
130150

131151
```
132-
kubectl mayastor upgrade -n openebs
152+
kubectl mayastor upgrade -n openebs --set 'mayastor.agents.core.rebuild.partial.enabled=false'
133153
```
134154

135155
- This deploys an upgrade process of K8s resource type Job.
@@ -151,35 +171,29 @@ openebs-upgrade-v2-7-1-s58xl 0/1 Completed 0 7m
151171

152172
4. Once the upgrade process is completed, all the volumes and pools should be online.
153173

154-
### From 3.x to 4.1.1
174+
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.
155175

156-
This section describes the Replicated Storage upgrade from OpenEBS Umbrella chart 3.x to OpenEBS 4.1.1.
176+
```
177+
helm upgrade openebs openebs/openebs -n openebs --reuse-values --version 4.2 \
178+
--set mayastor.agents.core.rebuild.partial.enabled=true
179+
```
157180

158-
1. Start the helm upgrade process with the new chart, i.e. 4.1.1 by using the below command:
181+
### From 4.x to 4.2
159182

160-
:::caution
161-
Upgrades from 3.x to 4.x require the option `--set mayastor.agents.core.rebuild.partial.enabled=false` in the **helm upgrade** command to ensure data consistency during the upgrade. Upgrades from 4.x onwards to newer versions do not require it.
183+
This section describes the Replicated Storage upgrade from OpenEBS Umbrella chart 4.x to OpenEBS 4.2.
162184

163-
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`
164-
:::
185+
1. Start the helm upgrade process with the new chart, i.e. 4.2 by using the below command:
165186

166187
```
167-
# Add the option --set mayastor.agents.core.rebuild.partial.enabled=false if
168-
# the source version is a 3.x release.
169-
helm upgrade openebs openebs/openebs -n openebs -f old-values.yaml --version 4.1.1 \
170-
--set openebs-crds.csi.volumeSnapshots.enabled=false
188+
helm upgrade openebs openebs/openebs -n openebs -f old-values.yaml --version 4.2
171189
```
172190

173-
:::important
174-
The `--reuse-values` option should not be used with `helm upgrade`, as it may cause the pre-upgrade images to be used instead of the new images. Instead the `--reset-then-reuse-values` option is recommended.
175-
:::
176-
177-
2. Verify that the CRDs, Volumes, Snapshots, and StoragePools are not affected by the upgrade process.
191+
2. Verify that the CRDs, Volumes, Snapshots and StoragePools are unaffected by the upgrade process.
178192

179193
3. Start the Replicated Storage upgrade process by using the kubectl mayastor plugin v2.7.1.
180194

181195
```
182-
kubectl mayastor upgrade -n openebs --set 'mayastor.agents.core.rebuild.partial.enabled=false'
196+
kubectl mayastor upgrade -n openebs
183197
```
184198

185199
- This deploys an upgrade process of K8s resource type Job.
@@ -201,15 +215,8 @@ openebs-upgrade-v2-7-1-s58xl 0/1 Completed 0 7m
201215

202216
4. Once the upgrade process is completed, all the volumes and pools should be online.
203217

204-
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.
205-
206-
```
207-
helm upgrade openebs openebs/openebs -n openebs --reuse-values --version 4.1.1 \
208-
--set mayastor.agents.core.rebuild.partial.enabled=true
209-
```
210-
211218
## See Also
212219

213220
- [Release Notes](../releases.md)
214221
- [Troubleshooting](../troubleshooting/troubleshooting-local-storage.md)
215-
- [Join our Community](../community.md)
222+
- [Join our Community](../community.md)

0 commit comments

Comments
 (0)