docs/static/v0.4/reference/mesheryctl/index.html
Meshery CLI commands are categorized by function, which are:
mesheryctl - Global flagsmesheryctl system - Meshery Lifecycle and Troubleshootingmesheryctl mesh - Service Mesh Lifecycle & Configuration Managementmesheryctl perf - Service Mesh Performance Management| command | flag | function | Usage |
|---|---|---|---|
| mesheryctl | Displays help about any command. | mesheryctl | |
| version | Displays the version of the Meshery Client (mesheryctl) and the SHA of the release binary. | mesheryctl system version | |
| config | configures Meshery with the kubeconfig, generated with the help of user details, to provide cluster access for public clouds(GKE/EKS). | mesheryctl system config gke --token "PATH TO TOKEN" | |
| mesheryctl-config | (optional) path to Meshery Client (mesheryctl) configuration file (~/.meshery/mesheryctl.yaml) to overrides defaults. | mesheryctl perf <args> --mesheryctl-config=~/.meshery/mesheryctl.yaml | |
| verbose | (optional) Sets the log level to debug for verbose output. | mesheryctl <command> --verbose | |
| help | Displays helpful information about any command. | mesheryctl --help |
Installation, troubleshooting and debugging of Meshery and its adapters.
| command | arg | flag | function | Usage |
|---|---|---|---|---|
| system | mesheryctl system | |||
| channel | Switch between release channels. | mesheryctl system channel | ||
| config | Configures Meshery to use a Kubernetes cluster. | mesheryctl system config gke --token ~/Downloads/auth.json | ||
| log | Starts tailing Meshery server debug logs. | mesheryctl system log | ||
| start | Start all Meshery containers. | mesheryctl system start | ||
| completion | Generates completion script. | mesheryctl system completion [bash|zsh|fish] | ||
| status | Displays the status of Meshery’s containers (server and adapters). | mesheryctl system status | ||
| stop | Stop all Meshery containers. | mesheryctl system stop | ||
| reset | Resets meshery.yaml with copy from Meshery repo. Warning - Any local changes will be overwritten. | mesheryctl system reset | ||
| update | Pull new Meshery images from Docker Hub. Does not pulls new mesheryctl client. This command may be executed while Meshery is running. | mesheryctl system update | ||
| help | Displays help about any Meshery lifecycle management command. | mesheryctl system --help | ||
| channel | switch | switch release channel and version | `mesheryctl system channel switch [stable | |
| channel | view | view release channel and version | mesheryctl system channel view | |
| start | –reset | (optional) reset Meshery’s configuration file to default settings. | mesheryctl system start --reset | |
| start | –skip-update | (optional) skip updates available in Meshery. | mesheryctl system start --skip-update | |
| channel | set | set release channel and version. | `mesheryctl system channel set [stable | |
| stop | –reset | (optional) reset Meshery’s configuration file to default settings. | mesheryctl system stop --reset |
| command | flag | function | Usage |
|---|---|---|---|
| perf | Performance management - baselining and testing. | mesheryctl perf --name "a quick stress test" --url http://192.168.1.15/productpage --qps 300 --concurrent-requests 2 --duration 30s --load-generator wrk2 | |
| –mesh (optional) | Name of the service mesh. (default) empty string | ||
| –load-generator (optional) | Choice of load generator - fortio (OR) wrk2 (default) fortio | --load-generator=fortio | |
| –file (optional) | URI of the service mesh performance test configuration file. (default) empty string | --file soak-test-clusterA.yaml | |
| –qps (optional) | Queries per second (default) 0 (0 - means to use the CPU unbounded to generate as many requests as possible. | --qps 30 | |
| –url (required) | URL of the endpoint send load to during testing. | http://my-service/api/v1/test | |
| –name (optional) | A memorable name for the test. (default) a random string | ||
| –concurrent-requests (optional) | Number of concurrent requests (default) 1 | --concurrent-requests 10 | |
| –duration(optional) | Duration of the test. | 10s, 5m, 2h | |
| –help, -h | Displays help the performance management command. | mesheryctl perf --help |
| command | arg | flag | function | Usage |
|---|---|---|---|---|
| mesh | Lifecycle management of service meshes | |||
| init | Provision a service mesh | |||
| –platform | Identify platform to provision service mesh on (e.g. Docker, K8s) | --platform docker | ||
| –profile | Use specific configuration profile | --profile mTLS | ||
| –help, -h | Displays help about any service mesh lifecycle management command. | mesheryctl help |