docs: added the glossary of terms page

Signed-off-by: Bala Harish <[email protected]>
openebs · Apr 12, 2024 · 626c302 · 626c302
1 parent 32aa27a
commit 626c302
Show file tree

Hide file tree

Showing 6 changed files with 54 additions and 91 deletions.
diff --git a/docs/main/glossary.md b/docs/main/glossary.md
@@ -0,0 +1,42 @@
+---
+id: glossary
+title: Glossary of Terms
+keywords:
+  - Community
+  - OpenEBS community
+description: This section lists the abbreviations used thorughout the OpenEBS documentation
+---
+
+| Abbreviations | Definition | 
+| :--- | :--- | 
+
+| AKS |	Azure Kubernetes Service |
+| CLI |	Command Line Interface |
+| CNCF | Cloud Native Computing Foundation |
+| CNS |	Container Native Storage |
+| COS |	Container Orchestration Systems |
+| COW |	Copy-On-Write |
+| CR | Custom Resource |
+| CRDs | Custom Resource Definitions |
+| CSI |	Container Storage Interface |
+| EKS |	Elastic Kubernetes Service |
+| FIO |	Flexible IO Tester |
+| FSB |	File System Backup |
+| GCS |	Google Cloud Storage |
+| GKE |	Google Kubernetes Engine |
+| HA | High Availability |
+| LVM |	Logical Volume Management |
+| NATS | Neural Autonomic Transport System |
+| NFS |	Network File System |
+| NVMe | Non-Volatile Memory Express |
+| NVMe-oF |	Non-Volatile Memory Express over Fabrics |
+| OpenEBS |	Open Elastic Block Store |
+| PV | Persistent Volume |
+| PVC |	Persistent Volume Claim |
+| RBAC | Role-Based Access Control |
+| SPDK | Storage Performance Development Kit |
+| SRE |	Site Reliability Engineering |
+| TCP |	Transmission Control Protocol |
+| VG | Volume Group |
+| YAML | Yet Another Markup Language |
+| ZFS |	Zettabyte File System |
diff --git a/docs/main/introduction-to-openebs/features.mdx b/docs/main/introduction-to-openebs/features.mdx
@@ -65,7 +65,7 @@ OpenEBS Features, like any storage solution, can be broadly classified into the
 
 <TwoColumn left="1fr" right="200px">
   <p>
-    The backup and restore of OpenEBS volumes works with Kubernetes backup and restore solutions such as Velero (f.k.a Heptio Ark) via open source OpenEBS Velero-plugins. Data backup to object storage targets such as AWS S3, GCP Object Storage or MinIO are frequently deployed using the OpenEBS incremental snapshot capability. This storage level snapshot and backup saves a significant amount of bandwidth and storage space as only incremental data is used for backup.
+    The backup and restore of OpenEBS volumes works with Kubernetes backup and restore solutions such as Velero via open source OpenEBS Velero-plugins. Data backup to object storage targets such as AWS S3, GCP Object Storage or MinIO are frequently deployed using the OpenEBS incremental snapshot capability. This storage level snapshot and backup saves a significant amount of bandwidth and storage space as only incremental data is used for backup.
   </p>
 
 ![Backup and Restore Icon](../assets/f-backup.svg)

diff --git a/docs/main/introduction-to-openebs/introduction-to-openebs.md b/docs/main/introduction-to-openebs/introduction-to-openebs.md
@@ -22,7 +22,7 @@ The [OpenEBS Adoption stories](https://github.com/openebs/openebs/blob/master/AD
 
 - OpenEBS provides consistency across all Kubernetes distributions - On-premise and Cloud.
 - OpenEBS with Kubernetes increases Developer and Platform SRE Productivity.
-- OpenEBS is Easy to use compared to other solutions, for eg trivial to install and enabling entirely dynamic provisioning.
+- OpenEBS scores in its ease of use over other solutions. It is trivial to setup, install and configure.
 - OpenEBS has Excellent Community Support.
 - OpenEBS is completely Open Source and Free.
 

diff --git a/docs/main/troubleshooting/troubleshooting-local-storage.md b/docs/main/troubleshooting/troubleshooting-local-storage.md
@@ -20,95 +20,6 @@ The default localpv storage classes from openebs have `volumeBindingMode: WaitFo
 **Resolution:**
 Deploy an application that uses the PVC and the PV will be created and application will start using the PV.
 
-### Stale BDC in pending state after PVC is deleted {#stale-bdc-after-pvc-deletion}
-
-```
-kubectl get bdc -n openebs
-```
-
-shows stale `Pending` BDCs created by localpv provisioner, even after the corresponding PVC has been deleted.
-
-**Resolution:**
-LocalPV provisioner currently does not delete BDCs in Pending state if the corresponding PVCs are deleted. To remove the stale BDC entries:
-
-1. Edit the BDC and remove the `- local.openebs.io/finalizer` finalizer.
-
-```
-kubectl edit bdc <bdc-name> -n openebs
-```
-
-2. Delete the BDC.
-
-```
-kubectl delete bdc <bdc-name> -n openebs
-```
-
-### BDC created by localPV in pending state {#bdc-by-localpv-pending-state}
-
-The BDC created by localpv provisioner (bdc-pvc-xxxx) remains in pending state and PVC does not get Bound.
-
-**Troubleshooting:**
-Describe the BDC to check the events recorded on the resource.
-
-```
-kubectl describe bdc bdc-pvc-xxxx -n openebs
-```
-
-The following are different types of messages shown when the node on which localpv application pod is scheduled, does not have a blockdevice available.
-
-1. No blockdevices found
-
-```shell hideCopy
-Warning  SelectionFailed  14m (x25 over 16m)    blockdeviceclaim-operator  no blockdevices found
-```
-
-It means that there were no matching blockdevices after listing based on the labels. Check if there is any `block-device-tag` on the storage class and corresponding tags are available on the blockdevices.
-
-2. No devices with matching criteria
-
-```shell hideCopy
-Warning  SelectionFailed  6m25s (x18 over 11m)  blockdeviceclaim-operator  no devices found matching the criteria
-```
-
-It means that the there are no devices for claiming after filtering based on filesystem type and node name. Make sure the blockdevices on the node have the correct filesystem as mentioned in the storage class (default is `ext4`).
-
-3. No devices with matching resource requirements
-
-```shell hideCopy
-Warning  SelectionFailed  85s (x74 over 11m)    blockdeviceclaim-operator  could not find a device with matching resource requirements
-```
-
-It means that there are no devices available on the node with a matching capacity requirement.
-
-**Resolution**
-
-To schedule the application pod to a node, which has the blockdevices available, a node selector can be used on the application pod. Here the node with hostname `svc1` has blockdevices available, so a node selector is used to schedule the pod to that node.
-
-Example:
-
-```
-apiVersion: v1
-kind: Pod
-metadata:
-  name: pod1
-spec:
-  volumes:
-    - name: local-storage
-      persistentVolumeClaim:
-        claimName: pvc1
-  containers:
-    - name: hello-container
-      image: busybox
-      command:
-        - sh
-        - -c
-        - 'while true; do echo "`date` [`hostname`] Hello from OpenEBS Local PV." >> /mnt/store/greet.txt; sleep $(($RANDOM % 5 + 300)); done'
-      volumeMounts:
-        - mountPath: /mnt/store
-          name: local-storage
-  nodeSelector:
-    kubernetes.io/hostname: svc1
-```
 
 <font size="6" color="orange">Installation Related</font>
 

diff --git a/...ain/user-guides/replicated-storage-user-guide/advanced-operations/monitoring.md b/...ain/user-guides/replicated-storage-user-guide/advanced-operations/monitoring.md
@@ -109,6 +109,8 @@ This feature exports performace stats for Volume, Replica and DiskPool resource.
 
 With this change, the exporter calls to the IO engine for stats tied to the frequency of Prometheus poll cycle.
 
+With this change, the exporter will query the IO engine for stats related to the frequency of Prometheus poll cycle.
+
 :::important
 Users are recommended to have Prometheus poll interval not less then 5 minutes.
 :::

diff --git a/docs/sidebars.js b/docs/sidebars.js
@@ -591,6 +591,14 @@ module.exports = {
       customProps: {
         icon: "HelpCircle"
       },
+    },
+    {
+      type: "doc",
+      id: "glossary",
+      label: "Glossary",
+      customProps: {
+        icon: "HelpCircle"
+      },
     }
   ]
 }