Update README for release (#78)

Signed-off-by: Harsh Vardhan <[email protected]>

Author: Harsh Vardhan

README.md

@@ -1,6 +1,6 @@
 <img width="300" align="right" alt="OpenEBS Logo" src="https://raw.githubusercontent.com/cncf/artwork/master/projects/openebs/stacked/color/openebs-stacked-color.png" xmlns="http://www.w3.org/1999/html">
 
-## OpenEBSCTL
+# OpenEBSCTL
 
 
 [![Go Report Card](https://goreportcard.com/badge/github.com/openebs/openebsctl?)](https://goreportcard.com/report/github.com/openebs/openebsctl)
@@ -15,12 +15,12 @@
 OpenEBSCTL is a kubectl plugin to manage OpenEBS storage components.
 
 
-### Project Status
+## Project Status
 
 **Alpha**. Under active development and seeking [contributions from the community](#contributing).
 The CLI currently supports managing `cStor`, `Jiva`, `LocalPV-LVM`, `LocalPV-ZFS` Cas-Engines.
 
-### Table of Contents
+## Table of Contents
 * [Installation](#installation)
 * [Build](#build)
 * [Flags](#flags)
@@ -36,43 +36,44 @@ The CLI currently supports managing `cStor`, `Jiva`, `LocalPV-LVM`, `LocalPV-ZFS
   * [LocalPV-LVM](#localpv-lvm)
     * [Get LocalPV-LVM volumes](#get-localpv-lvm-volumes)
     * [Get LocalPV-LVM VolumeGroups](#get-localpv-lvm-volumegroups)
+    * [Describe LocalPV-LVM volumeGroups](#describe-localpv-lvm-volumeGroups)
+    * [Describe LocalPV-LVM volumes](#describe-localpv-lvm-volumes)
   * [LocalPV-ZFS](#localpv-zfs)
     * [Get LocalPV-ZFS volumes](#get-localpv-zfs-volumes)
     * [Get LocalPV-ZFS Pools](#get-localpv-zfs-pools)
+    * [Describe LocalPV-ZFS volumes](#describe-localpv-zfs-volumes)
+    * [Describe LocalPV-ZFS pools](#describe-localpv-zfs-pools)
   * [BlockDevice](#blockdevice)
     * [Get BlockDevices by Nodes](#get-blockdevices-by-nodes)
   * [PersistentVolumeClaims](#persistentvolumeclaims)
     * [Describe pvcs](#describe-pvcs)
+    * [Debugging pvcs](#debugging-pvcs)
 * [Contributing](#contributing)
 
 
-### Installation
+## Installation
 
 OpenEBSCTL is available on Linux, macOS and Windows platforms.
 
+* (**Recommended**) The latest binary can be installed via `krew`
+```bash
+$ kubectl krew install openebs
+...
+...
+$ kubectl krew list
+PLUGIN    VERSION
+openebs    v0.2.0
+...
+...
+# to update the openebs plugin
+$ kubectl krew upgrade openebs
+...
+...
+```
+
 * Binaries for Linux, Mac and Windows are available as tarballs and zip in the [release](https://github.com/openebs/openebsctl/releases) page.
-* For Linux, download the respective tarball from [release](https://github.com/openebs/openebsctl/releases) page and :-
-   ```shell
-   tar -xvf kubectl-openebs_v0.2.0_Linux_x86_64.tar.gz
-   cd kubectl-openebs_v0.2.0_Linux_x86_64
-   sudo mv kubectl-openebs /usr/local/bin/
-   ```
-  Or, download the `debian` package from the [release](https://github.com/openebs/openebsctl/releases) page and double click it launch the installer if using GUI.<br/><br/>
-  Or, we can also use script to install the latest version :-
-   ```shell
-   wget https://raw.githubusercontent.com/openebs/openebsctl/develop/scripts/install-latest.sh -O - | bash
-   ```
-* For Mac, download the respective tarball from [release](https://github.com/openebs/openebsctl/releases) page and :-
-  ```shell
-   tar -xzvf kubectl-openebs_v0.2.0_Darwin_x86_64.tar.gz
-   cd kubectl-openebs_v0.2.0_Darwin_x86_64
-   sudo mv kubectl-openebs /usr/local/bin/
-   ```
-* For Windows, download the respective zip from [release](https://github.com/openebs/openebsctl/releases) page and :-
-    - Extract the zip, copy the `path` of the folder the contents are in.
-    - Add the `path` to the `PATH` environment variable.
 
-### Build
+## Build
 
 - Clone this repo to your system. `git clone https://github.com/openebs/openebsctl`
 - `cd openebsctl`
@@ -107,7 +108,7 @@ OpenEBSCTL is available on Linux, macOS and Windows platforms.
   * #### Describe `cStor` volumes
     ```bash
     $ kubectl openebs describe volume pvc-193844d7-3bef-45a3-8b7d-ed3991391b45
-  
+
     pvc-193844d7-3bef-45a3-8b7d-ed3991391b45 Details :
     -----------------
     NAME            : pvc-193844d7-3bef-45a3-8b7d-ed3991391b45
@@ -223,11 +224,50 @@ OpenEBSCTL is available on Linux, macOS and Windows platforms.
     $ kubectl openebs get storage --cas-type=lvmlocalpv
     NAME         FREESIZE   TOTALSIZE
     worker-sh1              
-    └─lvmvg      1018 GiB   1024 GiB
+    └─lvmvg      1020 GiB   1024 GiB
     
     worker-sh2              
     └─lvmvg-1    46.7 GiB   50 GiB
     ```
+  * #### Describe `LocalPV-LVM` volumeGroups
+   ```bash
+   $ kubectl openebs describe storage worker-sh1
+    worker-sh1 Details :
+
+    HOSTNAME        : worker-sh1
+    NAMESPACE       : openebs
+    NUMBER OF POOLS : 1
+    TOTAL CAPACITY  : 1024.0GiB
+    TOTAL FREE      : 1020.0GiB
+    TOTAL LVs       : 1
+    TOTAL PVs       : 1
+
+    Volume group details
+    ---------------------
+    NAME    UUID                                     LV COUNT   PV COUNT   USED PERCENTAGE
+    lvmvg   IgnC8K-OJaA-WBx6-JLYz-HQU3-W8kb-0LHbXy   1          1          0.4%
+   ```
+  * #### Describe `LocalPV-LVM` volume
+  ```bash
+  $ kubectl openebs describe vol pvc-9999274f-ad01-48bc-9b21-7c51b47a870c
+
+    pvc-9999274f-ad01-48bc-9b21-7c51b47a870c Details :
+    ------------------
+    Name            : pvc-9999274f-ad01-48bc-9b21-7c51b47a870c
+    Namespace       : openebs
+    AccessMode      : ReadWriteOnce
+    CSIDriver       : local.csi.openebs.io
+    Capacity        : 4Gi
+    PVC             : csi-lvmpv
+    VolumePhase     : Bound
+    StorageClass    : openebs-lvmpv
+    Version         : ci
+    Status          : Ready
+    VolumeGroup     : lvmvg
+    Shared          : no
+    ThinProvisioned : no
+    NodeID          : worker-sh1
+  ```
 * #### `LocalPV-ZFS`
   * #### Get `LocalPV-ZFS` volumes
     ```bash
@@ -246,6 +286,41 @@ OpenEBSCTL is available on Linux, macOS and Windows platforms.
     node2         
     └─zfs-test-pool   36 GiB
     ```
+  * #### Describe `LocalPV-ZFS volumes`
+    ```bash
+    $ kubectl openebs describe vol pvc-43fcbc72-a45a-49d5-9ec3-e383fcb91452
+
+    pvc-43fcbc72-a45a-49d5-9ec3-e383fcb91452 Details :
+    -----------------
+    Name          : pvc-43fcbc72-a45a-49d5-9ec3-e383fcb91452
+    Namespace     : openebs
+    AccessMode    : ReadWriteOnce
+    CSIDriver     : zfs.csi.openebs.io
+    Capacity      : 4Gi
+    PVC           : csi-zfspv
+    VolumePhase   : Bound
+    StorageClass  : openebs-zfspv
+    Version       : N/A
+    Status        : Ready
+    VolumeType    : DATASET
+    PoolName      : zfspv-pool
+    FileSystem    : zfs
+    Compression   : off
+    Deduplication : off
+    NodeID        : worker-sh1
+    Recordsize    : 4k
+    ```
+  * #### Describe `LocalPV-ZFS pools`
+    ```bash
+    $ kubectl openebs describe storage node2
+  
+     node2 Details :
+  
+     HOSTNAME        : node2
+     NAMESPACE       : openebs
+     NUMBER OF POOLS : 1
+     TOTAL FREE      : 32 GiB
+    ```
 * #### `BlockDevice`
   * #### Get `BlockDevices` by Nodes
     ```bash
@@ -302,6 +377,12 @@ OpenEBSCTL is available on Linux, macOS and Windows platforms.
     VERSION       : 2.1.0
     UPGRADING     : true
     ```
+  * #### Debugging pvcs
+    _currently supported only for cstor_
+    ```bash
+    $ kubectl openebs describe pvc mongo --openebs-namespace=openebs --debug
+    ```
+    ![img.png](docs/img.png)
 
 ### Contributing
 
@@ -325,4 +406,4 @@ For more details checkout [CONTRIBUTING.md](./CONTRIBUTING.md).
 
 
 ## License
-[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fopenebs%2Fopenebsctl.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fopenebs%2Fopenebsctl?ref=badge_large)
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fopenebs%2Fopenebsctl.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fopenebs%2Fopenebsctl?ref=badge_large)