Skip to content

Command-Line tool to manage Litmuschaos's agent plane

License

Notifications You must be signed in to change notification settings

Saranya-jena/litmusctl

 
 

Repository files navigation

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 create agents, project, 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 && compatible with Litmus-2.0.0-Beta9 or latest:
  • 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 agents. 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

Installation

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

Platforms v0.3.0 v0.2.0 master(Unreleased)
litmusctl-darwin-amd64 (MacOS) Click here Click here Click here
litmusctl-linux-386 Click here Click here Click here
litmusctl-linux-amd64 Click here Click here Click here
litmusctl-linux-arm Click here Click here Click here
litmusctl-linux-arm64 Click here Click here Click here
litmusctl-windows-386 Click here Click here Click here
litmusctl-windows-amd64 Click here Click here Click here
litmusctl-windows-arm 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

About

Command-Line tool to manage Litmuschaos's agent plane

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 98.4%
  • Shell 1.1%
  • Makefile 0.5%