Skip to content

Commit c36f5bb

Browse files
authored
chore: update upgrade and releases pages (#490)
Signed-off-by: Niladri Halder <[email protected]>
1 parent 63cffe3 commit c36f5bb

File tree

4 files changed

+48
-46
lines changed

4 files changed

+48
-46
lines changed

docs/main/releases.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,18 @@ description: This page contains list of supported OpenEBS releases.
1212
**Release Date: 08 July 2024**
1313

1414
OpenEBS is a collection of data engines and operators to create different types of replicated and local persistent volumes for Kubernetes Stateful workloads. Kubernetes volumes can be provisioned via CSI Drivers or using Out-of-tree Provisioners.
15-
The status of the various components as of v4.1.0 are as follows:
15+
The status of the various components as of v4.1.1 are as follows:
1616

1717
- Local Storage (a.k.a Local Engine)
18-
- [Local PV Hostpath 4.1.0](https://github.com/openebs/dynamic-localpv-provisioner) (stable)
19-
- [Local PV LVM 1.6.0](https://github.com/openebs/lvm-localpv) (stable)
20-
- [Local PV ZFS 2.6.0](https://github.com/openebs/zfs-localpv) (stable)
18+
- [Local PV Hostpath 4.1.1](https://github.com/openebs/dynamic-localpv-provisioner) (stable)
19+
- [Local PV LVM 1.6.1](https://github.com/openebs/lvm-localpv) (stable)
20+
- [Local PV ZFS 2.6.2](https://github.com/openebs/zfs-localpv) (stable)
2121

2222
- Replicated Storage (a.k.a Replicated Engine)
23-
- [Replicated PV Mayastor 2.7.0](https://github.com/openebs/mayastor) (stable)
23+
- [Replicated PV Mayastor 2.7.1](https://github.com/openebs/mayastor) (stable)
2424

2525
- Out-of-tree (External Storage) Provisioners
26-
- [Local PV Hostpath 4.1.0](https://github.com/openebs/dynamic-localpv-provisioner) (stable)
26+
- [Local PV Hostpath 4.1.1](https://github.com/openebs/dynamic-localpv-provisioner) (stable)
2727

2828
- Other Components
2929
- [CLI 0.6.0](https://github.com/openebs/openebsctl) (beta)
@@ -99,7 +99,7 @@ The workaround is to delete the old pod so the new pod can get scheduled. Refer
9999

100100
## Related Information
101101

102-
OpenEBS Release notes are maintained in the GitHub repositories alongside the code and releases. For summary of what changes across all components in each release and to view the full Release Notes, see [OpenEBS Release 4.1](https://github.com/openebs/openebs/releases/tag/v4.1.0).
102+
OpenEBS Release notes are maintained in the GitHub repositories alongside the code and releases. For summary of what changes across all components in each release and to view the full Release Notes, see [OpenEBS Release 4.1](https://github.com/openebs/openebs/releases/tag/v4.1.1).
103103

104104
See version specific Releases to view the legacy OpenEBS Releases.
105105

docs/main/user-guides/upgrades.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ description: Upgrade to the latest OpenEBS version.
99
---
1010

1111
:::important
12-
Upgrade from OpenEBS 3.x to OpenEBS 4.1.0 is only supported for the below storages installed from OpenEBS 3.x.
12+
Upgrade from OpenEBS 3.x to OpenEBS 4.1.1 is only supported for the below storages installed from OpenEBS 3.x.
1313

1414
- Local PV Hostpath
1515
- Local PV LVM
@@ -21,15 +21,15 @@ Refer to the [Migration documentation](../user-guides/data-migration/migration-o
2121

2222
## Overview
2323

24-
This upgrade flow allows the users to upgrade to the latest OpenEBS version 4.1.0 which is a unified installer for three Local Storages (a.k.a Local Engines):
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):
2525
- Local PV HostPath
2626
- Local PV LVM
2727
- Local PV ZFS
2828

2929
and one Replicated Storage (a.k.a Replicated Engine):
3030
- Replicated PV Mayastor
3131

32-
As a part of upgrade to OpenEBS 4.1.0, 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 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.
3333

3434
:::info
3535
During the upgrade, advanced users who are only interested in Local PV Storage, can disable the Replicated PV Mayastor by setting the below option:
@@ -68,16 +68,16 @@ Feel free to reach out via our communication channels.
6868

6969
## Local Storage
7070

71-
This section describes the Local Storage upgrade from OpenEBS chart 3.x to OpenEBS 4.1.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.
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.
7272

73-
1. Execute the 4.1.0 upgrade command.
73+
1. Execute the 4.1.1 upgrade command.
7474

7575
```
76-
helm upgrade openebs openebs/openebs -n openebs -f old-values.yaml --version 4.1.0
76+
helm upgrade openebs openebs/openebs -n openebs -f old-values.yaml --version 4.1.1
7777
```
7878

7979
:::note
80-
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.0 as the chart structure has changed. Hence, they must be disabled.
80+
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.
8181

8282

8383
- For Upgrade from Local PV LVM, use
@@ -99,25 +99,26 @@ Add both of these options, if your chart has both of these enabled.
9999

100100
## Replicated Storage
101101

102-
This section describes the Replicated Storage upgrade from OpenEBS Umbrella chart 3.x to OpenEBS 4.1.0.
102+
This section describes the Replicated Storage upgrade from OpenEBS Umbrella chart 3.x to OpenEBS 4.1.1.
103103

104-
1. Start the helm upgrade process with the new chart, i.e. 4.1.0 by using the below command:
104+
1. Start the helm upgrade process with the new chart, i.e. 4.1.1 by using the below command:
105105

106106
:::caution
107-
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.1.0 to ensure data consistency during upgrade. Input the value `--set mayastor.agents.core.rebuild.partial.enabled=false` in the **helm upgrade** command.
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.
108108

109109
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`
110110
:::
111111

112112
```
113-
helm upgrade openebs openebs/openebs -n openebs -f old-values.yaml --version 4.1.0 \
114-
--set mayastor.agents.core.rebuild.partial.enabled=false \
113+
# Add the option --set mayastor.agents.core.rebuild.partial.enabled=false if
114+
# the source version is a 3.x release.
115+
helm upgrade openebs openebs/openebs -n openebs -f old-values.yaml --version 4.1.1 \
115116
--set openebs-crds.csi.volumeSnapshots.enabled=false
116117
```
117118

118119
2. Verify that the CRDs, Volumes, Snapshots and StoragePools are unaffected by the upgrade process.
119120

120-
3. Start the Replicated Storage upgrade process by using the kubectl mayastor plugin v2.7.0.
121+
3. Start the Replicated Storage upgrade process by using the kubectl mayastor plugin v2.7.1.
121122

122123
```
123124
kubectl mayastor upgrade -n openebs --set 'mayastor.agents.core.rebuild.partial.enabled=false'
@@ -129,23 +130,23 @@ kubectl mayastor upgrade -n openebs --set 'mayastor.agents.core.rebuild.partial.
129130
kubectl get jobs -n openebs
130131
131132
NAME COMPLETIONS DURATION AGE
132-
openebs-upgrade-v2-7-0 1/1 4m49s 6m11s
133+
openebs-upgrade-v2-7-1 1/1 4m49s 6m11s
133134
```
134135

135136
- Wait for the upgrade job to complete.
136137

137138
```
138139
kubectl get pods -n openebs
139140
140-
openebs-upgrade-v2-7-0-s58xl 0/1 Completed 0 7m4s
141+
openebs-upgrade-v2-7-1-s58xl 0/1 Completed 0 7m4s
141142
```
142143

143144
4. Once the upgrade process completes, all the volumes and pools should be online.
144145

145146
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.
146147

147148
```
148-
helm upgrade openebs openebs/openebs -n openebs --reuse-values --version 4.1.0 \
149+
helm upgrade openebs openebs/openebs -n openebs --reuse-values --version 4.1.1 \
149150
--set mayastor.agents.core.rebuild.partial.enabled=true
150151
```
151152

docs/versioned_docs/version-4.1.x/releases.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,18 @@ description: This page contains list of supported OpenEBS releases.
1212
**Release Date: 08 July 2024**
1313

1414
OpenEBS is a collection of data engines and operators to create different types of replicated and local persistent volumes for Kubernetes Stateful workloads. Kubernetes volumes can be provisioned via CSI Drivers or using Out-of-tree Provisioners.
15-
The status of the various components as of v4.1.0 are as follows:
15+
The status of the various components as of v4.1.1 are as follows:
1616

1717
- Local Storage (a.k.a Local Engine)
18-
- [Local PV Hostpath 4.1.0](https://github.com/openebs/dynamic-localpv-provisioner) (stable)
19-
- [Local PV LVM 1.6.0](https://github.com/openebs/lvm-localpv) (stable)
20-
- [Local PV ZFS 2.6.0](https://github.com/openebs/zfs-localpv) (stable)
18+
- [Local PV Hostpath 4.1.1](https://github.com/openebs/dynamic-localpv-provisioner) (stable)
19+
- [Local PV LVM 1.6.1](https://github.com/openebs/lvm-localpv) (stable)
20+
- [Local PV ZFS 2.6.2](https://github.com/openebs/zfs-localpv) (stable)
2121

2222
- Replicated Storage (a.k.a Replicated Engine)
23-
- [Replicated PV Mayastor 2.7.0](https://github.com/openebs/mayastor) (stable)
23+
- [Replicated PV Mayastor 2.7.1](https://github.com/openebs/mayastor) (stable)
2424

2525
- Out-of-tree (External Storage) Provisioners
26-
- [Local PV Hostpath 4.1.0](https://github.com/openebs/dynamic-localpv-provisioner) (stable)
26+
- [Local PV Hostpath 4.1.1](https://github.com/openebs/dynamic-localpv-provisioner) (stable)
2727

2828
- Other Components
2929
- [CLI 0.6.0](https://github.com/openebs/openebsctl) (beta)
@@ -99,7 +99,7 @@ The workaround is to delete the old pod so the new pod can get scheduled. See th
9999

100100
## Related Information
101101

102-
OpenEBS Release notes are maintained in the GitHub repositories alongside the code and releases. For summary of what changes across all components in each release and to view the full Release Notes, see [OpenEBS Release 4.1](https://github.com/openebs/openebs/releases/tag/v4.1.0).
102+
OpenEBS Release notes are maintained in the GitHub repositories alongside the code and releases. For summary of what changes across all components in each release and to view the full Release Notes, see [OpenEBS Release 4.1](https://github.com/openebs/openebs/releases/tag/v4.1.1).
103103

104104
See version specific Releases to view the legacy OpenEBS Releases.
105105

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

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ description: Upgrade to the latest OpenEBS version.
99
---
1010

1111
:::important
12-
Upgrade from OpenEBS 3.x to OpenEBS 4.1.0 is only supported for the below storages installed from OpenEBS 3.x.
12+
Upgrade from OpenEBS 3.x to OpenEBS 4.1.1 is only supported for the below storages installed from OpenEBS 3.x.
1313

1414
- Local PV Hostpath
1515
- Local PV LVM
@@ -21,15 +21,15 @@ See the [migration documentation](../user-guides/data-migration/migration-overvi
2121

2222
## Overview
2323

24-
This upgrade flow allows the users to upgrade to the latest OpenEBS version 4.1.0 which is a unified installer for three Local Storages (a.k.a Local Engines):
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):
2525
- Local PV HostPath
2626
- Local PV LVM
2727
- Local PV ZFS
2828

2929
and one Replicated Storage (a.k.a Replicated Engine):
3030
- Replicated PV Mayastor
3131

32-
As a part of upgrade to OpenEBS 4.1.0, 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 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.
3333

3434
:::info
3535
During the upgrade, advanced users who are only interested in Local PV Storage, can disable the Replicated PV Mayastor by setting the below option:
@@ -68,16 +68,16 @@ Feel free to reach out via our communication channels.
6868

6969
## Local Storage
7070

71-
This section describes the Local Storage upgrade from OpenEBS chart 3.x to OpenEBS 4.1.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.
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.
7272

73-
1. Execute the 4.1.0 upgrade command.
73+
1. Execute the 4.1.1 upgrade command.
7474

7575
```
76-
helm upgrade openebs openebs/openebs -n openebs -f old-values.yaml --version 4.1.0
76+
helm upgrade openebs openebs/openebs -n openebs -f old-values.yaml --version 4.1.1
7777
```
7878

7979
:::note
80-
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.0 as the chart structure has changed. Hence, they must be disabled.
80+
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.
8181

8282

8383
- For Upgrade from Local PV LVM, use
@@ -99,25 +99,26 @@ Add both of these options, if your chart has both of these enabled.
9999

100100
## Replicated Storage
101101

102-
This section describes the Replicated Storage upgrade from OpenEBS Umbrella chart 3.x to OpenEBS 4.1.0.
102+
This section describes the Replicated Storage upgrade from OpenEBS Umbrella chart 3.x to OpenEBS 4.1.1.
103103

104-
1. Start the helm upgrade process with the new chart, i.e. 4.1.0 by using the below command:
104+
1. Start the helm upgrade process with the new chart, i.e. 4.1.1 by using the below command:
105105

106106
:::caution
107-
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.1.0 to ensure data consistency during upgrade. Input the value `--set mayastor.agents.core.rebuild.partial.enabled=false` in the **helm upgrade** command.
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.
108108

109109
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`
110110
:::
111111

112112
```
113-
helm upgrade openebs openebs/openebs -n openebs -f old-values.yaml --version 4.1.0 \
114-
--set mayastor.agents.core.rebuild.partial.enabled=false \
113+
# Add the option --set mayastor.agents.core.rebuild.partial.enabled=false if
114+
# the source version is a 3.x release.
115+
helm upgrade openebs openebs/openebs -n openebs -f old-values.yaml --version 4.1.1 \
115116
--set openebs-crds.csi.volumeSnapshots.enabled=false
116117
```
117118

118119
2. Verify that the CRDs, Volumes, Snapshots and StoragePools are unaffected by the upgrade process.
119120

120-
3. Start the Replicated Storage upgrade process by using the kubectl mayastor plugin v2.7.0.
121+
3. Start the Replicated Storage upgrade process by using the kubectl mayastor plugin v2.7.1.
121122

122123
```
123124
kubectl mayastor upgrade -n openebs --set 'mayastor.agents.core.rebuild.partial.enabled=false'
@@ -129,23 +130,23 @@ kubectl mayastor upgrade -n openebs --set 'mayastor.agents.core.rebuild.partial.
129130
kubectl get jobs -n openebs
130131
131132
NAME COMPLETIONS DURATION AGE
132-
openebs-upgrade-v2-7-0 1/1 4m49s 6m11s
133+
openebs-upgrade-v2-7-1 1/1 4m49s 6m11s
133134
```
134135

135136
- Wait for the upgrade job to complete.
136137

137138
```
138139
kubectl get pods -n openebs
139140
140-
openebs-upgrade-v2-7-0-s58xl 0/1 Completed 0 7m4s
141+
openebs-upgrade-v2-7-1-s58xl 0/1 Completed 0 7m4s
141142
```
142143

143144
4. Once the upgrade process completes, all the volumes and pools should be online.
144145

145146
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.
146147

147148
```
148-
helm upgrade openebs openebs/openebs -n openebs --reuse-values --version 4.1.0 \
149+
helm upgrade openebs openebs/openebs -n openebs --reuse-values --version 4.1.1 \
149150
--set mayastor.agents.core.rebuild.partial.enabled=true
150151
```
151152

0 commit comments

Comments
 (0)