Skip to content

Commit

Permalink
chore: update upgrade and releases pages
Browse files Browse the repository at this point in the history 
Signed-off-by: Niladri Halder <niladri.halder26@gmail.com>
  • Loading branch information
@niladrih
niladrih committed Sep 25, 2024
1 parent 63cffe3 commit a43f1c0
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 38 deletions.
14 changes: 7 additions & 7 deletions docs/main/releases.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,18 @@ description: This page contains list of supported OpenEBS releases.
**Release Date: 08 July 2024**

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.
The status of the various components as of v4.1.0 are as follows:
The status of the various components as of v4.1.1 are as follows:

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

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

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

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

## Related Information

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).
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).

See version specific Releases to view the legacy OpenEBS Releases.

Expand Down
30 changes: 15 additions & 15 deletions docs/main/user-guides/upgrades.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description: Upgrade to the latest OpenEBS version.
---

:::important
Upgrade from OpenEBS 3.x to OpenEBS 4.1.0 is only supported for the below storages installed from OpenEBS 3.x.
Upgrade from OpenEBS 3.x to OpenEBS 4.1.1 is only supported for the below storages installed from OpenEBS 3.x.

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

## Overview

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):
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):
- Local PV HostPath
- Local PV LVM
- Local PV ZFS

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

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

:::info
During the upgrade, advanced users who are only interested in Local PV Storage, can disable the Replicated PV Mayastor by setting the below option:
Expand Down Expand Up @@ -68,16 +68,16 @@ 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.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.
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.

1. Execute the 4.1.0 upgrade command.
1. Execute the 4.1.1 upgrade command.

```
helm upgrade openebs openebs/openebs -n openebs -f old-values.yaml --version 4.1.0
helm upgrade openebs openebs/openebs -n openebs -f old-values.yaml --version 4.1.1
```

:::note
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.
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.


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

## Replicated Storage

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

1. Start the helm upgrade process with the new chart, i.e. 4.1.0 by using the below command:
1. Start the helm upgrade process with the new chart, i.e. 4.1.1 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.1.0 to ensure data consistency during upgrade. Input the value `--set mayastor.agents.core.rebuild.partial.enabled=false` in the **helm upgrade** command.
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.

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.1.0 \
helm upgrade openebs openebs/openebs -n openebs -f old-values.yaml --version 4.1.1 \
--set mayastor.agents.core.rebuild.partial.enabled=false \
--set openebs-crds.csi.volumeSnapshots.enabled=false
```

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

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

```
kubectl mayastor upgrade -n openebs --set 'mayastor.agents.core.rebuild.partial.enabled=false'
Expand All @@ -129,23 +129,23 @@ kubectl mayastor upgrade -n openebs --set 'mayastor.agents.core.rebuild.partial.
kubectl get jobs -n openebs
NAME COMPLETIONS DURATION AGE
openebs-upgrade-v2-7-0 1/1 4m49s 6m11s
openebs-upgrade-v2-7-1 1/1 4m49s 6m11s
```

- Wait for the upgrade job to complete.

```
kubectl get pods -n openebs
openebs-upgrade-v2-7-0-s58xl 0/1 Completed 0 7m4s
openebs-upgrade-v2-7-1-s58xl 0/1 Completed 0 7m4s
```

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

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.1.0 \
helm upgrade openebs openebs/openebs -n openebs --reuse-values --version 4.1.1 \
--set mayastor.agents.core.rebuild.partial.enabled=true
```

Expand Down
32 changes: 16 additions & 16 deletions docs/versioned_docs/version-4.1.x/user-guides/upgrades.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description: Upgrade to the latest OpenEBS version.
---

:::important
Upgrade from OpenEBS 3.x to OpenEBS 4.1.0 is only supported for the below storages installed from OpenEBS 3.x.
Upgrade from OpenEBS 3.x to OpenEBS 4.1.1 is only supported for the below storages installed from OpenEBS 3.x.

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

## Overview

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):
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):
- Local PV HostPath
- Local PV LVM
- Local PV ZFS

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

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

:::info
During the upgrade, advanced users who are only interested in Local PV Storage, can disable the Replicated PV Mayastor by setting the below option:
Expand Down Expand Up @@ -68,16 +68,16 @@ 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.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.
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.

1. Execute the 4.1.0 upgrade command.
1. Execute the 4.1.1 upgrade command.

```
helm upgrade openebs openebs/openebs -n openebs -f old-values.yaml --version 4.1.0
helm upgrade openebs openebs/openebs -n openebs -f old-values.yaml --version 4.1.1
```

:::note
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.
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.


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

## Replicated Storage

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

1. Start the helm upgrade process with the new chart, i.e. 4.1.0 by using the below command:
1. Start the helm upgrade process with the new chart, i.e. 4.1.1 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.1.0 to ensure data consistency during upgrade. Input the value `--set mayastor.agents.core.rebuild.partial.enabled=false` in the **helm upgrade** command.
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.

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.1.0 \
helm upgrade openebs openebs/openebs -n openebs -f old-values.yaml --version 4.1.1 \
--set mayastor.agents.core.rebuild.partial.enabled=false \
--set openebs-crds.csi.volumeSnapshots.enabled=false
```

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

3. Start the Replicated Storage upgrade process by using the kubectl mayastor plugin v2.7.0.
2. Start the Replicated Storage upgrade process by using the kubectl mayastor plugin v2.7.1.

```
kubectl mayastor upgrade -n openebs --set 'mayastor.agents.core.rebuild.partial.enabled=false'
Expand All @@ -129,23 +129,23 @@ kubectl mayastor upgrade -n openebs --set 'mayastor.agents.core.rebuild.partial.
kubectl get jobs -n openebs
NAME COMPLETIONS DURATION AGE
openebs-upgrade-v2-7-0 1/1 4m49s 6m11s
openebs-upgrade-v2-7-1 1/1 4m49s 6m11s
```

- Wait for the upgrade job to complete.

```
kubectl get pods -n openebs
openebs-upgrade-v2-7-0-s58xl 0/1 Completed 0 7m4s
openebs-upgrade-v2-7-1-s58xl 0/1 Completed 0 7m4s
```

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

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.1.0 \
helm upgrade openebs openebs/openebs -n openebs --reuse-values --version 4.1.1 \
--set mayastor.agents.core.rebuild.partial.enabled=true
```

Expand Down

0 comments on commit a43f1c0

Please sign in to comment.