litmus-docs/website/docs/getting-started/chaosagents-namespace-scope...

5.4 KiB

id title sidebar_label
chaosagents-namespace-scope-installation ChaosAgents Namespace Scope Installation Namespace Scope

Prerequisites

  • Before connecting a ChaosAgent to the ChaosCenter, learn about what is a ChaosAgent in Litmus.
  • Make sure litmusctl is installed.

Installation

Multiple external ChaosAgents can be connected to application namespace/s with the help of the command line utility litmusctl.

The following steps will help you connect your ChaosAgents via litmusctl

litmusctl agent connect

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.

Example, http://172.17.0.2:31696/

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

🔥 Connecting LitmusChaos agent

📶 Please enter LitmusChaos details --
👉 Host URL where litmus is installed: http://172.17.0.2:31696/
🤔 Username [admin]: admin
🙈 Password:
✅ Login Successful!

Upon successful login, there will be a list of existing projects displayed on the terminal. Select the desired project by entering the sequence number indicated against it.

✨ Projects List:
1.  MyFirstProject
2.  MySecondProject

🔎 Select Project: 1

Next, select the installation mode as Namespace by entering the sequence number indicated against it. There will be a prerequisites check to verify Role and RoleBinding post selection.

🔌 Installation Modes:
1. Cluster
2. Namespace

👉 Select Mode [cluster]: 2

🏃 Running prerequisites check....
🔑  role - ✅
🔑  rolebinding - ✅

🌟 Sufficient permissions. Connecting Agent

Next, enter the details of the new agent.

Fields to be filled in

Platforms Download Link
Agent Name: Enter the name for the new agent.
Agent Description: Fill in details about the agent.
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 (where your application is running) or create a new namespace
Enter service account: Enter a name for your service account.

Since Namespaced Scope ChaosAgent don't have Cluster Wide Permission therefore if you are willing to install the ChaosAgent in new namespace, the namespace won't be automatically created

If you install the Namespaced Scope ChaosAgent in the same namespace as ChaosCenter, since the subscriber is already present in the namespace, you will see this message 🚫 Subscriber already present. Please enter a different namespace in such cases you have to create a new namespace in the cluster to install the ChaosAgent else choose the existing namespace where your application resides (besides the ns where ChaosCenter is present)

🔗 Enter the details of the agent ----
🤷 Agent Name: my-agent
📘 Agent Description: This is a new namespace agent.
📦 Platform List
1. AWS
2. GKE
3. Openshift
4. Rancher
5. Others
🔎 Select Platform [Others]: 5
📁 Enter the namespace (new or existing) [litmus]: litmus
🔑 Enter service account [litmus]: litmus

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.

📌 Summary --------------------------

Agent Name:         my-agent
Agent Description:  This is a new agent.
Platform Name:      Others
Namespace:          litmus
Service Account:    litmus
Installation Mode:  namespace

-------------------------------------

🤷 Do you want to continue with the above details? [Y/N]: Y

💡 Connecting agent to Litmus Portal.
🏃 Agents running!!
🚀 Agent Connection Successful!! 🎉
👉 Litmus agents can be accessed here: http://172.17.0.2:31696/targets

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.

Resources

Videos

Learn More