chore(release): update to 2.4.0 references

Signed-off-by: kmova <[email protected]>
openebs-archive · Dec 19, 2020 · b2d7a22 · b2d7a22
1 parent 560537d
commit b2d7a22
Show file tree

Hide file tree

Showing 7 changed files with 92 additions and 20 deletions.
diff --git a/docs/installation.md b/docs/installation.md
@@ -598,7 +598,7 @@ Find `apiServer`, `provisioner`, `snapshotOperator`, `admission-server` and `ndm
 ```
 provisioner:
   image: "openebs/openebs-k8s-provisioner"
-  imageTag: "2.3.0"
+  imageTag: "2.4.0"
   replicas: 1
   nodeSelector: {}
   tolerations: []
@@ -616,7 +616,7 @@ In the `values.yaml`, find`ndm` section to update `excludeVendors:` and `exclude
 ```
 ndm:
   image: "openebs/node-disk-manager"
-  imageTag: "1.0.0"
+  imageTag: "1.0.1"
   sparse:
     path: "/var/openebs/sparse"
     size: "10737418240"

diff --git a/docs/jivaguide.md b/docs/jivaguide.md
@@ -573,11 +573,11 @@ Below table lists the storage policies supported by Jiva. These policies can be
 | JIVA STORAGE POLICY                                          | MANDATORY | DEFAULT                           | PURPOSE                                                      |
 | ------------------------------------------------------------ | --------- | --------------------------------- | ------------------------------------------------------------ |
 | [ReplicaCount](#Replica-Count-Policy)                        | No        | 3                                 | Defines the number of Jiva volume replicas                   |
-| [Replica Image](#Replica-Image-Policy)                       |           | openebs/m-apiserver:2.3.0 | To use particular Jiva replica image                         |
-| [ControllerImage](#Controller-Image-Policy)                  |           | openebs/jiva:2.3.0         | To use particular Jiva Controller Image                      |
+| [Replica Image](#Replica-Image-Policy)                       |           | openebs/m-apiserver:2.4.0 | To use particular Jiva replica image                         |
+| [ControllerImage](#Controller-Image-Policy)                  |           | openebs/jiva:2.4.0         | To use particular Jiva Controller Image                      |
 | [StoragePool](#Storage-Pool-Policy)                          | Yes       | default                           | A storage pool provides a persistent path for an OpenEBS volume. It can be a directory on host OS or externally mounted disk. |
 | [VolumeMonitor](#Volume-Monitor-Policy)                      |           | ON                                | When ON, a volume exporter sidecar is launched to export Prometheus metrics. |
-| [VolumeMonitorImage](#Volume-Monitoring-Image-Policy)        |           | openebs/m-exporter:2.3.0  | Used when VolumeMonitor is ON. A dedicated metrics exporter to the workload. Can be used to apply a specific issue or feature for the workload |
+| [VolumeMonitorImage](#Volume-Monitoring-Image-Policy)        |           | openebs/m-exporter:2.4.0  | Used when VolumeMonitor is ON. A dedicated metrics exporter to the workload. Can be used to apply a specific issue or feature for the workload |
 | [Volume FSType](#Volume-File-System-Type-Policy)             |           | ext4                              | Specifies the filesystem that the volume should be formatted with. Other values are `xfs` |
 | [Volume Space Reclaim](#Volume-Space-Reclaim-Policy)         |           | false                             | It will specify whether data need to be retained post PVC deletion. |
 | [TargetNodeSelector](#Targe-NodeSelector-Policy)             |           | Decided by Kubernetes scheduler   | Specify the label in `key: value` format to notify Kubernetes scheduler to schedule Jiva target pod on the nodes that match label. |
@@ -623,7 +623,7 @@ metadata:
     openebs.io/cas-type: jiva
     cas.openebs.io/config: |
       - name: ReplicaImage
-        value: openebs/m-apiserver:2.3.0
+        value: openebs/m-apiserver:2.4.0
 provisioner: openebs.io/provisioner-iscsi
 ```
 
@@ -640,7 +640,7 @@ metadata:
     openebs.io/cas-type: jiva
     cas.openebs.io/config: |
       - name: ControllerImage
-        value: openebs/jiva:2.3.0
+        value: openebs/jiva:2.4.0
 provisioner: openebs.io/provisioner-iscsi
 ```
 
@@ -729,7 +729,7 @@ metadata:
     openebs.io/cas-type: jiva
     cas.openebs.io/config: |
       - name: VolumeMonitorImage
-        value: openebs/m-exporter:2.3.0
+        value: openebs/m-exporter:2.4.0
 provisioner: openebs.io/provisioner-iscsi
 ```
 

diff --git a/docs/releases.md b/docs/releases.md
@@ -8,10 +8,81 @@ sidebar_label: Releases
 
 <br>
 
-## 2.3.0 - Nov 15 2020
+## 2.4.0 - Dec 15 2020
 
 <br><font size="4">Latest Release</font><br/> (Recommended)<br/>
 
+### New capabilities
+- ZFS Local PV has now been graduated to stable with all the supported features and upgrade tests automated via e2e testing. ZFS Local PV is best suited for distributed workloads that require resilient local volumes that can sustain local disk failures. You can read more about using the ZFS Local volumes at https://github.com/openebs/zfs-localpv and check out how ZFS Local PVs are used in production at [Optoro](https://github.com/openebs/openebs/blob/master/adopters/optoro/README.md).
+
+- OpenEBS is introducing a new NFS dynamic provisioner to allow the creation and deletion of NFS volumes using Kernel NFS backed by block storage. This provisioner is being actively developed and released as alpha. This new provisioner allows users to provision OpenEBS RWX volumes where each volume gets its own NFS server instance. In the previous releases, OpenEBS RWX volumes were supported via the [Kubernetes NFS Ganesha and External Provisioner](https://docs.openebs.io/docs/next/rwm.html) - where multiple RWX volumes share the same NFS Ganesha Server. You can read more about the new OpenEBS Dynamic Provisioner at https://github.com/openebs/dynamic-nfs-provisioner.
+
+
+### Key Improvements
+
+- Added support for specifying a custom node affinity label for OpenEBS Local Hostpath volumes. By default, OpenEBS Local Hostpath volumes use `kubenetes.io/hostname` for setting the PV Node Affinity. Users can now specify a custom label to use for PV Node Affinity. Custom node affinity can be specified in the Local PV storage class as follows: 
+  ```
+  kind: StorageClass
+  metadata:
+    name: openebs-hostpath
+    annotations:
+      openebs.io/cas-type: local
+      cas.openebs.io/config: |
+        - name: StorageType
+          value: "hostpath"
+        - name: NodeAffinityLabel
+          value: "openebs.io/custom-node-id"
+  provisioner: openebs.io/local
+  volumeBindingMode: WaitForFirstConsumer
+  reclaimPolicy: Delete
+  ```
+  This will help with use cases like:
+  - Deployments where `kubenetes.io/hostname` is not unique across the cluster (Ref: https://github.com/openebs/openebs/issues/2875)
+  - Deployments, where an existing Kubernetes node in the cluster running Local volumes is replaced with a new node, and storage attached to the old node, is moved to a new node. Without this feature, the Pods using the older node will remain in the pending state.  
+- Added a configuration option to the Jiva volume provisioner to skip adding replica node affinity. This will help in deployments where replica nodes are frequently replaced with new nodes causing the replica to remain in the pending state. The replica node affinity should be used in cases where replica nodes are not replaced with new nodes or the new node comes back with the same node-affinity label. (Ref: https://github.com/openebs/openebs/issues/3226). The node affinity for jiva volumes can be skipped by specifying the following ENV variable in the OpenEBS Provisioner Deployment. 
+   ```
+        - name: OPENEBS_IO_JIVA_PATCH_NODE_AFFINITY
+          value: "disabled"
+   ```
+- Enhanced OpenEBS Velero plugin (cStor) to automatically set the target IP once the cStor volumes is restored from a backup.  (Ref: https://github.com/openebs/velero-plugin/pull/131). This feature can be enabled by updating the VolumeSnapshotLocal using `configuration option autoSetTargetIP` as follows:
+  ```
+  apiVersion: velero.io/v1
+  kind: VolumeSnapshotLocation
+  metadata:
+    ...
+  spec:
+    config:
+      ...
+      ...
+      autoSetTargetIP: "true"
+  ```
+  (Huge thanks to @zlymeda for working on this feature which involved co-ordinating this fix across multiple repositories).
+- Enhanced the OpenEBS Velero plugin used to automatically create the target namespace during restore, if the target namespace doesn't exist. (Ref: https://github.com/openebs/velero-plugin/issues/137).
+- Enhanced the OpenEBS helm chart to support Image pull secrets. https://github.com/openebs/charts/pull/174
+- Enhance OpenEBS helm chart to allow specifying resource limits on OpenEBS control plane pods. https://github.com/openebs/charts/issues/151
+- Enhanced the NDM filters to support discovering LVM devices both with `/dev/dm-X` and `/dev/mapper/x` patterns. (Ref: https://github.com/openebs/openebs/issues/3310).
+
+### Key Bug Fixes
+
+- Fixed an issue that was causing Jiva Target to crash due to fetching stats while there was an ongoing IO. (Ref: https://github.com/openebs/jiva/pull/334). 
+- Fixed an issue where Jiva volumes failed to start if PodSecurityPolicies were setup. (Ref: https://github.com/openebs/openebs/issues/3305). 
+- Fixed an issue where helm chart `--dry-run` would fail due to admission webhook checks. (Ref: https://github.com/openebs/maya/issues/1771). 
+- Fixed an issue where NDM would fail to discover block devices on encountering an issue with block device, even if there were other good devices on the node. (Ref: https://github.com/openebs/openebs/issues/3051).
+- Fixed an issue where NDM failed to detect OS disk on `cos` nodes, where the root partition entry was set as `root=/dev/dm-0`. (Ref: https://github.com/openebs/node-disk-manager/pull/516). 
+
+### Backward Incompatibilities
+
+- Velero has updated the configuration for specifying a different node selector during restore. The configuration changes from `velero.io/change-pvc-node` to `velero.io/change-pvc-node-selector`. ( Ref: https://github.com/openebs/velero-plugin/pull/139)
+
+**Additional details:**
+- [Release Notes](https://github.com/openebs/openebs/releases/tag/v2.4.0)
+- [Upgrade Steps](/docs/next/upgrade.html)
+
+
+<br>
+
+## 2.3.0 - Nov 15 2020
+
 ### New capabilities
 
 - ARM64 support (declared beta) for OpenEBS Data Engines - cStor, Jiva, Local PV (hostpath and device), ZFS Local PV.
@@ -38,7 +109,7 @@ sidebar_label: Releases
 
 
 **Additional details:**
-- [Release Notes](https://github.com/openebs/openebs/releases/tag/v2.2.0)
+- [Release Notes](https://github.com/openebs/openebs/releases/tag/v2.3.0)
 - [Upgrade Steps](/docs/next/upgrade.html)
 
 <br>

diff --git a/docs/ugcstor.md b/docs/ugcstor.md
@@ -1124,11 +1124,11 @@ Below table lists the storage policies supported by cStor. These policies should
 | cStor Storage Policy                                         | Mandatory | Default                                 | Purpose                                                      |
 | ------------------------------------------------------------ | --------- | --------------------------------------- | ------------------------------------------------------------ |
 | [ReplicaCount](#Replica-Count-Policy)                        | No        | 3                                       | Defines the number of cStor volume replicas                  |
-| [VolumeControllerImage](#Volume-Controller-Image-Policy)     |           | openebs/cstor-volume-mgmt:2.3.0 | Dedicated side car for command management like taking snapshots etc. Can be used to apply a specific issue or feature for the workload |
-| [VolumeTargetImage](#Volume-Target-Image-Policy)             |           | openebs/cstor-istgt:2.3.0 | iSCSI protocol stack dedicated to the workload. Can be used to apply a specific issue or feature for the workload |
+| [VolumeControllerImage](#Volume-Controller-Image-Policy)     |           | openebs/cstor-volume-mgmt:2.4.0 | Dedicated side car for command management like taking snapshots etc. Can be used to apply a specific issue or feature for the workload |
+| [VolumeTargetImage](#Volume-Target-Image-Policy)             |           | openebs/cstor-istgt:2.4.0 | iSCSI protocol stack dedicated to the workload. Can be used to apply a specific issue or feature for the workload |
 | [StoragePoolClaim](#Storage-Pool-Claim-Policy)               | Yes       | N/A (a valid pool must be provided)     | The cStorPool on which the volume replicas should be provisioned |
 | [VolumeMonitor](#Volume-Monitor-Policy)                      |           | ON                                      | When ON, a volume exporter sidecar is launched to export Prometheus metrics. |
-| [VolumeMonitorImage](#Volume-Monitoring-Image-Policy)        |           | openebs/m-exporter:2.3.0        | Used when VolumeMonitor is ON. A dedicated metrics exporter to the workload. Can be used to apply a specific issue or feature for the workload |
+| [VolumeMonitorImage](#Volume-Monitoring-Image-Policy)        |           | openebs/m-exporter:2.4.0        | Used when VolumeMonitor is ON. A dedicated metrics exporter to the workload. Can be used to apply a specific issue or feature for the workload |
 | [FSType](#Volume-File-System-Type-Policy)                    |           | ext4                                    | Specifies the filesystem that the volume should be formatted with. Other values are `xfs` |
 | [TargetNodeSelector](#Target-NodeSelector-Policy)            |           | Decided by Kubernetes scheduler         | Specify the label in `key: value` format to notify Kubernetes scheduler to schedule cStor target pod on the nodes that match label |
 | [TargetResourceLimits](#Target-ResourceLimits-Policy)        |           | Decided by Kubernetes scheduler         | CPU and Memory limits to cStor target pod                    |
@@ -1192,7 +1192,7 @@ metadata:
   annotations:
     cas.openebs.io/config: |
       - name: VolumeControllerImage
-        value: openebs/cstor-volume-mgmt:2.3.0
+        value: openebs/cstor-volume-mgmt:2.4.0
       - name: StoragePoolClaim
         value: "cstor-disk-pool"
     openebs.io/cas-type: cstor
@@ -1211,7 +1211,7 @@ metadata:
   annotations:
     cas.openebs.io/config: |
       - name: VolumeTargetImage
-        value:openebs/cstor-istgt:2.3.0
+        value:openebs/cstor-istgt:2.4.0
       - name: StoragePoolClaim
         value: "cstor-disk-pool"
     openebs.io/cas-type: cstor
@@ -1249,7 +1249,7 @@ metadata:
   annotations:
     cas.openebs.io/config: |
       - name: VolumeMonitorImage
-        value: openebs/m-exporter:2.3.0
+        value: openebs/m-exporter:2.4.0
       - name: StoragePoolClaim
         value: "cstor-sparse-pool"
     openebs.io/cas-type: cstor

diff --git a/docs/upgrade.md b/docs/upgrade.md
@@ -5,7 +5,7 @@ sidebar_label: Upgrade
 ---
 ------
 
-Latest stable version of OpenEBS is 2.3.0. Check the release notes [here](https://github.com/openebs/openebs/releases/tag/v2.3.0).  Upgrade to the latest OpenEBS 2.3.0 version is supported only from 1.0.0 and later. The steps for upgrading from these versions can be found [here](https://github.com/openebs/openebs/blob/master/k8s/upgrades/README.md).
+Latest stable version of OpenEBS is 2.4.0. Check the release notes [here](https://github.com/openebs/openebs/releases/tag/v2.4.0).  Upgrade to the latest OpenEBS 2.4.0 version is supported only from 1.0.0 and later. The steps for upgrading from these versions can be found [here](https://github.com/openebs/openebs/blob/master/k8s/upgrades/README.md).
 
 Note: If you are upgrading Jiva volumes that are running in version 1.6 and 1.7, you must use these [pre-upgrade steps](https://github.com/openebs/charts/tree/gh-pages/scripts/jiva-tools) to check if your jiva volumes are impacted by [#2956](https://github.com/openebs/openebs/issues/2956). If they are, please reach out to [OpenEBS Community](/docs/next/support.html) for helping you with the upgrade.
 

diff --git a/hack/update_release.sh b/hack/update_release.sh
@@ -17,8 +17,8 @@
 update_doc()
 {
   FILE=$1
-  sed -i 's/(\/docs\//(\/v200\/docs\//' ${FILE}
-  sed -i 's/"\/docs\//"\/v200\/docs\//' ${FILE}
+  sed -i '' -e 's/(\/docs\//(\/v230\/docs\//' ${FILE}
+  sed -i '' -e 's/"\/docs\//"\/v230\/docs\//' ${FILE}
   FILE=""
 }
 

diff --git a/website/versions.json b/website/versions.json
@@ -1,6 +1,7 @@
 {
   "versions": {
-      "2.3.0": ["v2.3.0", "https://docs.openebs.io/"],
+      "2.4.0": ["v2.4.0", "https://docs.openebs.io/"],
+      "2.3.0": ["v2.3.0", "https://docs.openebs.io/v230/"],
       "2.2.0": ["v2.2.0", "https://docs.openebs.io/v220/"],
       "2.1.0": ["v2.1.0", "https://docs.openebs.io/v210/"],
       "2.0.0": ["v2.0.0", "https://docs.openebs.io/v200/"],
-Original file line number
+Diff line change
@@ Expand Up / @@ -5,7 +5,7 @@ sidebar_label: Upgrade @@
     ---
     ------
-    Latest stable version of OpenEBS is 2.3.0. Check the release notes [here](https://github.com/openebs/openebs/releases/tag/v2.3.0).  Upgrade to the latest OpenEBS 2.3.0 version is supported only from 1.0.0 and later. The steps for upgrading from these versions can be found [here](https://github.com/openebs/openebs/blob/master/k8s/upgrades/README.md).
+    Latest stable version of OpenEBS is 2.4.0. Check the release notes [here](https://github.com/openebs/openebs/releases/tag/v2.4.0).  Upgrade to the latest OpenEBS 2.4.0 version is supported only from 1.0.0 and later. The steps for upgrading from these versions can be found [here](https://github.com/openebs/openebs/blob/master/k8s/upgrades/README.md).
     Note: If you are upgrading Jiva volumes that are running in version 1.6 and 1.7, you must use these [pre-upgrade steps](https://github.com/openebs/charts/tree/gh-pages/scripts/jiva-tools) to check if your jiva volumes are impacted by [#2956](https://github.com/openebs/openebs/issues/2956). If they are, please reach out to [OpenEBS Community](/docs/next/support.html) for helping you with the upgrade.
@@ Expand Down @@