Skip to content
This repository has been archived by the owner on Mar 3, 2022. It is now read-only.

Commit

Permalink
Addition of mayctl
Browse files Browse the repository at this point in the history
added mayactl section
Signed-off-by: ranjithwingrider <ranjith.raveendran@openebs.io>
  • Loading branch information
ranjithwingrider committed Mar 11, 2019
1 parent 9f5168d commit 87d55b1
Show file tree
Hide file tree
Showing 2 changed files with 89 additions and 1 deletion.
88 changes: 88 additions & 0 deletions docs/mayactl.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
---
id: mayactl
title: Mayactl
sidebar_label: Mayactl
---
------

The `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

Command used with mayactl

Accesssing mayactl

Using mayactl



Accesssing mayactl

For getting access to mayactl command line tool, you will have to login / execute into the maya-apiserver pod on Kubernetes. The steps are outlined below.

1. Find out the name of the maya-apiserver

```
kubectl get pods -n openebs | grep -i maya-apiserver
```

Following is an example output

```
maya-apiserver-7bc857bb44-wm2g4 1/1 Running 0 4h
```

2. It is possible that there are multiple instances of maya-apiserver pods for scaling purposes. You can run mayactl in any one of them. Pick 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# `



<br>

## See Also:



<br>

<hr>

<br>





<!-- Hotjar Tracking Code for https://docs.openebs.io -->

<script>
(function(h,o,t,j,a,r){
h.hj=h.hj||function(){(h.hj.q=h.hj.q||[]).push(arguments)};
h._hjSettings={hjid:785693,hjsv:6};
a=o.getElementsByTagName('head')[0];
r=o.createElement('script');r.async=1;
r.src=t+h._hjSettings.hjid+j+h._hjSettings.hjsv;
a.appendChild(r);
})(window,document,'https://static.hotjar.com/c/hotjar-','.js?sv=');
</script>


<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-92076314-12"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());

gtag('config', 'UA-92076314-12');
</script>
2 changes: 1 addition & 1 deletion website/sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"docs": {
"Introduction": ["overview","features", "usecases", "releases", "support", "mayaonline"],
"Concepts": ["cas", "architecture", "casengines","cstor","jiva"],
"User Guides": ["quickstart", "prerequisites", "installation", "configurepools", "configuresc", "provisionvols", "operations", "jivaguide", "backup", "upgrade", "uninstall" ],
"User Guides": ["quickstart", "prerequisites", "installation", "configurepools", "configuresc", "provisionvols", "operations", "jivaguide", "mayactl","backup", "upgrade", "uninstall" ],
"Stateful Applications": ["mysql", "prometheus", "minio", "gitlab", "percona", "elasticsearch", "cassandra","nuodb", "postgres", "redis", "mongo", "rwm"],
"Advanced Topics": ["performance", "faq", "k8supgrades", "troubleshooting"]
}
Expand Down

0 comments on commit 87d55b1

Please sign in to comment.