You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/main/user-guides/upgrades.md
+88-25Lines changed: 88 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ description: Upgrade to the latest OpenEBS version.
9
9
---
10
10
11
11
:::important
12
-
Upgrade from OpenEBS 3.x to OpenEBS 4.1.1 is only supported for the below storages installed from OpenEBS 3.x.
12
+
The upgrade from OpenEBS 3.x to OpenEBS 4.x is supported only for the following storages installed from OpenEBS 3.x.
13
13
14
14
- Local PV Hostpath
15
15
- Local PV LVM
@@ -21,18 +21,18 @@ Refer to the [Migration documentation](../user-guides/data-migration/migration-o
21
21
22
22
## Overview
23
23
24
-
This upgrade flow allows the users to upgrade to the latest OpenEBS version 4.1.1 which is a unified installer for three Local Storages (a.k.a Local Engines):
24
+
This upgrade process allows you to upgrade to the latest OpenEBS version 4.2 which is a unified installer for three Local Storages (a.k.a Local Engines):
25
25
- Local PV HostPath
26
26
- Local PV LVM
27
27
- Local PV ZFS
28
28
29
29
and one Replicated Storage (a.k.a Replicated Engine):
30
30
- Replicated PV Mayastor
31
31
32
-
As a part of upgrade to OpenEBS 4.1.1, the helm chart would install all four engines irrespective of the engine the user was using prior to the upgrade.
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.
33
33
34
34
:::info
35
-
During the upgrade, advanced users who are only interested in Local PV Storage, can disable the 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 setting the below option:
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, [here](https://github.com/openebs/openebs/blob/HEAD/charts/values.yaml).
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
62
63
-
For users who 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.
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
64
65
-
Feel free to reach out via our communication channels.
65
+
Feel free to reach out via our [communication channels](../community.md).
66
66
:::
67
67
68
+
## Local Storage Upgrade
68
69
69
-
## Local Storage
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.
70
71
71
-
This section describes the Local Storage upgrade from OpenEBS chart 3.x to OpenEBS 4.1.1. 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.
72
+
:::note
73
+
Downgrades are not supported.
74
+
:::
75
+
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.
If the upgrade is 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 be in conflict with the CRDs in 4.1.1 as the chart structure has changed. Hence, they must be disabled.
81
-
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.
82
88
83
89
- For Upgrade from Local PV LVM, use
84
90
@@ -95,28 +101,48 @@ If the upgrade is from Local PV LVM or Local PV ZFS storage solution, additional
95
101
Add both of these options, if your chart has both of these enabled.
96
102
:::
97
103
98
-
3. Verify that the CRDs, Volumes, Snapshots and StoragePools are unaffected by the upgrade process.
104
+
2. Verify that the CRDs, Volumes, Snapshots, and StoragePools are not affected by the upgrade process.
99
105
100
-
##Replicated Storage
106
+
### From 4.x to 4.2
101
107
102
-
This section describes the Replicated Storage upgrade from OpenEBS Umbrella chart 3.x to OpenEBS 4.1.1.
108
+
This section describes the Local Storage upgrade from OpenEBS chart 4.x to OpenEBS 4.2.
103
109
104
-
1.Start the helm upgrade process with the new chart, i.e. 4.1.1 by using the below command:
110
+
1.Execute the 4.2 upgrade command.
105
111
106
-
:::caution
107
-
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 upgrade. Upgrades from 4.x onwards to newer version do not require it.
2. Verify that the CRDs, Volumes, Snapshots, and StoragePools are not affected by the upgrade process.
117
+
118
+
## Replicated Storage Upgrade
119
+
120
+
:::note
121
+
Downgrades are not supported.
122
+
:::
108
123
109
-
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`
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.
127
+
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.
110
132
:::
111
133
112
134
```
113
135
# Add the option --set mayastor.agents.core.rebuild.partial.enabled=false if
2. Verify that the CRDs, Volumes, Snapshots and StoragePools are unaffected by the upgrade process.
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.
120
146
121
147
3. Start the Replicated Storage upgrade process by using the kubectl mayastor plugin v2.7.1.
122
148
@@ -141,17 +167,54 @@ kubectl get pods -n openebs
141
167
openebs-upgrade-v2-7-1-s58xl 0/1 Completed 0 7m4s
142
168
```
143
169
144
-
4. Once the upgrade process completes, all the volumes and pools should be online.
170
+
4. Once the upgrade process is completed, all the volumes and pools should be online.
145
171
146
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.
0 commit comments