11 KiB
11 KiB
| id | title | sidebar_label |
|---|---|---|
| installation | Litmusctl | Installation |
The LitmusChaos command-line tool, litmusctl, allows you to manage litmuschaos's infrastructure plane. You can use litmusctl to connect and disconnect chaos infrastructures, create chaos experiments, 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 infrastructures. 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 0.23.0 or latest: Click here
Installation
To install the latest version of litmusctl follow the below steps:
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