Skip to content

Commit

Permalink
docs: Update Version Numbers and Enhance Release Notes
Browse files Browse the repository at this point in the history
Signed-off-by: Bala Harish <161304963+balaharish7@users.noreply.github.com>
  • Loading branch information
balaharish7 committed Jan 30, 2025
1 parent 2d46eb5 commit 12eaf2e
Show file tree
Hide file tree
Showing 3 changed files with 61 additions and 23 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ helm ls -n openebs

```
NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION
openebs openebs 1 2024-03-25 09:13:00.903321318 +0000 UTC deployed openebs-4.1.0 4.1.0
openebs openebs 1 2024-03-25 09:13:00.903321318 +0000 UTC deployed openebs-4.1.3 4.1.3
```

As a next step [verify](#verifying-openebs-installation) your installation and do the [post installation](#post-installation-considerations) steps.
Expand Down
48 changes: 43 additions & 5 deletions docs/versioned_docs/version-4.1.x/releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,21 @@ keywords:
description: This page contains list of supported OpenEBS releases.
---

**Release Date: 08 July 2024**
**Release Date: 30 January 2025**

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

- Local Storage (a.k.a Local Engine)
- [Local PV Hostpath 4.1.1](https://github.com/openebs/dynamic-localpv-provisioner) (stable)
- [Local PV Hostpath 4.1.4](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.1](https://github.com/openebs/mayastor) (stable)
- [Replicated PV Mayastor 2.7.3](https://github.com/openebs/mayastor) (stable)

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

- Other Components
- [CLI 0.6.0](https://github.com/openebs/openebsctl) (beta)
Expand All @@ -32,8 +32,22 @@ The status of the various components as of v4.1.1 are as follows:

OpenEBS is delighted to introduce the following new features:

### What’s New - Local Storage

- **Specify Additional Labels**

Enables specifying additional labels to be applied to all Helm chart resources.

### What’s New - Replicated Storage

- **Pre-publish Hook in CSI Driver**

Introduces a pre-publish hook to clean up stale entries before publishing a volume.

- **Use `tokio_stream::UnixListenerStream` in CSI Driver**

Switches to `tokio_stream::UnixListenerStream` for improved async handling.

- **Snapshot across Multiple Replicas**

Replicated PV Mayastor has enhanced its snapshot capabilities to ensure file-system consistency across multiple replicas before taking snapshots. This ensures that snapshots are consistent and reliable across multiple replicas.
Expand All @@ -58,12 +72,36 @@ Grafana Dashboards for Replicated PV Mayastor has been added in this releases.

### Fixed Issues - Local Storage

- **Environment Variable**

Ensures that the environment variable to disable event analytics reporting is properly honored. ([#211](https://github.com/openebs/dynamic-localpv-provisioner/pull/211))

- **Prevent Race Condition**

Adds `priorityClassName` to pods to prevent race conditions caused by pod eviction. ([#182](https://github.com/openebs/dynamic-localpv-provisioner/pull/182))

- **Metrics Collection Loop**

Adds an anonymous metrics collection loop which periodically pushes OpenEBS usage metrics. ([#188](https://github.com/openebs/dynamic-localpv-provisioner/pull/188),[#318](https://github.com/openebs/lvm-localpv/pull/318), and[#548](https://github.com/openebs/zfs-localpv/pull/548))

### Fixed Issues - Replicated Storage

- **Make Readiness Check Atomic in REST API**

Ensures the readiness check API performs atomic operations to prevent multiple concurrent probes of the agent-core service.

- **Prevent volume Unpublish from Non-frontend Nodes**

Restricts volume unpublish operations to only frontend nodes to ensure proper handling.

- **Increase Maximum Connection Attempts to IO-Engine**

Raises the maximum number of allowed connection attempts to improve reliability.

- **Fix Topology Key Overwriting Affinity Labels**

Resolves issue where `hasTopologyKey` was overwriting `affinityTopologyLabels`.

- **Plugin changes for Snapshot Operation**

This plugin will give detailed information about volume snapshot operation. ([#500](https://github.com/openebs/mayastor-extensions/pull/500))
Expand Down
34 changes: 17 additions & 17 deletions docs/versioned_docs/version-4.1.x/user-guides/upgrades.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,30 +9,30 @@ description: Upgrade to the latest OpenEBS version.
---

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

- Local PV Hostpath
- Local PV LVM
- Local PV ZFS
- Replicated PV Mayastor

See the [migration documentation](../user-guides/data-migration/migration-overview.md) for other storages.
Refer to the [Migration documentation](../user-guides/data-migration/migration-overview.md) for other storages.
:::

## Overview

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):
This upgrade flow allows you to upgrade to the latest OpenEBS version 4.1.3 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.1, 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.3, 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:
During the upgrade, if you are only interested in Local PV Storage, you can disable the Replicated PV Mayastor by setting the below option:

```
--set engines.replicated.mayastor.enabled=false
Expand Down Expand Up @@ -60,24 +60,24 @@ helm get values openebs -n openebs -o yaml > old-values.yaml
:::note
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).

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

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.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.
This section describes the Local Storage upgrade from OpenEBS chart 3.x to OpenEBS 4.1.3. 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.1 upgrade command.
1. Execute the 4.1.3 upgrade command.

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

:::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.1 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.3 as the chart structure has changed. Hence, they must be disabled.


- For Upgrade from Local PV LVM, use
Expand All @@ -99,9 +99,9 @@ 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.1.
This section describes the Replicated Storage upgrade from OpenEBS Umbrella chart 3.x to OpenEBS 4.1.3.

1. Start the helm upgrade process with the new chart, i.e. 4.1.1 by using the below command:
1. Start the helm upgrade process with the new chart, i.e. 4.1.3 by using the below command:

:::caution
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.
Expand All @@ -112,13 +112,13 @@ This applies to the **kubectl mayastor upgrade** command as well, if you're usin
```
# Add the option --set mayastor.agents.core.rebuild.partial.enabled=false if
# the source version is a 3.x release.
helm upgrade openebs openebs/openebs -n openebs -f old-values.yaml --version 4.1.1 \
helm upgrade openebs openebs/openebs -n openebs -f old-values.yaml --version 4.1.3 \
--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.1.
3. Start the Replicated Storage upgrade process by using the kubectl mayastor plugin v2.7.3.

```
kubectl mayastor upgrade -n openebs --set 'mayastor.agents.core.rebuild.partial.enabled=false'
Expand All @@ -130,23 +130,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-1 1/1 4m49s 6m11s
openebs-upgrade-v2-7-3 1/1 4m49s 6m11s
```

- Wait for the upgrade job to complete.

```
kubectl get pods -n openebs
openebs-upgrade-v2-7-1-s58xl 0/1 Completed 0 7m4s
openebs-upgrade-v2-7-3-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.1 \
helm upgrade openebs openebs/openebs -n openebs --reuse-values --version 4.1.3 \
--set mayastor.agents.core.rebuild.partial.enabled=true
```

Expand Down

0 comments on commit 12eaf2e

Please sign in to comment.