2.9 release updates (#938)

- Updated docs to reflect new engines that have been added recently - Updated Alpha features - References to 2.9.0 and links to previous doc snapshots - Update the minimum required K8s to 1.18 - Replaced references to fields in the sample outputs with `...`, to avoid the need to update the version numbers on every release Signed-off-by: kmova <[email protected]>
openebs-archive · May 16, 2021 · 23fd281 · 23fd281
1 parent 1489bf8
commit 23fd281
Show file tree

Hide file tree

Showing 13 changed files with 309 additions and 202 deletions.
diff --git a/docs/alphafeatures.md b/docs/alphafeatures.md
@@ -10,19 +10,20 @@ sidebar_label: Alpha Features
 This page provides an overview of OpenEBS components and features presently in Alpha version and under active development. These features are not recommended to be used in production. We suggest you to familiarize and try these features on test clusters and reach out to [OpenEBS Community](/docs/next/support.html) if you have any queries, feedback or need help on these features.
 
 The list of alpha features include:
-- [Dynamic Local PV - Rawfile](#dynamic-local-pv-rawfile)
+- [CSI Driver for Local PV - Device](#csi-driver-for-local-pv-device)
 - [Dynamic NFS Provisioner](#dynamic-nfs-provisioner)
-- [Dynamic Local PV - LVM](#dynamic-local-pv-lvm)
+- [OpenEBS CLI](#openebs-cli)
+- [OpenEBS Monitoring Add-on](#openebs-monitoring-add-on)
 
   :::note
   Upgrade is not supported for features in Alpha version.
   :::
 
-## Dynamic Local PV - Rawfile
+## CSI Driver for Local PV - Device
 
-OpenEBS is developing a CSI driver for provisioning Local PVs that are backed by hostpath. 
+OpenEBS is developing a CSI driver for provisioning Local PVs that are backed by block devices. 
 
-For additional details and detailed instructions on how to get started with OpenEBS Local PV - Rawfile please refer this [Quickstart guide](https://github.com/openebs/rawfile-localpv).
+For additional details and detailed instructions on how to get started with OpenEBS Local PV - Device CSI Driver please refer this [Quickstart guide](https://github.com/openebs/device-localpv).
 
 <hr>
 
@@ -34,11 +35,19 @@ For additional details and detailed instructions on how to get started with Open
 
 <hr>
 
-## Dynamic Local PV - LVM
+## OpenEBS CLI
 
-OpenEBS is developing a CSI driver for provisioning Local PVs that are backed by LVM. 
+OpenEBS is developing a kubectl plugin for openebs called `openebsctl` that can help perform administrative tasks on OpenEBS volumes and pools. 
 
-For additional details and detailed instructions on how to get started with OpenEBS Local PV - LVM please refer this [Quickstart guide](https://github.com/openebs/lvm-localpv).
+For additional details and detailed instructions on how to get started with OpenEBS CLI please refer this [Quickstart guide](https://github.com/openebs/openebsctl).
+
+<hr>
+
+## OpenEBS Monitoring Add-on
+
+OpenEBS is developing a monitoring add-on package that can be installed via helm or kubectl for setting up a default prometheus, grafana and alert manager stack. The package also will include default service monitors, dashboards and alert rules. 
+
+For additional details and detailed instructions on how to get started with OpenEBS Monitoring Add-on please refer this [Quickstart guide](https://github.com/openebs/monitoring).
 
 <hr>
 

diff --git a/docs/installation.md b/docs/installation.md
@@ -420,7 +420,7 @@ As a next step [verify](#verifying-openebs-installation) your installation and d
 
 **Verify pods:**
 
-List the pods in `<openebs>` name space 
+List the pods in `<openebs>` namespace 
 
 ```
 kubectl get pods -n openebs
@@ -445,8 +445,6 @@ openebs-snapshot-operator-5bdcdc9b77-v7n4w     2/2     Running   0          97s
 
 The control plane pods `openebs-provisioner`, `maya-apiserver` and `openebs-snapshot-operator` should be running. If you have configured nodeSelectors , check if they are scheduled on the appropriate nodes by listing the pods through `kubectl get pods -n openebs -o wide`
 
-> The resiliency of the control plane can be verified via `litmus` using <a href="https://docs.litmuschaos.io/docs/next/openebs-control-plane-chaos/"> openebs-control-plane-chaos </a> experiment.
-  
 
 **Verify StorageClasses:**
 
@@ -593,19 +591,16 @@ First, label the required nodes with an appropriate label. In the following comm
 kubectl label nodes <node-name> node=openebs
 ```
 
-Find `apiServer`, `provisioner`, `snapshotOperator`, `admission-server` and `ndm` sections in `values.yaml`and update `nodeSelector` key. Example of the updated provisioner section in the following snippet where `node:openebs` is the `nodeSelector` label.
+Find `apiServer`, `provisioner`, `snapshotOperator`, `admission-server` and `ndm` sections in `values.yaml` and update `nodeSelector` key. Example of the updated `nodeSelector` section for `provisioner` with value of `node:openebs` would be as follows:
 
 ```
 provisioner:
-  image: "openebs/openebs-k8s-provisioner"
-  imageTag: "2.7.0"
-  replicas: 1
-  nodeSelector: {}
-  tolerations: []
-  affinity: {}
-  healthCheck:
-    initialDelaySeconds: 30
-    periodSeconds: 60
+  ...
+  ...
+  nodeSelector: 
+    node: openebs
+  ...
+  ...
 ```
 
 
@@ -615,22 +610,14 @@ In the `values.yaml`, find`ndm` section to update `excludeVendors:` and `exclude
 
 ```
 ndm:
-  image: "openebs/node-disk-manager"
-  imageTag: "1.3.0"
-  sparse:
-    path: "/var/openebs/sparse"
-    size: "10737418240"
-    count: "1"
+  ...
+  ...
   filters:
     excludeVendors: "CLOUDBYT,OpenEBS"
     includePaths: ""
     excludePaths: "loop,fd0,sr0,/dev/ram,/dev/dm-,/dev/md"
-  probes:
-    enableSeachest: false
-  nodeSelector: {}
-  healthCheck:
-    initialDelaySeconds: 30
-    periodSeconds: 60
+  ...
+  ...
 ```
 
 

diff --git a/docs/jivaguide.md b/docs/jivaguide.md
@@ -5,6 +5,10 @@ sidebar_label: Jiva
 ---
 ------
 
+   :::note 
+   The recommended approach to provision Jiva volumes is via CSI Driver. For detailed instructions on how to get started with new Jiva CSI Driver please refer to the [Quickstart guide on Github](https://github.com/openebs/jiva-operator).
+   :::
+
 <br>
 
 <img src="/docs/assets/svg/6-config-sequence.svg" alt="OpenEBS configuration flow" style="width:100%">
@@ -573,11 +577,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.7.0 | To use particular Jiva replica image                         |
-| [ControllerImage](#Controller-Image-Policy)                  |           | openebs/jiva:2.7.0         | To use particular Jiva Controller Image                      |
+| [Replica Image](#Replica-Image-Policy)                       |           | openebs/m-apiserver:2.9.0 | To use particular Jiva replica image                         |
+| [ControllerImage](#Controller-Image-Policy)                  |           | openebs/jiva:2.9.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.7.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.9.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 +627,7 @@ metadata:
     openebs.io/cas-type: jiva
     cas.openebs.io/config: |
       - name: ReplicaImage
-        value: openebs/m-apiserver:2.7.0
+        value: openebs/m-apiserver:2.9.0
 provisioner: openebs.io/provisioner-iscsi
 ```
 
@@ -640,7 +644,7 @@ metadata:
     openebs.io/cas-type: jiva
     cas.openebs.io/config: |
       - name: ControllerImage
-        value: openebs/jiva:2.7.0
+        value: openebs/jiva:2.9.0
 provisioner: openebs.io/provisioner-iscsi
 ```
 
@@ -729,7 +733,7 @@ metadata:
     openebs.io/cas-type: jiva
     cas.openebs.io/config: |
       - name: VolumeMonitorImage
-        value: openebs/m-exporter:2.7.0
+        value: openebs/m-exporter:2.9.0
 provisioner: openebs.io/provisioner-iscsi
 ```
 

diff --git a/docs/localpv.md b/docs/localpv.md
@@ -25,7 +25,7 @@ Examples of good workloads that can benefit from local volumes are:
 OpenEBS helps users to take local volumes into production by providing features that are currently missing in Kubernetes like:
 
 - Dynamic PV Provisioners for local volumes.
-- Local Volumes backed by hostpath on filesystems like Ext3, XFS or ZFS.
+- Local Volumes backed by hostpath on filesystems like Ext3, XFS, LVM or ZFS.
 - Monitoring the health of underlying devices or storage used to create Local Volumes. 
 - Capacity management features like over-provisioning and/or quota enforcement. 
 - Make use of the underlying storage capabilities like snapshot, clone, compression and so forth when local volumes are backed by advanced filesystem like ZFS. 
@@ -38,6 +38,9 @@ OpenEBS provides different types of Local Volumes that can be used to provide lo
 
 - [OpeneBS Local PV using Hostpath](/docs/next/uglocalpv-hostpath.html)
 - [OpeneBS Local PV using Block Devices](/docs/next/uglocalpv-device.html)
+- <a href="https://github.com/openebs/lvm-localpv" target="_blank">OpenEBS Local PV using LVM </a>
+- <a href="https://github.com/openebs/zfs-localpv" target="_blank">OpenEBS Local PV using ZFS </a>
+- <a href="https://github.com/openebs/rawfile-localpv" target="_blank">OpenEBS Local PV using Rawfile (sparse file) </a>
 
 
 ## When to use OpenEBS Local PVs