Skip to content

Commit ddbe897

Browse files
balaharish7balaharish7
committed
docs: unified upgrade
Signed-off-by: Bala Harish <[email protected]>
1 parent 45c9a27 commit ddbe897

File tree

3 files changed

+34
-149
lines changed

3 files changed

+34
-149
lines changed

‎docs/main/user-guides/upgrades.md‎

Lines changed: 32 additions & 147 deletions
Original file line numberDiff line numberDiff line change
@@ -29,189 +29,74 @@ This upgrade process allows you to upgrade to the latest OpenEBS version 4.2 whi
2929
and one Replicated Storage (a.k.a Replicated Engine):
3030
- Replicated PV Mayastor
3131

32-
As a part of the upgrade to OpenEBS 4.2, the helm chart will install all four engines irrespective of the engine you used before the upgrade.
32+
As a part of the upgrade to OpenEBS 4.2, the Helm chart will install all four engines regardless of the engine you used before the upgrade.
3333

3434
:::info
35-
During the upgrade, if you are only interested in Local PV Storage, you can disable Replicated PV Mayastor by setting the below option:
35+
During the upgrade, if you are only interested in Local PV Storage, you can disable Replicated PV Mayastor by using the below option:
3636

3737
```
3838
--set engines.replicated.mayastor.enabled=false
3939
```
4040
:::
4141

42-
## Update Helm Repository
43-
44-
The OpenEBS helm chart repository is available from a different URL than before. The repository target URL needs to be updated.
45-
46-
```
47-
helm repo remove openebs
48-
helm repo add openebs https://openebs.github.io/openebs
49-
helm repo update
50-
```
51-
52-
## Extract Helm Values
53-
54-
Execute the following command to capture the helm values configuration of your helm release.
55-
56-
```
57-
helm get values openebs -n openebs -o yaml > old-values.yaml
58-
```
59-
60-
:::note
61-
If you are using a custom helm chart to use OpenEBS, compare your set of helm values against the new helm values and the values of the dependency helm charts. Refer [values.yaml](https://github.com/openebs/openebs/blob/HEAD/charts/values.yaml) for more details.
62-
63-
If you have used helm v3.13 or above to install their chart, and not used helm's `--set` and/or `-f` options to configure their chart values, using the `-a` option with your `helm get values` command will let you capture your configuration values.
64-
65-
Feel free to reach out via our [communication channels](../community.md).
66-
:::
67-
68-
## Local Storage Upgrade
69-
70-
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.
71-
7242
:::note
7343
Downgrades are not supported.
7444
:::
7545

76-
### From 3.x to 4.2
77-
78-
This section describes the Local Storage upgrade from OpenEBS chart 3.x to OpenEBS 4.2.
79-
80-
1. Execute the 4.2 upgrade command.
81-
82-
```
83-
helm upgrade openebs openebs/openebs -n openebs -f old-values.yaml --version 4.2
84-
```
85-
86-
:::note
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.
88-
89-
- For Upgrade from Local PV LVM, use
90-
91-
```
92-
--set lvm-localpv.crds.lvmLocalPv.enabled=false,openebs-crds.csi.volumeSnapshots.enabled=false
93-
```
94-
95-
- For Upgrade from Local PV ZFS, use
96-
97-
```
98-
--set zfs-localpv.crds.zfsLocalPv.enabled=false,openebs-crds.csi.volumeSnapshots.enabled=false
99-
```
100-
101-
Add both of these options, if your chart has both of these enabled.
102-
:::
103-
104-
2. Verify that the CRDs, Volumes, Snapshots, and StoragePools are not affected by the upgrade process.
46+
## Upgrade from 3.x to 4.2
10547

106-
### From 4.x to 4.2
48+
Follow these steps to upgrade OpenEBS from version 3.x to 4.2:
10749

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.
50+
1. Update the helm repository: The OpenEBS Helm chart repository URL has changed. The repository target URL needs to be updated.
11151

11252
```
113-
helm upgrade openebs openebs/openebs -n openebs -f old-values.yaml --version 4.2
53+
helm repo remove openebs
54+
helm repo add openebs https://openebs.github.io/openebs
55+
helm repo update
11456
```
11557

116-
2. Verify that the CRDs, Volumes, Snapshots, and StoragePools are not affected by the upgrade process.
117-
118-
## Replicated Storage Upgrade
58+
2. Download the `kubectl openebs` binary from the [OpenEBS Release repository](https://github.com/openebs/openebs/releases) on GitHub.
11959

120-
:::note
121-
Downgrades are not supported.
122-
:::
60+
3. Execute `kubectl openebs upgrade -n <namespace>` to upgrade OpenEBS.
12361

124-
### From 3.x to 4.2
62+
4. Monitor the upgrade status using `kubectl openebs get upgrade-status -n <namespace>`.
12563

126-
This section describes the Replicated Storage upgrade from OpenEBS Umbrella chart 3.x to OpenEBS 4.2.
127-
128-
1. Start the helm upgrade process with the new chart, i.e. 4.2 by using the below command:
64+
5. Verify that the CRDs, Volumes, Snapshots, and StoragePools are not affected by the upgrade process.
12965

13066
:::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.
132-
:::
133-
134-
```
135-
# Add the option --set mayastor.agents.core.rebuild.partial.enabled=false if
136-
# the source version is a 3.x release.
137-
helm upgrade openebs openebs/openebs -n openebs -f old-values.yaml --version 4.2 \
138-
--set openebs-crds.csi.volumeSnapshots.enabled=false
139-
```
140-
141-
:::important
142-
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.
143-
:::
144-
145-
2. Verify that the CRDs, Volumes, Snapshots, and StoragePools are not affected by the upgrade process.
146-
147-
3. Start the Replicated Storage upgrade process by using the kubectl mayastor plugin v2.7.1.
148-
149-
```
150-
kubectl mayastor upgrade -n openebs --set 'mayastor.agents.core.rebuild.partial.enabled=false'
151-
```
152-
153-
- This deploys an upgrade process of K8s resource type Job.
154-
155-
```
156-
kubectl get jobs -n openebs
157-
158-
NAME COMPLETIONS DURATION AGE
159-
openebs-upgrade-v2-7-1 1/1 4m49s 6m11s
160-
```
67+
- For upgrades from 3.x to 4.x, include the following option in the kubectl openebs upgrade command to ensure data consistency during the upgrade:
16168

162-
- Wait for the upgrade job to complete.
69+
```
70+
--set mayastor.agents.core.rebuild.partial.enabled=false
71+
```
16372

164-
```
165-
kubectl get pods -n openebs
73+
This option is not required for upgrades from 4.x to newer versions.
16674

167-
openebs-upgrade-v2-7-1-s58xl 0/1 Completed 0 7m4s
168-
```
75+
- Add the option `--set mayastor.agents.core.rebuild.partial.enabled=false` if the source version is a 3.x release.
16976

170-
4. Once the upgrade process is completed, all the volumes and pools should be online.
77+
```
78+
kubectl openebs upgrade -n <namespace> --set openebs-crds.csi.volumeSnapshots.enabled=false
79+
```
17180

172-
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.
81+
- Re-enable the partial-rebuild feature after upgrade completes.
17382

174-
```
175-
helm upgrade openebs openebs/openebs -n openebs --reuse-values --version 4.2 \
83+
```
84+
helm upgrade openebs openebs/openebs -n <namespace> --reuse-values --version 4.2 \
17685
--set mayastor.agents.core.rebuild.partial.enabled=true
177-
```
178-
179-
### From 4.x to 4.2
180-
181-
This section describes the Replicated Storage upgrade from OpenEBS Umbrella chart 4.x to OpenEBS 4.2.
182-
183-
1. Start the helm upgrade process with the new chart, i.e. 4.2 by using the below command:
184-
185-
```
186-
helm upgrade openebs openebs/openebs -n openebs -f old-values.yaml --version 4.2
187-
```
188-
189-
2. Verify that the CRDs, Volumes, Snapshots and StoragePools are unaffected by the upgrade process.
190-
191-
3. Start the Replicated Storage upgrade process by using the kubectl mayastor plugin v2.7.1.
192-
193-
```
194-
kubectl mayastor upgrade -n openebs
195-
```
196-
197-
- This deploys an upgrade process of K8s resource type Job.
86+
```
87+
:::
19888

199-
```
200-
kubectl get jobs -n openebs
89+
## Upgrade from 4.x to 4.2
20190

202-
NAME COMPLETIONS DURATION AGE
203-
openebs-upgrade-v2-7-1 1/1 4m49s 6m11s
204-
```
91+
Follow these steps to upgrade OpenEBS from version 4.x to 4.2:
20592

206-
- Wait for the upgrade job to complete.
93+
1. Download the `kubectl openebs` binary from the [OpenEBS Release repository](https://github.com/openebs/openebs/releases) on GitHub.
20794

208-
```
209-
kubectl get pods -n openebs
95+
2. Execute `kubectl openebs upgrade -n <namespace>` to upgrade OpenEBS.
21096

211-
openebs-upgrade-v2-7-1-s58xl 0/1 Completed 0 7m4s
212-
```
97+
3. Monitor the upgrade status using `kubectl openebs get upgrade-status -n <namespace>`.
21398

214-
4. Once the upgrade process is completed, all the volumes and pools should be online.
99+
4. Verify that the CRDs, Volumes, Snapshots, and StoragePools are not affected by the upgrade process.
215100

216101
## See Also
217102

‎docs/versioned_docs/version-4.0.x/user-guides/upgrades.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ If the upgrade is from Local PV LVM or Local PV ZFS storage solution, additional
9595
Add both of these options, if your chart has both of these enabled.
9696
:::
9797

98-
3. Verify that the CRDs, Volumes, Snapshots and StoragePools are unaffected by the upgrade process.
98+
2. Verify that the CRDs, Volumes, Snapshots and StoragePools are unaffected by the upgrade process.
9999

100100
## Replicated Storage
101101

‎docs/versioned_docs/version-4.1.x/user-guides/upgrades.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ If the upgrade is from Local PV LVM or Local PV ZFS storage solution, additional
9595
Add both of these options, if your chart has both of these enabled.
9696
:::
9797

98-
3. Verify that the CRDs, Volumes, Snapshots and StoragePools are unaffected by the upgrade process.
98+
2. Verify that the CRDs, Volumes, Snapshots and StoragePools are unaffected by the upgrade process.
9999

100100
## Replicated Storage
101101

0 commit comments

Comments
 (0)