Skip to content

Commit

Permalink
doc(release): README and CHANGELOG changes for release v0.1.0 (#30)
Browse files Browse the repository at this point in the history 
Signed-off-by: Abhinandan-Purkait <abhinandan.purkait@mayadata.io>
  • Loading branch information
@Abhinandan-Purkait
Abhinandan-Purkait authored Jun 15, 2021
1 parent 61bd182 commit d459689
Show file tree
Hide file tree
Showing 2 changed files with 222 additions and 62 deletions.
36 changes: 35 additions & 1 deletion CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1 +1,35 @@
## TODO ADD CHANGELOGS MANUALLY FOR FIRST RELEASE
# Release v0.1.0
<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">

---
## Notes
OpenEBS-CTL v0.1.0 is a first feature release.<br/>
Users are encouraged to install this tool, use it and help us know what can be better.<br/>
Thank you to all that contributed with flushing out issues with OpenEBS-CTL!<br/>
You can checkout the [documentation](https://github.com/openebs/openebsctl#readme) for more information.<br/>

---
## Notable Changes
We have added support for `cStor` storage engine.<br/>
* cStor `volume` and `pools` listing commands
* cStor `volume` and `pools` describing commands
* `PersistentVolumeClaim` describe command

## What's Next
* Restructuring of code, to add supoort for other Storage Engines
* Adding support for Jiva
* Adding support for Local PV
* Adding support for Mayastor
* Adding support for managing Storage Devices
* Adding support for performing sanity checks and flagging discrepancies like listing stale volumes or over-utilized pools.
* Adding support for getting overall status (like kubectl openebs cluster-info)
* Ability to generate raise GitHub issues with required troubleshooting information.

---
## Resolved Bugs

+ [[Issue 24]](https://github.com/openebs/openebsctl/issues/24) Convert object blocks into object list
+ [[Issue 18]](https://github.com/openebs/openebsctl/issues/18) Determine openebs ns from the CLI.
+ [[Issue 15]](https://github.com/openebs/openebsctl/issues/15) Support command openebsctl pool describe
+ [[Issue 8]](https://github.com/openebs/openebsctl/issues/8) Add the ability to specify KUBECONFIG variable in openebsctl enhancement good first issue
+ [[Issue 1]](https://github.com/openebs/openebsctl/issues/1) Missed case for listing cStor volumes cStor volume command
248 changes: 187 additions & 61 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,85 +1,211 @@
## Overview

`openebsctl` is a `kubectl` plugin to manage OpenEBS storage.

## OpenEBS-CTL - Kubectl plugin to manage OpenEBS storage components !

## Project Status
OpenEBS-CTL provides a cli tool to show OpenEBS storage components elegantly, adding to easier
readability and debuggability.<br/>The plugin `lists` and `describes` all the underlying components that are significant
for the engines.

<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">

Alpha. Under active development and seeking [contributions from the community](#contributing).
---

The CLI currently supports managing cStor Pools and Volumes.
## Project Status

<b>Alpha</b>. Under active development and seeking [contributions from the community](#contributing).
The CLI currently supports managing `cStor` Pools and Volumes.<br/>**Thank you!**

---

[![Go Report Card](https://goreportcard.com/badge/github.com/openebs/openebsctl?)](https://goreportcard.com/report/github.com/openebs/openebsctl)
[![Contributors](https://img.shields.io/github/contributors/openebs/openebsctl)](https://github.com/openebs/openebsctl/graphs/contributors)
[![release](https://img.shields.io/github/release-pre/openebs/openebsctl.svg)](https://github.com/openebs/openebsctl/releases)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/mum4k/termdash/blob/master/LICENSE)
[![Releases](https://img.shields.io/github/downloads/openebs/openebsctl/total.svg)](https://github.com//openebs/openebsctl/releases)

---
## Table of Contents
* [Installation](#installation)
* [Build](#build)
* [Flags](#flags)
* [Usage](#usage)
* [Get cStor volumes](#get-cstor-volumes)
* [Get cStor pools](#get-cstor-pools)
* [Describe cStor volumes](#describe-cstor-volumes)
* [Describe cStor pool](#describe-cstor-pool)
* [Describe pvcs](#describe-pvcs)
* [Contributing](#contributing)

---
## Installation
OpenEBS-CTL is available on Linux, macOS and Windows platforms.

* 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.1.0_Linux_x86_64.tar.gz
cd kubectl-openebs_v0.1.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.
* For Mac, download the respective tarball from [release](https://github.com/openebs/openebsctl/releases) page and :-
```shell
tar -xzvf kubectl-openebs_v0.1.0_Darwin_x86_64.tar.gz
cd kubectl-openebs_v0.1.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

- Clone this repo to your system. `git clone https://github.com/openebs/openebsctl`
- `cd openebsctl`
- Run `make openebsctl`
- Run `kubectl openebs [get|describe] [resource]` to use the plugin

## Usage


```bash
# Get volumes
$ kubectl openebs get volumes
Namespace Name Status Version Capacity StorageClass Attached Access Mode Attached Node
--------- ---- ------ ------- -------- ------------ -------- ----------- -------------
openebs pvc-cb978ab8-9045-4d40-abc5-98dfd4fd82fb Healthy master-dev 5Gi cstor.csi.openebs.io Attached ReadWriteOnce vanisingh
openebs pvc-e20c1212-1ef6-42c4-9638-0145fa3fb4f9 Healthy master-dev 5Gi N/A N/A N/A


# Describe a single volume
$ kubectl openebs describe volume pvc-cbe030cb-63ca-4dfd-ba57-7719a8c93fb2
Volume Details :
----------------
Name : pvc-cbe030cb-63ca-4dfd-ba57-7719a8c93fb2
Access Mode : ReadWriteOnce
CSI Driver : cstor.csi.openebs.io
Storage Class : openebs-csi-cstor-sparse
Volume Phase : Bound
Version : master-dev
CSPC : cspc-stripe
Size : 5Gi
Status : Healthy
ReplicaCount : 1

Portal Details :
----------------
IQN : iqn.2016-09.com.openebs.cstor:pvc-cbe030cb-63ca-4dfd-ba57-7719a8c93fb2
Volume : pvc-cbe030cb-63ca-4dfd-ba57-7719a8c93fb2
TargetNodeName : vanisingh
Portal : 10.103.173.0:3260
TargetIP : 10.103.173.0

Replica Details :
----------------
Name Pool Instance Status
---- ------------- ------
pvc-cbe030cb-63ca-4dfd-ba57-7719a8c93fb2-cspc-stripe-56pv cspc-stripe-56pv Healthy

# Get CStor pools
$ kubectl openebs get pools
Name Namespace HostName Free Capacity ReadOnly ProvisionedReplicas HealthyReplicas Status Age
---- --------- -------- ---- -------- -------- ------------------- --------------- ------ ---
fastssd-cstor test director-dev-cluster-1-node-1 48200M 48202370k false 1 1 ONLINE 2d5h
```

## Flags
* `--openebs-namespace` :- to override the determination of `namespace` where storage engine is installed with the provided value.
* `--namespace, -n` :- to pass the namespace, if the resource is namespaced, like `pvc` etc.
* `--cas-type` :- to pass the cas-type, like cstor, jiva.

## Usage
* #### Get `cStor` volumes
```bash
$ kubectl openebs get volumes --cas-type=cstor
NAMESPACE NAME STATUS VERSION CAPACITY STORAGE CLASS ATTACHED ACCESS MODE ATTACHED NODE
cstor pvc-193844d7-3bef-45a3-8b7d-ed3991391b45 Healthy 2.9.0 5.0 GiB cstor-csi-sc Bound ReadWriteOnce N/A
cstor pvc-b84f60ae-3f26-4110-a85d-bce7ec00dacc Healthy 2.0.0 20 GiB common-storageclass Bound ReadWriteOnce node1-virtual-machine
```
Note: For volumes not attached to any application, the `ATTACH NODE` would be shown as `N/A`.

* #### Get `cStor` pools
```bash
$ kubectl openebs get pools
NAME HOSTNAME FREE CAPACITY READ ONLY PROVISIONED REPLICAS HEALTHY REPLICAS STATUS AGE
cstor-storage-k5c2 node1-virtual-machine 45 GiB 45 GiB false 1 0 ONLINE 10d2h
default-cstor-disk-dcrm node1-virtual-machine 73 GiB 90 GiB false 7 7 ONLINE 27d2h
default-cstor-disk-fp6v node2-virtual-machine 73 GiB 90 GiB false 7 7 ONLINE 27d2h
default-cstor-disk-rhwj node1-virtual-machine 73 GiB 90 GiB false 7 4 OFFLINE 27d2h
```
* #### 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
ACCESS MODE : ReadWriteOnce
CSI DRIVER : cstor.csi.openebs.io
STORAGE CLASS : cstor-csi
VOLUME PHASE : Released
VERSION : 2.9.0
CSPC : cstor-storage
SIZE : 5.0 GiB
STATUS : Init
REPLICA COUNT : 1


Portal Details :
------------------
IQN : iqn.2016-09.com.openebs.cstor:pvc-193844d7-3bef-45a3-8b7d-ed3991391b45
VOLUME NAME : pvc-193844d7-3bef-45a3-8b7d-ed3991391b45
TARGET NODE NAME : node1-virtual-machine
PORTAL : 10.106.27.10:3260
TARGET IP : 10.106.27.10


Replica Details :
-----------------
NAME TOTAL USED STATUS AGE
pvc-193844d7-3bef-45a3-8b7d-ed3991391b45-cstor-storage-k5c2 72 KiB 4.8 MiB Healthy 10d3h

Cstor Completed Backup Details :
-------------------------------
NAME BACKUP NAME VOLUME NAME LAST SNAP NAME
backup4-pvc-b026cde1-28d9-40ff-ba95-2f3a6c1d5668 backup4 pvc-193844d7-3bef-45a3-8b7d-ed3991391b45 backup4

Cstor Restores Details :
-----------------------
NAME RESTORE NAME VOLUME NAME RESTORE SOURCE STORAGE CLASS STATUS
backup4-3cc0839b-8428-4361-8b12-eb8509208871 backup4 pvc-193844d7-3bef-45a3-8b7d-ed3991391b45 192.168.1.165:9000 cstor-csi 0
```
* #### Describe `cStor` pool
```bash
$ kubectl openebs describe pool default-cstor-disk-fp6v --openebs-namespace=openebs

default-cstor-disk-fp6v Details :
----------------
NAME : default-cstor-disk-fp6v
HOSTNAME : node1-virtual-machine
SIZE : 90 GiB
FREE CAPACITY : 73 GiB
READ ONLY STATUS : false
STATUS : ONLINE
RAID TYPE : stripe

Blockdevice details :
---------------------
NAME CAPACITY STATE
blockdevice-8a5b69d8a2b23276f8daeac3c8179f9d 100 GiB Active

Replica Details :
-----------------
NAME PVC NAME SIZE STATE
pvc-b84f60ae-3f26-4110-a85d-bce7ec00dacc-default-cstor-disk-fp6v mongo 992 MiB Healthy
```
* #### Describe pvcs
```bash
$ kubectl openebs describe pvc mongo

mongo Details :
------------------
NAME : mongo
NAMESPACE : default
CAS TYPE : cstor
BOUND VOLUME : pvc-b84f60ae-3f26-4110-a85d-bce7ec00dacc
ATTACHED TO NODE : node1-virtual-machine
POOL : default-cstor-disk
STORAGE CLASS : common-storageclass
SIZE : 20 GiB
USED : 1.1 GiB
PV STATUS : Healthy

Target Details :
----------------
NAMESPACE NAME READY STATUS AGE IP NODE
openebs pvc-b84f60ae-3f26-4110-a85d-bce7ec00dacc-target-7487cbc8bc5ttzl 3/3 Running 26d22h 172.17.0.7 node1-virtual-machine

Replica Details :
-----------------
NAME TOTAL USED STATUS AGE
pvc-b84f60ae-3f26-4110-a85d-bce7ec00dacc-default-cstor-disk-dcrm 992 MiB 1.1 GiB Healthy 26d23h
pvc-b84f60ae-3f26-4110-a85d-bce7ec00dacc-default-cstor-disk-fp6v 992 MiB 1.1 GiB Healthy 26d23h
pvc-b84f60ae-3f26-4110-a85d-bce7ec00dacc-default-cstor-disk-rhwj 682 MiB 832 MiB Offline 26d23h

Additional Details from CVC :
-----------------------------
NAME : pvc-b84f60ae-3f26-4110-a85d-bce7ec00dacc
REPLICA COUNT : 3
POOL INFO : [default-cstor-disk-dcrm default-cstor-disk-fp6v default-cstor-disk-rhwj]
VERSION : 2.1.0
UPGRADING : true
```
## Contributing

OpenEBS welcomes your feedback and contributions in any form possible.

- [Join OpenEBS community on Kubernetes Slack](https://kubernetes.slack.com)
- Already signed up? Head to our discussions at [#openebs](https://kubernetes.slack.com/messages/openebs/)
- Already signed up? Head to our discussions at [#openebs](https://kubernetes.slack.com/messages/openebs/)
- Want to raise an issue or help with fixes and features?
- See [open issues](https://github.com/openebs/openebs/issues)
- See [contributing guide](./CONTRIBUTING.md)
- See [Project Roadmap](https://github.com/openebs/openebsctl/projects/1)
- Checkout our existing [adopters](https://github.com/openebs/openebs/tree/master/adopters) and their [feedbacks](https://github.com/openebs/openebs/issues/2719).
- Want to join our contributor community meetings, [check this out](https://hackmd.io/mfG78r7MS86oMx8oyaV8Iw?view).
- See [open issues](https://github.com/openebs/openebs/issues)
- See [contributing guide](./CONTRIBUTING.md)
- See [Project Roadmap](https://github.com/openebs/openebsctl/projects/1)
- Checkout our existing [adopters](https://github.com/openebs/openebs/tree/master/adopters) and their [feedbacks](https://github.com/openebs/openebs/issues/2719).
- Want to join our contributor community meetings, [check this out](https://hackmd.io/mfG78r7MS86oMx8oyaV8Iw?view).
- Join our OpenEBS CNCF Mailing lists
- For OpenEBS project updates, subscribe to [OpenEBS Announcements](https://lists.cncf.io/g/cncf-openebs-announcements)
- For interacting with other OpenEBS users, subscribe to [OpenEBS Users](https://lists.cncf.io/g/cncf-openebs-users)
- For OpenEBS project updates, subscribe to [OpenEBS Announcements](https://lists.cncf.io/g/cncf-openebs-announcements)
- For interacting with other OpenEBS users, subscribe to [OpenEBS Users](https://lists.cncf.io/g/cncf-openebs-users)


For more details checkout [CONTRIBUTING.md](./CONTRIBUTING.md).
Expand Down

0 comments on commit d459689

Please sign in to comment.