mayactl is the command line tool for interacting with OpenEBS volumes and Pools. The
mayactl is not used or required while provisioning or managing the OpenEBS volumes, but it is currently used while debugging and troubleshooting. OpenEBS volume and pool status can be get using the
Commands used with mayactl
The following commands can be run using mayactl to get the details of OpenEBS volume, StoragePool and installed version.
- OpenEBS volume related
- mayactl volume list
- mayactl volume stats
- mayactl volume describe
- OpenEBS StoragePool related
- mayactl pool list
- mayactl pool describe
- OpenEBS version related
- mayactl version
For getting access to
mayactl command line tool, you have to login or execute into the maya-apiserver pod on Kubernetes. The steps are outlined below.
Find out the name of the maya-apiserver
kubectl get pod -n openebs | grep -i api
Following is an example output.maya-apiserver-7f5689b96b-tfssh 1/1 Running 0 10d
It is possible that there are multiple instances of maya-apiserver pods for scaling purposes. You can run mayactl in any one of them. Shell into one of the pods using
kubectl execcommand . You can do as following way.
kubectl exec -it <maya-apiserver-podname> /bin/bash -n openebs
You will get access to the bash shell of maya-apiserver pod like shown below.bash-4.3#
Once you are inside the maya -apiserver,use mayactl help command for more details.
mayactl for OpenEBS Storage Volume
OpenEBS storage volume command usage examples are shown below.
The following command shows the list of all OpenEBS volumes including both Jiva and cStor.
mayactl volume list
The following command shows the description of a OpenEBS volume.
mayactl volume describe --volname pvc-448deccf-40d9-11e9-a23b-0050569331ce -n openebs
The following command shows the live statistics of OpenEBS volume.
mayactl volume stats --volname pvc-448deccf-40d9-11e9-a23b-0050569331ce -n openebs
mayactl for OpenEBS Storage Pools
OpenEBS storage pool command usage examples are shown below.
It will show the available commands which can run with
mayactl for getting details of OpenEBS pools.
The following command shows the list of all OpenEBS StoragePools.
mayactl pool list
The following command show the description of OpenEBS StoragePool.
mayactl pool describe --poolname cstor-pool1-5lwv
OpenEBS installed version can be obtained using the following command. This will show the status of maya-apiserver and its URL.