mayactl
OpenEBS Documentation is now migrated to https://openebs.io/docs. The page you are currently viewing is a static snapshot and will be removed in the upcoming releases.
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 mayactl
command.
Summary
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
Accessing mayactl
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-p1p2p 1/1 Running 0 10dIt 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 exec
command . 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#
Using mayactl
Once you are inside the maya -apiserver,use mayactl help command for more details.
mayactl help
Example Output:
OpenEBS storage volume command usage examples are shown below. mayactl for OpenEBS Storage Volume
mayactl volume
Example Output:
The following command shows the list of all OpenEBS volumes including both Jiva and cStor.
mayactl volume list
Example Output:
The following command shows the description of a OpenEBS volume.
mayactl volume describe --volname pvc-dc3cb979-51ec-11e9-803f-42010a800179 -n openebs
Example Output:
The following command shows the live statistics of OpenEBS volume.
mayactl volume stats --volname pvc-448deccf-40d9-11e9-a23b-0050569331ce -n openebs
Example Output:
OpenEBS storage pool command usage examples are shown below. mayactl for OpenEBS Storage Pools
mayactl pool
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
Example Output:
The following command show the description of OpenEBS StoragePool.
mayactl pool describe --poolname cstor-pool1-5lwv
Example Output:
OpenEBS installed version can be obtained using the following command. This will show the status of maya-apiserver and its URL. mayactl Version
mayactl version
Example Output:
See Also:
FAQ
Troubleshooting Guide
Feedback
Was this page helpful?
Thanks for the feedback. Open an issue in the GitHub repo if you want to report a problem or suggest an improvement. Engage and get additional help on https://kubernetes.slack.com/messages/openebs/.