Merge pull request openebs#189 from rakeshPRaghu/importAdditionalInfo

(docs) : importing additional info from docs.openebs.io (2.11.0)
survivant · Aug 4, 2021 · ddf46d5 · ddf46d5
2 parents c01ca62 + 857168e
commit ddf46d5
Show file tree

Hide file tree

Showing 10 changed files with 2,650 additions and 2 deletions.
diff --git a/docs/i18n/en/docusaurus-plugin-content-docs/version-2.11.0.json b/docs/i18n/en/docusaurus-plugin-content-docs/version-2.11.0.json
@@ -14,5 +14,9 @@
   "sidebar.docs.category.Troubleshooting": {
     "message": "Troubleshooting",
     "description": "The label for category Troubleshooting in sidebar docs"
+  },
+  "sidebar.docs.category.Additional info": {
+    "message": "Additional info",
+    "description": "The label for category Additional info in sidebar docs"
   }
 }
diff --git a/docs/src/theme/DocPage/styles.module.scss b/docs/src/theme/DocPage/styles.module.scss
@@ -67,11 +67,11 @@
   }
 
   .docPage {
-    grid-template-columns: var(--doc-sidebar-width) 1fr;
+    grid-template-columns: var(--doc-sidebar-width) minmax(0, 1fr);
   }
 
   .colMainContent {
-    width: calc(100vw - var(--doc-sidebar-width));
+    width: auto;
   }
 
   .docMainContainerEnhanced {

diff --git a/docs/versioned_docs/version-2.11.0/additional-info/alphafeatures.md b/docs/versioned_docs/version-2.11.0/additional-info/alphafeatures.md
@@ -0,0 +1,41 @@
+---
+id: alphafeatures
+title: 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](/introduction/community) if you have any queries, feedback or need help on these features.
+
+The list of alpha features include:
+- [CSI Driver for Local PV - Device](#csi-driver-for-local-pv-device)
+- [Dynamic NFS Provisioner](#dynamic-nfs-provisioner)
+- [OpenEBS CLI](#openebs-cli)
+- [OpenEBS Monitoring Add-on](#openebs-monitoring-add-on)
+
+:::note
+Upgrade is not supported for features in Alpha version.
+:::
+
+## CSI Driver for Local PV - Device
+
+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 - Device CSI Driver please refer this [Quickstart guide](https://github.com/openebs/device-localpv).
+
+
+## Dynamic NFS Provisioner
+
+OpenEBS is developing a dynamic NFS PV provisioner that can setup a new NFS server on top of any block storage. 
+
+For additional details and detailed instructions on how to get started with OpenEBS NFS PV provisioner please refer this [Quickstart guide](https://github.com/openebs/dynamic-nfs-provisioner).
+
+## OpenEBS CLI
+
+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 CLI please refer this [Quickstart guide](https://github.com/openebs/openebsctl).
+
+## 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).
diff --git a/docs/versioned_docs/version-2.11.0/additional-info/faq.md b/docs/versioned_docs/version-2.11.0/additional-info/faq.md
diff --git a/docs/versioned_docs/version-2.11.0/additional-info/k8supgrades.md b/docs/versioned_docs/version-2.11.0/additional-info/k8supgrades.md
@@ -0,0 +1,20 @@
+---
+id: k8supgrades
+title: Best practices to follow when upgrading Kubernetes
+sidebar_label: Kubernetes upgrades
+---
+
+There are few reasons why nodes in a Kubernetes cluster get  rebooted
+
+- Kubernetes upgrades do need to happen to new features that roll out and to get minimum requirements satisfied for the applications upgrade running on Kubernetes. The upgrade process of Kubernetes cluster involves upgrading the nodes one by one. This process may involve rebooting of the nodes of the cluster.
+- Kubernetes nodes go through hardware changes
+
+### Volume replica quorum requirement
+
+In either case, when the nodes are rebooted, the OpenEBS volume targets lose access to the replicas hosted on that node. OpenEBS volume replicas need to be in quorum for the volume to be online. When a Kubernetes node is rebooted, and the node comes back online, the rebuilding process of the volume replicas may take few minutes. If the other node is rebooted before the volume replicas are completely rebuilt, the volume replicas may loose quorum and the corresponding volumes may be marked read-only, which results in the unavailability of data to the application.
+
+It is recommended that before a Kubernetes node is rebooted, make sure all the replicas of all OpenEBS volumes are healthy/online and there is no rebuild process is ongoing.
+
+## See Also:
+
+[Seeking help](/introduction/community)