README
¶
Litmusctl
The Litmuschaos command-line tool, litmusctl, allows you to manage litmuschaos's agent plane. You can use litmusctl to connect Chaos Delegates, create project, schedule Chaos Scenarios, disconnect Chaos Delegates and manage multiple litmuschaos accounts.
Usage
For more information including a complete list of litmusctl operations, see the litmusctl reference documentation.
- For v0.3.0 or latest:
- Non-Interactive mode: Click here
- Interactive mode: Click here
- For v0.2.0 or earlier && compatible with Litmus-2.0.0-Beta8 or earlier: Click here
Requirements
The 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
Compatibility matrix
To check compatibility of chaosctl with Chaos Center
| litmusctl version | Chaos Center supported versions |
|---|---|
| 0.6.0 | 2.2.0, 2.3.0 |
| 0.7.0 | 2.4.0, 2.5.0, 2.6.0, 2.7.0, 2.8.0 |
| 0.8.0 | 2.4.0, 2.5.0, 2.6.0, 2.7.0, 2.8.0 |
| 0.9.0 | 2.4.0, 2.5.0, 2.6.0, 2.7.0, 2.8.0 |
| 0.10.0 | 2.9.0, 2.10.0, 2.11.0 |
| 0.11.0 | 2.9.0, 2.10.0, 2.11.0 |
Installation
To install the latest version of litmusctl follow the below steps:
| Platforms | v0.10.0 | v0.9.0 | v0.7.0 | v0.6.0 | v0.5.0 | master(Unreleased) |
|---|---|---|---|---|---|---|
| litmusctl-darwin-amd64 (MacOS) | 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 |
| litmusctl-linux-amd64 | 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 |
| litmusctl-linux-arm64 | 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 |
| litmusctl-windows-amd64 | 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 |
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
Documentation
¶
Overview ¶
Copyright © 2021 The LitmusChaos Authors
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Source Files
Directories