Litmusctl
The Litmuschaos command-line tool, litmusctl, allows you to manage litmuschaos's chaos delegate plane. You can use litmusctl to connect and disconnect chaos delegates, create chaos scenarios, project, and manage multiple litmuschaos accounts.
Prerequisites​
Litmusctl CLI requires the following things:
- kubeconfig - litmusctl needs the kubeconfig of the k8s cluster where we need to connect litmus chaos delegates. The CLI currently uses the default path of kubeconfig i.e.
~/.kube/config. - kubectl - litmusctl is using kubectl under the hood to apply the manifest.
To install kubectl, follow: kubectl
Usage​
For more information including a complete list of litmusctl operations, see the litmusctl reference documentation.
- For v0.12.0 or latest: Click here
- For v0.2.0 or earlier: Click here
Compatibility matrix​
To check compatibility of litmusctl with Chaos Center
| litmusctl version | Lowest Chaos Center supported version | Highest Chaos Center supported version |
|---|---|---|
| 0.7.0 | 2.4.0 | 2.8.0 |
| 0.8.0 | 2.4.0 | 2.8.0 |
| 0.9.0 | 2.4.0 | 2.8.0 |
| 0.10.0 | 2.9.0 | 3.0.0-beta8 |
| 0.11.0 | 2.9.0 | 3.0.0-beta8 |
| 0.12.0 | 2.9.0 | 3.0.0-beta8 |
| 0.13.0 | 2.9.0 | 3.0.0-beta8 |
| 0.14.0 | 2.9.0 | 3.0.0-beta8 |
| 0.15.0 | 2.9.0 | 3.0.0-beta8 |
| 0.16.0 | 2.9.0 | 3.0.0-beta8 |
| 0.17.0 | 2.9.0 | 3.0.0-beta8 |
| 0.18.0 | 2.9.0 | 3.0.0-beta8 |
| 0.19.0 | 2.9.0 | 3.0.0-beta8 |
| 0.20.0 | 2.9.0 | 3.0.0-beta8 |
| 0.21.0 | 2.9.0 | 3.0.0-beta8 |
| 0.22.0 | 2.9.0 | 3.0.0-beta8 |
Installation​
To install the latest version of litmusctl follow the below steps:
| Platforms | 0.22.0 | 0.21.0 | 0.20.0 | 0.19.0 | 0.18.0 | 0.17.0 | 0.16.0 | 0.15.0 | master(Unreleased) |
|---|---|---|---|---|---|---|---|---|---|
| litmusctl-darwin-amd64 (MacOS) | Click here | Click here | Click here | Click here | Click here | Click here | Click here | Click here | Click here |
| litmusctl-linux-386 | Click here | Click here | Click here | Click here | Click here | Click here | Click here | Click here | Click here |
| litmusctl-linux-amd64 | Click here | Click here | Click here | Click here | Click here | Click here | Click here | Click here | Click here |
| litmusctl-linux-arm | Click here | Click here | Click here | Click here | Click here | Click here | Click here | Click here | Click here |
| litmusctl-linux-arm64 | Click here | Click here | Click here | Click here | Click here | Click here | Click here | Click here | Click here |
| litmusctl-windows-386 | Click here | Click here | Click here | Click here | Click here | Click here | Click here | Click here | Click here |
| litmusctl-windows-amd64 | Click here | Click here | Click here | Click here | Click here | Click here | Click here | Click here | Click here |
| litmusctl-windows-arm | Click here | Click here | Click here | Click here | Click here | Click here | Click here | Click here | Click here |
Linux/MacOS​
- Extract the binary
tar -zxvf litmusctl-<OS>-<ARCH>-<VERSION>.tar.gz
- Provide necessary permissions
chmod +x litmusctl
- Move the litmusctl binary to /usr/local/bin/litmusctl. Note: Make sure to use root user or use sudo as a prefix
mv litmusctl /usr/local/bin/litmusctl
- You can run the litmusctl command in Linux/macOS:
litmusctl <command> <subcommand> <subcommand> [options and parameters]
Windows​
Extract the binary from the zip using WinZip or any other extraction tool.
You can run the litmusctl command in windows:
litmusctl.exe <command> <subcommand> <subcommand> [options and parameters]
- To check the version of the litmusctl:
litmusctl version