Skip to content

Latest commit

 

History

History
234 lines (202 loc) · 12.9 KB

README.md

File metadata and controls

234 lines (202 loc) · 12.9 KB
Raw

Litmusctl

BCH compliance GitHub Workflow GitHub stars GitHub Release

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 0.23.0 or latest: Click here
  • For v0.12.0 to v0.22.0: 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 litmusctl with Chaos Center

litmusctl version Lowest Chaos Center supported version Highest Chaos Center supported version
1.4.0 3.0.0 3.5.0
1.3.0 3.0.0 3.4.0
1.2.0 3.0.0 3.3.0
1.1.0 3.0.0 3.2.0
1.0.0 3.0.0 3.1.0
0.24.0 3.0.0-beta9 3.0.0-beta12
0.23.0 3.0.0-beta9 3.0.0-beta12
0.22.0 2.9.0 3.0.0-beta8

Installation

To install the latest version of litmusctl follow the below steps:

Platforms 1.4.0 1.3.0 1.2.0 1.1.0 1.0.0 0.24.0 0.23.0 0.22.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

Development Guide

You can find the local setup guide for litmusctl here.