204 lines
10 KiB
Markdown
204 lines
10 KiB
Markdown
---
|
|
id: installation
|
|
title: Litmusctl
|
|
sidebar_label: Installation
|
|
---
|
|
|
|
---
|
|
|
|
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](https://kubernetes.io/docs/tasks/tools/#kubectl)
|
|
|
|
## Usage
|
|
|
|
For more information including a complete list of litmusctl operations, see the litmusctl reference documentation.
|
|
|
|
- For v0.12.0 or latest: <a href="https://github.com/litmuschaos/litmusctl/blob/master/Usage.md">Click here</a>
|
|
- For v0.2.0 or earlier: <a href="https://github.com/litmuschaos/litmusctl/blob/master/Usage_v0.2.0.md">Click here</a>
|
|
|
|
|
|
## Compatibility matrix
|
|
|
|
To check compatibility of litmusctl with Chaos Center
|
|
|
|
<table>
|
|
<th>litmusctl version</th>
|
|
<th>Chaos Center supported versions</th>
|
|
|
|
<tr>
|
|
<td>0.6.0</td>
|
|
<td>2.2.0, 2.3.0</td>
|
|
</tr>
|
|
<tr>
|
|
<td>0.7.0</td>
|
|
<td>2.4.0, 2.5.0, 2.6.0, 2.7.0, 2.8.0</td>
|
|
</tr>
|
|
<tr>
|
|
<td>0.8.0</td>
|
|
<td>2.4.0, 2.5.0, 2.6.0, 2.7.0, 2.8.0</td>
|
|
</tr>
|
|
<tr>
|
|
<td>0.9.0</td>
|
|
<td>2.4.0, 2.5.0, 2.6.0, 2.7.0, 2.8.0</td>
|
|
</tr>
|
|
<tr>
|
|
<td>0.10.0</td>
|
|
<td>2.9.0, 2.10.0, 2.11.0, 2.12.0</td>
|
|
</tr>
|
|
<tr>
|
|
<td>0.11.0</td>
|
|
<td>2.9.0, 2.10.0, 2.11.0, 2.12.0</td>
|
|
</tr>
|
|
<tr>
|
|
<td>0.12.0</td>
|
|
<td>2.9.0, 2.10.0, 2.11.0, 2.12.0</td>
|
|
</tr>
|
|
</table>
|
|
|
|
## Installation
|
|
|
|
To install the latest version of litmusctl follow the below steps:
|
|
|
|
<table>
|
|
<th>Platforms</th>
|
|
<th>v0.12.0</th>
|
|
<th>v0.11.0</th>
|
|
<th>v0.10.0</th>
|
|
<th>v0.9.0</th>
|
|
<th>v0.7.0</th>
|
|
<th>v0.6.0</th>
|
|
<th>master(Unreleased)</th>
|
|
<tr>
|
|
<td>litmusctl-darwin-amd64 (MacOS)</td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-darwin-amd64-0.12.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-darwin-amd64-0.11.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-darwin-amd64-0.10.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-darwin-amd64-v0.9.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-darwin-amd64-v0.7.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-darwin-amd64-v0.6.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-darwin-amd64-master.tar.gz">Click here</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td>litmusctl-linux-386</td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-linux-386-0.12.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-linux-386-0.11.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-linux-386-0.10.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-linux-386-v0.9.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-linux-386-v0.7.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-linux-386-v0.6.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-linux-386-master.tar.gz">Click here</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td>litmusctl-linux-amd64</td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-linux-amd64-0.12.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-linux-amd64-0.11.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-linux-amd64-0.10.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-linux-amd64-v0.9.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-linux-amd64-v0.7.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-linux-amd64-v0.6.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-linux-amd64-master.tar.gz">Click here</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td>litmusctl-linux-arm</td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-linux-arm-0.12.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-linux-arm-0.11.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-linux-arm-0.10.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-linux-arm-v0.9.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-linux-arm-v0.7.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-linux-arm-v0.6.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-linux-arm-master.tar.gz">Click here</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td>litmusctl-linux-arm64</td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-linux-arm64-0.12.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-linux-arm64-0.11.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-linux-arm64-0.10.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-linux-arm64-v0.9.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-linux-arm64-v0.7.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-linux-arm64-v0.6.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-linux-arm64-master.tar.gz">Click here</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td>litmusctl-windows-386</td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-windows-386-0.12.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-windows-386-0.11.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-windows-386-0.10.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-windows-386-v0.9.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-windows-386-v0.7.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-windows-386-v0.6.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-windows-386-master.tar.gz">Click here</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td>litmusctl-windows-amd64</td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-windows-amd64-0.12.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-windows-amd64-0.11.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-windows-amd64-0.10.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-windows-amd64-v0.9.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-windows-amd64-v0.7.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-windows-amd64-v0.6.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-windows-amd64-master.tar.gz">Click here</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td>litmusctl-windows-arm</td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-windows-arm-0.12.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-windows-arm-0.11.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-windows-arm-0.10.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-windows-arm-0.10.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-windows-arm-v0.9.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-windows-arm-v0.7.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-windows-arm-v0.6.0.tar.gz">Click here</a></td>
|
|
<td><a href="https://litmusctl-production-bucket.s3.amazonaws.com/litmusctl-windows-arm-master.tar.gz">Click here</a></td>
|
|
</tr>
|
|
</table>
|
|
|
|
### Linux/MacOS
|
|
|
|
- Extract the binary
|
|
|
|
```shell
|
|
tar -zxvf litmusctl-<OS>-<ARCH>-<VERSION>.tar.gz
|
|
```
|
|
|
|
- Provide necessary permissions
|
|
|
|
```shell
|
|
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
|
|
|
|
```shell
|
|
mv litmusctl /usr/local/bin/litmusctl
|
|
```
|
|
|
|
- You can run the litmusctl command in Linux/macOS:
|
|
|
|
```shell
|
|
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:
|
|
|
|
```shell
|
|
litmusctl.exe <command> <subcommand> <subcommand> [options and parameters]
|
|
```
|
|
|
|
- To check the version of the litmusctl:
|
|
|
|
```shell
|
|
litmusctl version
|
|
```
|
|
|
|
---
|