Skip to main content
Version: 2.2.0

Installing ChaosAgents in interactive mode

Usage: Litmusctl v0.3.0


  • For litmusctl v0.3.0 or latest
  • Compatible with Litmus 2.0.0 or latest

litmusctl Syntax#

litmusctl has a syntax to use as follows:

litmusctl [command] [TYPE] [flags]
  • Command: refers to what you do want to perform (create, get and config)
  • Type: refers to the feature type you are performing a command against (agent, project etc.)
  • Flags: It takes some additional information for resource operations. For example, --installation-mode allows you to specify an installation mode.

Litmusctl is using the .litmusconfig config file to manage multiple accounts

  1. If the --config flag is set, then only the given file is loaded. The flag may only be set once and no merging takes place.
  2. Otherwise, the ${HOME}/.litmusconfig file is used, and no merging takes place.

Litmusctl supports both interactive and non-interactive(flag based) modes.

Only litmusctl create agent command needs --non-interactive flag, other commands don't need this flag to be in non-interactive mode. If mandatory flags aren't passed, then litmusctl takes input in an interactive mode.

Multiple external ChaosAgents can be connected to the ChaosCenter with the help of the command line utility litmusctl

Steps to create an agent#

  • To setup an account with litmusctl
litmusctl config set-account

Next, you need to enter ChaosCenter details to login into your ChaosCenter account. Fields to be filled in:

ChaosCenter URL: Enter the URL used to access the ChaosCenter.


Username: Enter your ChaosCenter username.
Password: Enter your ChaosCenter password.

Host endpoint where litmus is installed: [Default: admin]: admin
Password:account.username/admin configured
  • To create an agent in a cluster mode
litmusctl create agent

There will be a list of existing projects displayed on the terminal. Select the desired project by entering the sequence number indicated against it.

Project list:1.  Project-Admin
Select a project [Range: 1-1]: 1

Next, select the installation mode based on your requirement by entering the sequence number indicated against it.

Litmusctl can install an agent in two different modes.

  • cluster mode: With this mode, the agent can run the chaos in any namespace. It installs appropriate cluster roles and cluster role bindings to achieve this mode.

  • namespace mode: With this mode, the agent can run the chaos in its namespace. It installs appropriate roles and role bindings to achieve this mode.

Note: With namespace mode, the user needs to create the namespace to install the agent as a prerequisite.

Installation Modes:1. Cluster2. Namespace
Select Mode [Default: cluster] [Range: 1-2]: 1
๐Ÿƒ Running prerequisites check....๐Ÿ”‘ clusterrole โœ…๐Ÿ”‘ clusterrolebinding โœ…๐ŸŒŸ Sufficient permissions. Installing the Agent...

Next, enter the details of the new agent.

Fields to be filled in

Agent Name:Enter a name of the agent which needs to be unique across the project
Agent Description:Fill in details about the agent
Node Selector:To deploy the agent on a particular node based on the node selector labels
Platform Name:Enter the platform name on which this agent is hosted. For example, AWS, GCP, Rancher etc.
Enter the namespace:You can either enter an existing namespace or enter a new namespace. In cases where the namespace does not exist, litmusctl creates it for you
Enter service account:You can either enter an existing or new service account
Enter the details of the agent
Agent Name: New-Agent
Agent Description: This is a new agent
Do you want NodeSelector to be added in the agent deployments (Y/N) (Default: N): N
Platform List:1. AWS2. GKE3. Openshift4. Rancher5. Others
Select a platform [Default: Others] [Range: 1-5]: 5
Enter the namespace (new or existing namespace) [Default: litmus]:๐Ÿ‘ Continuing with litmus namespace

Once, all these steps are implemented you will be able to see a summary of all the entered fields. After verification of these details, you can proceed with the connection of the agent by entering Y. The process of connection might take up to a few seconds.

Enter service account [Default: litmus]:
๐Ÿ“Œ SummaryAgent Name: New-AgentAgent Description: This is a new agentPlatform Name: OthersNamespace:  litmusService Account:  litmus (new)
Installation Mode: cluster
๐Ÿคท Do you want to continue with the above details? [Y/N]: Y๐Ÿ‘ Continuing agent connection!!Applying YAML:
๐Ÿ’ก Connecting agent to Litmus Portal.๐Ÿƒ Agents are running!!
๐Ÿš€ Agent Connection Successful!! ๐ŸŽ‰๐Ÿ‘‰ Litmus agents can be accessed here:

Verify the new Agent Connection**#

To verify, if the connection process was successful you can view the list of connected agents from the Targets section on your ChaosCenter and ensure that the connected agent is in Active State.

Additional commands#

  • To view the current configuration of .litmusconfig, type:
litmusctl config view


accounts:- users:  - expires_in: "1626897027"    token: eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2MjY4OTcwMjcsInJvbGUiOiJhZG1pbiIsInVpZCI6ImVlODZkYTljLTNmODAtNGRmMy04YzQyLTExNzlhODIzOTVhOSIsInVzZXJuYW1lIjoiYWRtaW4ifQ.O_hFcIhxP4rhyUN9NEVlQmWesoWlpgHpPFL58VbJHnhvJllP5_MNPbrRMKyFvzW3hANgXK2u8437u    username: admin  - expires_in: "1626944602"    token: eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2MjY5NDQ2MDIsInJvbGUiOiJ1c2VyIiwidWlkIjoiNjFmMDY4M2YtZWY0OC00MGE1LWIzMjgtZTU2ZDA2NjM1MTE4IiwidXNlcm5hbWUiOiJyYWoifQ.pks7xjkFdJD649RjCBwQuPF1_QMoryDWixSKx4tPAqXI75ns4sc-yGhMdbEvIZ3AJSvDaqTa47XTC6c8R    username: litmus-user  endpoint: https://preview.litmuschaos.ioapiVersion: v1current-account: https://preview.litmuschaos.iocurrent-user: litmus-userkind: Config
  • To get an overview of the accounts available within .litmusconfig, use the config get-accounts command:
litmusctl config get-accounts


CURRENT  ENDPOINT                         USERNAME  EXPIRESIN   admin     2021-07-22 01:20:27 +0530 IST*   raj       2021-07-22 14:33:22 +0530 IST
  • To alter the current account use the use-account command:
litmusctl config use-account
Host endpoint where litmus is installed:
Username: admin
  • To create a project, apply the following command :
litmusctl create project
Enter a project name: new
  • To view all the projects with the user, use the get projects command.
litmusctl get projects


PROJECT ID                                PROJECT NAME       CREATEDAT50addd40-8767-448c-a91a-5071543a2d8e      Developer Project  2021-07-21 14:38:51 +0530 IST7a4a259a-1ae5-4204-ae83-89a8838eaec3      DevOps Project     2021-07-21 14:39:14 +0530 IST
  • To get an overview of the agents available within a project, issue the following command.
litmusctl get agents
Enter the Project ID: 50addd40-8767-448c-a91a-5071543a2d8e


AGENTID                                AGENTNAME          STATUS55ecc7f2-2754-43aa-8e12-6903e4c6183a   agent-1            ACTIVE13dsf3d1-5324-54af-4g23-5331g5v2364f   agent-2            INACTIVE

For more information related to flags, Use litmusctl --help.

Learn More#