Updated Terminology throughout Getting Started Section (#62)
* Updated Terminology throughout Getting Started Section (#62) Signed-off-by: Sayan Mondal <sayan@chaosnative.com>
This commit is contained in:
Sayan Mondal
GitHub
parent
57d5511a8b
commit
fdbea54edb
|
|
@ -1,18 +0,0 @@
|
||||||
---
|
|
||||||
id: agents
|
|
||||||
title: Agents
|
|
||||||
sidebar_label: Agents
|
|
||||||
---
|
|
||||||
|
|
||||||
An Agent in Litmus is nothing but the target cluster where Chaos would be injected via Litmus. There should always be atleast one or more than one Agents connected to the Litmus Control Plane. Each individual Agent can be chosen to be the Target Agent for Chaos Injection.
|
|
||||||
|
|
||||||
## Types of Agent
|
|
||||||
|
|
||||||
In Litmus the Agents can be classified into two types
|
|
||||||
|
|
||||||
- <span style={{color: '#5B44BA'}}><b>Self Agent</b></span>
|
|
||||||
- <span style={{color: '#5B44BA'}}><b>External Agent</b></span>
|
|
||||||
|
|
||||||
As part of the Litmus installation, a Self Agent would be registered as a default Agent in the Control Plane. The same cluster where Litmus is installed is chosen as the Self Agent by the installer. From the Control Plane you can now induce chaos into this Self Agent and observe the results.
|
|
||||||
|
|
||||||
Since the Chaos Control Plane is Cross Cloud, you can connect multiple external Kubernetes agents to the same with the help of the command line utility <span style={{color: '#5B44BA'}}><b>litmusctl</b></span>. Once connected you can manage, monitor, observe and induce chaos from the Control Plane to the respective agent.
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
---
|
|
||||||
id: agent-install
|
|
||||||
title: Agent Installation
|
|
||||||
sidebar_label: Agent Install
|
|
||||||
---
|
|
||||||
|
|
||||||
## Coming Soon
|
|
||||||
|
|
@ -0,0 +1,134 @@
|
||||||
|
---
|
||||||
|
id: chaosagents-cluster-scope-installation
|
||||||
|
title: ChaosAgents Cluster Scope Installation
|
||||||
|
sidebar_label: Cluster Scope
|
||||||
|
---
|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
|
||||||
|
- Before connecting a ChaosAgent to the [ChaosCenter](chaoscenter), learn about what is a [ChaosAgent](chaosagents) in Litmus.
|
||||||
|
- Make sure `litmusctl` is installed.
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
Multiple external Kubernetes agents can be connected to the [ChaosCenter](chaoscenter) with the help of the command line utility litmusctl.
|
||||||
|
|
||||||
|
The following steps will help you connect your ChaosAgents via litmusctl
|
||||||
|
|
||||||
|
```bash
|
||||||
|
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. <br />
|
||||||
|
**Password:** Enter your LitmusPortal password.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
🔥 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 exiting projects displayed on the terminal. Select the desired project by entering the sequence number indicated against it.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
✨ Projects List:
|
||||||
|
1. MyFirstProject
|
||||||
|
2. MySecondProject
|
||||||
|
|
||||||
|
🔎 Select Project: 1
|
||||||
|
```
|
||||||
|
|
||||||
|
Next, select the installation mode as Cluster by entering the sequence number indicated against it. There will be a prerequisites check to verify ClusterRole and ClusterRoleBinding post selection.
|
||||||
|
|
||||||
|
```shell
|
||||||
|
🔌 Installation Modes:
|
||||||
|
1. Cluster
|
||||||
|
2. Namespace
|
||||||
|
|
||||||
|
👉 Select Mode [cluster]: 1
|
||||||
|
|
||||||
|
🏃 Running prerequisites check....
|
||||||
|
🔑 clusterrole - ✅
|
||||||
|
🔑 clusterrolebinding - ✅
|
||||||
|
|
||||||
|
🌟 Sufficient permissions. Connecting Agent
|
||||||
|
```
|
||||||
|
|
||||||
|
Next, enter the details of the new agent.
|
||||||
|
|
||||||
|
Fields to be filled in <br />
|
||||||
|
|
||||||
|
| 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 or enter a new namespace. In cases where the namespace does not exist, LitmusPortal creates it for you. |
|
||||||
|
| **Enter service account:** | Enter a name for your service account. |
|
||||||
|
|
||||||
|
```shell
|
||||||
|
🔗 Enter the details of the agent ----
|
||||||
|
🤷 Agent Name: my-agent
|
||||||
|
📘 Agent Description: This is a new 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.
|
||||||
|
|
||||||
|
```shell
|
||||||
|
📌 Summary --------------------------
|
||||||
|
|
||||||
|
Agent Name: my-agent
|
||||||
|
Agent Description: This is a new agent.
|
||||||
|
Platform Name: Others
|
||||||
|
Namespace: litmus
|
||||||
|
Service Account: litmus
|
||||||
|
Installation Mode: cluster
|
||||||
|
|
||||||
|
-------------------------------------
|
||||||
|
|
||||||
|
🤷 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
|
||||||
|
|
||||||
|
<iframe width="560" height="315" src="https://www.youtube.com/embed/uIVrNH2_nVI" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
|
||||||
|
|
||||||
|
## Learn More
|
||||||
|
|
||||||
|
- [Install ChaosCenter in Cluster Scope](chaoscenter-cluster-scope-installation)
|
||||||
|
- [Install ChaosCenter in Namespace Scope](chaoscenter-namespace-scope-installation)
|
||||||
|
- [Setup Endpoints and Access ChaosCenter without Ingress](setup-without-ingress)
|
||||||
|
- [Setup Endpoints and Access ChaosCenter with Ingress](setup-with-ingress)
|
||||||
|
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
id: chaosagents-namespace-scope-installation
|
||||||
|
title: ChaosAgents Namespace Scope Installation
|
||||||
|
sidebar_label: Namespace Scope
|
||||||
|
---
|
||||||
|
|
||||||
|
## Coming Soon
|
||||||
|
|
@ -0,0 +1,18 @@
|
||||||
|
---
|
||||||
|
id: chaosagents
|
||||||
|
title: ChaosAgents
|
||||||
|
sidebar_label: ChaosAgents
|
||||||
|
---
|
||||||
|
|
||||||
|
A <span style={{color: '#5B44BA'}}>**ChaosAgent**</span> in Litmus is nothing but the target cluster where Chaos would be injected via Litmus. There should always be atleast one or more than one ChaosAgents connected to the ChaosCenter. Each individual ChaosAgent can be chosen to be the Target Agent for Chaos Injection.
|
||||||
|
|
||||||
|
## Types of ChaosAgents
|
||||||
|
|
||||||
|
In Litmus, ChaosAgents can be classified into two types
|
||||||
|
|
||||||
|
- <span style={{color: '#5B44BA'}}><b>Self Agent</b></span>
|
||||||
|
- <span style={{color: '#5B44BA'}}><b>External Agent</b></span>
|
||||||
|
|
||||||
|
As part of the Litmus installation, a Self Agent would be registered as a default Agent in the ChaosCenter. The same cluster where Litmus is installed is chosen as the Self Agent by the installer. From the ChaosCenter you can now induce chaos into this Self Agent and observe the results.
|
||||||
|
|
||||||
|
Since the ChaosCenter is Cross Cloud, you can connect multiple external Kubernetes agents to the same with the help of the command line utility <span style={{color: '#5B44BA'}}><b>litmusctl</b></span>. Once connected you can manage, monitor, observe and induce chaos from the ChaosCenter to the respective ChaosAgents.
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
---
|
---
|
||||||
id: cluster-scope-installation
|
id: chaoscenter-cluster-scope-installation
|
||||||
title: Litmus Cluster Scope Installation
|
title: ChaosCenter Cluster Scope Installation
|
||||||
sidebar_label: Cluster Scope
|
sidebar_label: Cluster Scope
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
@ -19,9 +19,9 @@ Installation of Litmus can be done using either of the below methods
|
||||||
|
|
||||||
### Install Litmus using Helm
|
### Install Litmus using Helm
|
||||||
|
|
||||||
The helm chart will install all the required service account configuration and chaos control plane.
|
The helm chart will install all the required service account configuration and ChaosCenter.
|
||||||
|
|
||||||
The following steps will help you install litmus via helm.
|
The following steps will help you install Litmus ChaosCenter via helm.
|
||||||
|
|
||||||
#### Step-1: Add the litmus helm repository
|
#### Step-1: Add the litmus helm repository
|
||||||
|
|
||||||
|
|
@ -30,17 +30,17 @@ helm repo add litmuschaos https://litmuschaos.github.io/litmus-helm/
|
||||||
helm repo list
|
helm repo list
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Step-2: Create the namespace on which you want to install Litmus
|
#### Step-2: Create the namespace on which you want to install Litmus ChaosCenter
|
||||||
|
|
||||||
- The litmus infra components will be placed in this namespace.
|
- The litmus infra components will be placed in this namespace.
|
||||||
|
|
||||||
> The chaos control plane can be placed in any namespace, in this case we are using `litmus` as the namespace of our choice.
|
> The ChaosCenter can be placed in any namespace
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
kubectl create ns <LITMUS_PORTAL_NAMESPACE>
|
kubectl create ns <LITMUS_PORTAL_NAMESPACE>
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Step-3: Install the litmus chaos control plane
|
#### Step-3: Install Litmus ChaosCenter
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
helm install chaos litmuschaos/litmus-2-0-0-beta --namespace=<LITMUS_PORTAL_NAMESPACE> --devel
|
helm install chaos litmuschaos/litmus-2-0-0-beta --namespace=<LITMUS_PORTAL_NAMESPACE> --devel
|
||||||
|
|
@ -67,15 +67,15 @@ Visit https://docs.litmuschaos.io/docs/getstarted/ to find more info.
|
||||||
|
|
||||||
### **Install Litmus using kubectl **
|
### **Install Litmus using kubectl **
|
||||||
|
|
||||||
#### **Create the namespace on which you want to install Litmus**
|
#### **Create the namespace on which you want to install Litmus ChaosCenter**
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
kubectl create ns <LITMUS_PORTAL_NAMESPACE>
|
kubectl create ns <LITMUS_PORTAL_NAMESPACE>
|
||||||
```
|
```
|
||||||
|
|
||||||
#### **Install Litmus**
|
#### **Install Litmus ChaosCenter**
|
||||||
|
|
||||||
Applying the manifest file will install all the required service account configuration and chaos control plane.
|
Applying the manifest file will install all the required service account configuration and ChaosCenter.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
kubectl apply -f https://litmuschaos.github.io/litmus/2.0.0-Beta/litmus-2.0.0-Beta.yaml -n <LITMUS_PORTAL_NAMESPACE>
|
kubectl apply -f https://litmuschaos.github.io/litmus/2.0.0-Beta/litmus-2.0.0-Beta.yaml -n <LITMUS_PORTAL_NAMESPACE>
|
||||||
|
|
@ -161,6 +161,6 @@ kubectl apply -f https://litmuschaos.github.io/litmus/2.0.0-Beta/litmus-2.0.0-Be
|
||||||
|
|
||||||
## Learn More
|
## Learn More
|
||||||
|
|
||||||
- [Install Litmus in Namespace Scope](namespace-scope-installation)
|
- [Install ChaosCenter in Namespace Scope](chaoscenter-namespace-scope-installation)
|
||||||
- [Setup Endpoints and Access Litmus without Ingress](setup-without-ingress)
|
- [Setup Endpoints and Access ChaosCenter without Ingress](setup-without-ingress)
|
||||||
- [Setup Endpoints and Access Litmus with Ingress](setup-with-ingress)
|
- [Setup Endpoints and Access ChaosCenter with Ingress](setup-with-ingress)
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
---
|
---
|
||||||
id: namespace-scope-installation
|
id: chaoscenter-namespace-scope-installation
|
||||||
title: Litmus Namespace Scope Installation
|
title: ChaosCenter Namespace Scope Installation
|
||||||
sidebar_label: Namespace Scope
|
sidebar_label: Namespace Scope
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
@ -19,9 +19,9 @@ Installation of Litmus can be done using either of the below methods
|
||||||
|
|
||||||
### **Install Litmus using Helm **
|
### **Install Litmus using Helm **
|
||||||
|
|
||||||
The helm chart will install all the required service account configuration and chaos control plane.
|
The helm chart will install all the required service account configuration and ChaosCenter.
|
||||||
|
|
||||||
The following steps will help you install litmus via helm.
|
The following steps will help you install Litmus ChaosCenter via helm.
|
||||||
|
|
||||||
#### Step-1: Add the litmus helm repository
|
#### Step-1: Add the litmus helm repository
|
||||||
|
|
||||||
|
|
@ -30,7 +30,7 @@ helm repo add litmuschaos https://litmuschaos.github.io/litmus-helm/
|
||||||
helm repo list
|
helm repo list
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Step-2: Create the namespace on which you want to install Litmus <span style={{color: '#909191'}}><b>[Required only if namespace isn't there]</b></span>
|
#### Step-2: Create the namespace on which you want to install Litmus ChaosCenter <span style={{color: '#909191'}}><b>[Required only if namespace isn't there]</b></span>
|
||||||
|
|
||||||
The Litmus infra components will be placed in this namespace.
|
The Litmus infra components will be placed in this namespace.
|
||||||
|
|
||||||
|
|
@ -38,7 +38,7 @@ The Litmus infra components will be placed in this namespace.
|
||||||
kubectl create ns <LITMUS_PORTAL_NAMESPACE>
|
kubectl create ns <LITMUS_PORTAL_NAMESPACE>
|
||||||
```
|
```
|
||||||
|
|
||||||
> The chaos control plane can be placed in any namespace, though it is typically placed in `litmus`. Ignore if you already have the namespace where you want to install Litmus created.
|
> The ChaosCenter can be placed in any namespace, though it is typically placed in `litmus`. Ignore if you already have the namespace where you want to install Litmus created.
|
||||||
|
|
||||||
#### Step-3: Install the required Litmus CRDs
|
#### Step-3: Install the required Litmus CRDs
|
||||||
|
|
||||||
|
|
@ -61,7 +61,7 @@ customresourcedefinition.apiextensions.k8s.io/chaosresults.litmuschaos.io create
|
||||||
customresourcedefinition.apiextensions.k8s.io/eventtrackerpolicies.eventtracker.litmuschaos.io created
|
customresourcedefinition.apiextensions.k8s.io/eventtrackerpolicies.eventtracker.litmuschaos.io created
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Step-4: Install the litmus chaos control plane
|
#### Step-4: Install Litmus ChaosCenter
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
helm install chaos litmuschaos/litmus-2-0-0-beta --namespace=<LITMUS_PORTAL_NAMESPACE> --devel --set portalScope=namespace
|
helm install chaos litmuschaos/litmus-2-0-0-beta --namespace=<LITMUS_PORTAL_NAMESPACE> --devel --set portalScope=namespace
|
||||||
|
|
@ -89,7 +89,7 @@ Visit https://docs.litmuschaos.io/docs/getstarted/ to find more info.
|
||||||
|
|
||||||
### **Install Litmus using kubectl **
|
### **Install Litmus using kubectl **
|
||||||
|
|
||||||
#### **Set the namespace on which you want to install Litmus**
|
#### **Set the namespace on which you want to install Litmus ChaosCenter**
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
export LITMUS_PORTAL_NAMESPACE="<namespace>"
|
export LITMUS_PORTAL_NAMESPACE="<namespace>"
|
||||||
|
|
@ -126,9 +126,9 @@ customresourcedefinition.apiextensions.k8s.io/chaosresults.litmuschaos.io create
|
||||||
customresourcedefinition.apiextensions.k8s.io/eventtrackerpolicies.eventtracker.litmuschaos.io created
|
customresourcedefinition.apiextensions.k8s.io/eventtrackerpolicies.eventtracker.litmuschaos.io created
|
||||||
```
|
```
|
||||||
|
|
||||||
#### **Install Litmus**
|
#### **Install Litmus ChaosCenter**
|
||||||
|
|
||||||
Applying the manifest file will install all the required service account configuration and chaos control plane.
|
Applying the manifest file will install all the required service account configuration and ChaosCenter.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
curl https://raw.githubusercontent.com/litmuschaos/litmus/master/docs/2.0.0-Beta/litmus-namespaced-2.0.0-Beta.yaml --output litmus-portal-namespaced-K8s-template.yml
|
curl https://raw.githubusercontent.com/litmuschaos/litmus/master/docs/2.0.0-Beta/litmus-namespaced-2.0.0-Beta.yaml --output litmus-portal-namespaced-K8s-template.yml
|
||||||
|
|
@ -234,6 +234,6 @@ service/mongo-service created
|
||||||
|
|
||||||
## Learn More
|
## Learn More
|
||||||
|
|
||||||
- [Install Litmus in Namespace Scope](namespace-scope-installation)
|
- [Install ChaosCenter in Cluster Scope](chaoscenter-cluster-scope-installation)
|
||||||
- [Setup Endpoints and Access Litmus without Ingress](setup-without-ingress)
|
- [Setup Endpoints and Access ChaosCenter without Ingress](setup-without-ingress)
|
||||||
- [Setup Endpoints and Access Litmus with Ingress](setup-with-ingress)
|
- [Setup Endpoints and Access ChaosCenter with Ingress](setup-with-ingress)
|
||||||
|
|
@ -1,20 +1,21 @@
|
||||||
---
|
---
|
||||||
id: chaos-control-plane
|
id: chaoscenter
|
||||||
title: Chaos Control Plane
|
title: ChaosCenter
|
||||||
sidebar_label: Chaos Control Plane
|
sidebar_label: ChaosCenter
|
||||||
---
|
---
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
The <span style={{color: '#5B44BA'}}>**Chaos Control Plane**</span> is a single source of truth to control all the different Chaos Activities happening around Litmus. From the Control Plane you get the freedom to manage every single part of Litmus and shape your workflows exactly the way you want it.
|
The <span style={{color: '#5B44BA'}}>**ChaosCenter**</span> is a single source of truth to control all the different Chaos Activities happening around Litmus. From the ChaosCenter you get the freedom to manage every single part of Litmus and shape your workflows exactly the way you want it.
|
||||||
|
|
||||||
The **Control Plane comes pre-packaged** as a part of LitmusChaos installation and can be easily accessed via <span style={{color: '#5B44BA'}}>Ingress, NodePort</span> or <span style={{color: '#5B44BA'}}>LoadBalancer</span>. Since Litmus has Cross-Cloud support, you get seamless access to the Plane irrespective of where you deploy it.
|
**ChaosCenter comes pre-packaged** as a part of LitmusChaos installation and can be easily accessed via <span style={{color: '#5B44BA'}}>Ingress, NodePort</span> or <span style={{color: '#5B44BA'}}>LoadBalancer</span>. Since Litmus has Cross-Cloud support, you get seamless access to the ChaosCenter irrespectively of where you deploy it.
|
||||||
|
|
||||||
>[Get a broader view of which Platforms are supported by Litmus](https://github.com/litmuschaos/litmus/tree/master/litmus-portal#platforms-support)
|
> [Get a broader view of which Platforms are supported by Litmus](https://github.com/litmuschaos/litmus/tree/master/litmus-portal#platforms-support)
|
||||||
|
|
||||||
|
The ChaosCenter gives you access to a plethora of features, the major ones include
|
||||||
|
|
||||||
The Chaos Control Plane gives you access to a plethora of features, the major ones include
|
|
||||||
- Workflow Creation
|
- Workflow Creation
|
||||||
<span style={{color: '#909191'}}>
|
<span style={{color: '#909191'}}>
|
||||||
<ul>
|
<ul>
|
||||||
<li>From Templates, Custom Workflows from Scratch (using ChaosHubs), From pre-created YAMLs</li>
|
<li>From Templates, Custom Workflows from Scratch (using ChaosHubs), From pre-created YAMLs</li>
|
||||||
<li>Chaos Experiments Sequence Control (Parallel as well as Sequential steps creation)</li>
|
<li>Chaos Experiments Sequence Control (Parallel as well as Sequential steps creation)</li>
|
||||||
|
|
@ -23,7 +24,7 @@ The Chaos Control Plane gives you access to a plethora of features, the major on
|
||||||
</ul>
|
</ul>
|
||||||
</span>
|
</span>
|
||||||
- Users & Teams
|
- Users & Teams
|
||||||
<span style={{color: '#909191'}}>
|
<span style={{color: '#909191'}}>
|
||||||
<ul>
|
<ul>
|
||||||
<li>Creation of Users with Role Based Access Control</li>
|
<li>Creation of Users with Role Based Access Control</li>
|
||||||
<li>Creating a Team of multiple Users</li>
|
<li>Creating a Team of multiple Users</li>
|
||||||
|
|
@ -31,7 +32,7 @@ The Chaos Control Plane gives you access to a plethora of features, the major on
|
||||||
</ul>
|
</ul>
|
||||||
</span>
|
</span>
|
||||||
- Monitoring & Observability
|
- Monitoring & Observability
|
||||||
<span style={{color: '#909191'}}>
|
<span style={{color: '#909191'}}>
|
||||||
<ul>
|
<ul>
|
||||||
<li>Connect a Data Source (from any Agent) and monitor workflows</li>
|
<li>Connect a Data Source (from any Agent) and monitor workflows</li>
|
||||||
<li>Visualize workflow run statistics and aggregated schedules</li>
|
<li>Visualize workflow run statistics and aggregated schedules</li>
|
||||||
|
|
@ -42,7 +43,7 @@ The Chaos Control Plane gives you access to a plethora of features, the major on
|
||||||
</ul>
|
</ul>
|
||||||
</span>
|
</span>
|
||||||
- Workflow Management
|
- Workflow Management
|
||||||
<span style={{color: '#909191'}}>
|
<span style={{color: '#909191'}}>
|
||||||
<ul>
|
<ul>
|
||||||
<li>Rolling out automated changes using GitOps</li>
|
<li>Rolling out automated changes using GitOps</li>
|
||||||
<li>Allowing image addition from custom image server (both public and private)</li>
|
<li>Allowing image addition from custom image server (both public and private)</li>
|
||||||
|
|
@ -1,187 +0,0 @@
|
||||||
---
|
|
||||||
id: litmusctl
|
|
||||||
title: LitmusCTL
|
|
||||||
sidebar_label: LitmusCTL
|
|
||||||
---
|
|
||||||
|
|
||||||
## Litmusctl
|
|
||||||
|
|
||||||
Litmusctl is a command line interface to manage LitmusPortal services.
|
|
||||||
|
|
||||||
### 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`.
|
|
||||||
|
|
||||||
### Installation
|
|
||||||
|
|
||||||
To install the latest version of litmusctl follow the below steps:
|
|
||||||
|
|
||||||
- Download the latest litmusctl(master) binary from:
|
|
||||||
|
|
||||||
| Platforms | Download Link |
|
|
||||||
| ------------------------------ | ------------------------------------------------------------------------------------------------------- |
|
|
||||||
| litmusctl-darwin-386 (MacOS) | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-darwin-386-master.tar.gz) |
|
|
||||||
| litmusctl-darwin-amd64 (MacOS) | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-darwin-amd64-master.tar.gz) |
|
|
||||||
| litmusctl-linux-386 | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-linux-386-master.tar.gz) |
|
|
||||||
| litmusctl-linux-amd64 | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-linux-amd64-master.tar.gz) |
|
|
||||||
| litmusctl-linux-arm | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-linux-arm-master.tar.gz) |
|
|
||||||
| litmusctl-linux-arm64 | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-linux-arm64-master.tar.gz) |
|
|
||||||
| litmusctl-windows-386 | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-windows-386-master.tar.gz) |
|
|
||||||
| litmusctl-windows-amd64 | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-windows-amd64-master.tar.gz) |
|
|
||||||
| litmusctl-windows-arm | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-windows-arm-master.tar.gz) |
|
|
||||||
|
|
||||||
<br />
|
|
||||||
|
|
||||||
- Download the litmusctl(v0.2.0) binary from:
|
|
||||||
|
|
||||||
| Platforms | Download Link |
|
|
||||||
| ------------------------------ | ------------------------------------------------------------------------------------------------------- |
|
|
||||||
| litmusctl-darwin-386 (MacOS) | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-darwin-386-v0.2.0.tar.gz) |
|
|
||||||
| litmusctl-darwin-amd64 (MacOS) | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-darwin-amd64-v0.2.0.tar.gz) |
|
|
||||||
| litmusctl-linux-386 | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-linux-386-v0.2.0.tar.gz) |
|
|
||||||
| litmusctl-linux-amd64 | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-linux-amd64-v0.2.0.tar.gz) |
|
|
||||||
| litmusctl-linux-arm | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-linux-arm-v0.2.0.tar.gz) |
|
|
||||||
| litmusctl-linux-arm64 | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-linux-arm64-v0.2.0.tar.gz) |
|
|
||||||
| litmusctl-windows-386 | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-windows-386-v0.2.0.tar.gz) |
|
|
||||||
| litmusctl-windows-amd64 | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-windows-amd64-v0.2.0.tar.gz) |
|
|
||||||
| litmusctl-windows-arm | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-windows-arm-v0.2.0.tar.gz) |
|
|
||||||
|
|
||||||
<br />
|
|
||||||
|
|
||||||
- Extract the binary
|
|
||||||
|
|
||||||
```bash
|
|
||||||
tar -zxvf litmusctl-<OS>-<ARCH>-<VERSION>.tar.gz
|
|
||||||
```
|
|
||||||
|
|
||||||
- Provide necessary permissions
|
|
||||||
|
|
||||||
```bash
|
|
||||||
chmod +x litmusctl
|
|
||||||
```
|
|
||||||
|
|
||||||
- Move the litmusctl binary to /usr/local/bin/litmusctl
|
|
||||||
|
|
||||||
```bash
|
|
||||||
sudo mv litmusctl /usr/local/bin/litmusctl
|
|
||||||
```
|
|
||||||
|
|
||||||
### Basic Commands
|
|
||||||
|
|
||||||
litmusctl CLI command has the following structure:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
litmusctl <command> <subcommand> <subcommand> [options and parameters]
|
|
||||||
```
|
|
||||||
|
|
||||||
To get the version of the litmusctl CLI:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
litmusctl version
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Connecting an agent
|
|
||||||
|
|
||||||
To connect Litmus Chaos agent:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
litmusctl agent connect
|
|
||||||
```
|
|
||||||
|
|
||||||
Next, you need to enter LitmusPortal details to login into your LitmusPortal account. Fields to be filled in:
|
|
||||||
|
|
||||||
**LitmusPortal UI URL:** Enter the URL used to access the Litmus Portal UI.
|
|
||||||
|
|
||||||
> For Example `http://172.17.0.2:31696/`
|
|
||||||
|
|
||||||
**Username:** Enter your LitmusPortal username.<br />
|
|
||||||
**Password:** Enter your LitmusPortal password.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
🔥 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 exiting projects displayed on the terminal. Select the desired project by entering the sequence number indicated against it.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
✨ Projects List:
|
|
||||||
1. abc
|
|
||||||
|
|
||||||
🔎 Select Project: 1
|
|
||||||
```
|
|
||||||
|
|
||||||
Next, select the installation mode. In case the selected mode was a Cluster there will be a prerequisites check to verify ClusterRole and ClusterRoleBinding.
|
|
||||||
|
|
||||||
```shell
|
|
||||||
🔌 Installation Modes:
|
|
||||||
1. Cluster
|
|
||||||
2. Namespace
|
|
||||||
|
|
||||||
👉 Select Mode [cluster]: 1
|
|
||||||
|
|
||||||
🏃 Running prerequisites check....
|
|
||||||
🔑 clusterrole - ✅
|
|
||||||
🔑 clusterrolebinding - ✅
|
|
||||||
|
|
||||||
🌟 Sufficient permissions. Connecting Agent
|
|
||||||
```
|
|
||||||
|
|
||||||
Next, enter the details of the new agent.
|
|
||||||
|
|
||||||
**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 or enter a new namespace. In cases where the namespace does not exist, LitmusPortal creates it for you.
|
|
||||||
|
|
||||||
**Enter service account:** Enter a name for your service account.
|
|
||||||
|
|
||||||
```shell
|
|
||||||
🔗 Enter the details of the agent ----
|
|
||||||
🤷 Agent Name: my-agent
|
|
||||||
📘 Agent Description: This is a new 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.
|
|
||||||
|
|
||||||
```shell
|
|
||||||
📌 Summary --------------------------
|
|
||||||
|
|
||||||
Agent Name: my-agent
|
|
||||||
Agent Description: This is a new agent.
|
|
||||||
Platform Name: Others
|
|
||||||
Namespace: litmus
|
|
||||||
Service Account: litmus
|
|
||||||
Installation Mode: cluster
|
|
||||||
|
|
||||||
-------------------------------------
|
|
||||||
|
|
||||||
🤷 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
|
|
||||||
```
|
|
||||||
|
|
||||||
To verify, if the connection process was successful you can view the list of connected agents from the Targets section on your LitmusPortal and ensure that the connected agent is in Active State.
|
|
||||||
|
|
@ -8,14 +8,14 @@ sidebar_label: Setup With Ingress
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
Before setting up endpoint with Ingress make sure the [Litmus Chaos Control Plane](chaos-control-plane) is installed in either one of these scopes
|
Before setting up endpoint with Ingress make sure the [Litmus ChaosCenter](chaoscenter) is installed in either one of these scopes
|
||||||
|
|
||||||
- [Cluster Scope](cluster-scope-installation)
|
- [Cluster Scope](chaoscenter-cluster-scope-installation)
|
||||||
- [Namespace Scope](namespace-scope-installation)
|
- [Namespace Scope](chaoscenter-namespace-scope-installation)
|
||||||
|
|
||||||
## Install LitmusPortal with Ingress
|
## Install ChaosCenter with Ingress
|
||||||
|
|
||||||
With Litmus-2.0.0-Beta3, LitmusPortal can be installed with ingress.
|
With Litmus-2.0.0-Beta3, ChaosCenter can be installed with ingress.
|
||||||
In the following doc, we will use the Nginx ingress controller for ingress setup.
|
In the following doc, we will use the Nginx ingress controller for ingress setup.
|
||||||
|
|
||||||
1. By default, the service type is `NodePort`. For Ingress, we need to change the service type to `ClusterIP` in the following services.
|
1. By default, the service type is `NodePort`. For Ingress, we need to change the service type to `ClusterIP` in the following services.
|
||||||
|
|
@ -156,6 +156,6 @@ kubectl apply -f <litmus_ingress_manifest> -n <PORTAL_NAMESPACE>
|
||||||
|
|
||||||
## Learn More
|
## Learn More
|
||||||
|
|
||||||
- [Setup Endpoints and Access Litmus without Ingress](setup-without-ingress)
|
- [Setup Endpoints and Access ChaosCenter without Ingress](setup-without-ingress)
|
||||||
- [Install Litmus in Namespace Scope](namespace-scope-installation)
|
- [Install ChaosCenter in Namespace Scope](chaoscenter-namespace-scope-installation)
|
||||||
- [Install Litmus in Cluster Scope](cluster-scope-installation)
|
- [Install ChaosCenter in Cluster Scope](chaoscenter-cluster-scope-installation)
|
||||||
|
|
|
||||||
|
|
@ -6,10 +6,10 @@ sidebar_label: Setup without Ingress
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
Before setting up endpoint with Ingress make sure the [Litmus Chaos Control Plane](chaos-control-plane) is installed in either one of these scopes
|
Before setting up endpoint with Ingress make sure the [Litmus ChaosCenter](chaoscenter) is installed in either one of these scopes
|
||||||
|
|
||||||
- [Cluster Scope](cluster-scope-installation)
|
- [Cluster Scope](chaoscenter-cluster-scope-installation)
|
||||||
- [Namespace Scope](namespace-scope-installation)
|
- [Namespace Scope](chaoscenter-namespace-scope-installation)
|
||||||
|
|
||||||
## **With NodePort**
|
## **With NodePort**
|
||||||
|
|
||||||
|
|
@ -47,9 +47,9 @@ litmusportal-frontend-service NodePort 10.101.81.70 <none> 9091:
|
||||||
litmusportal-server-service NodePort 10.108.151.79 <none> 9002:32456/TCP,9003:31160/TCP 2m
|
litmusportal-server-service NodePort 10.108.151.79 <none> 9002:32456/TCP,9003:31160/TCP 2m
|
||||||
```
|
```
|
||||||
|
|
||||||
## **Accessing the Portal**
|
## **Accessing the ChaosCenter**
|
||||||
|
|
||||||
Once you have the PORT copied in your clipboard, simply use your IP and PORT in this manner `<IP>:<PORT>` to access the portal.
|
Once you have the PORT copied in your clipboard, simply use your IP and PORT in this manner `<IP>:<PORT>` to access the Litmus ChaosCenter.
|
||||||
|
|
||||||
For example:
|
For example:
|
||||||
|
|
||||||
|
|
@ -59,7 +59,7 @@ http://172.17.0.3:30385/
|
||||||
|
|
||||||
> Where `172.17.0.3` is my NodeIP and `30385` is the frontend service PORT. If using a LoadBalancer, the only change would be to provide a `<LoadBalancerIP>:<PORT>`
|
> Where `172.17.0.3` is my NodeIP and `30385` is the frontend service PORT. If using a LoadBalancer, the only change would be to provide a `<LoadBalancerIP>:<PORT>`
|
||||||
|
|
||||||
You should be able to see the Login Page of Litmus. The **default credentials** are
|
You should be able to see the Login Page of Litmus ChaosCenter. The **default credentials** are
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
Username: admin
|
Username: admin
|
||||||
|
|
@ -106,6 +106,6 @@ Password: litmus
|
||||||
|
|
||||||
## Learn More
|
## Learn More
|
||||||
|
|
||||||
- [Setup Endpoints and Access Litmus with Ingress](setup-with-ingress)
|
- [Setup Endpoints and Access ChaosCenter with Ingress](setup-with-ingress)
|
||||||
- [Install Litmus in Namespace Scope](namespace-scope-installation)
|
- [Install ChaosCenter in Namespace Scope](chaoscenter-namespace-scope-installation)
|
||||||
- [Install Litmus in Cluster Scope](cluster-scope-installation)
|
- [Install ChaosCenter in Cluster Scope](chaoscenter-cluster-scope-installation)
|
||||||
|
|
|
||||||
|
|
@ -12,22 +12,22 @@ module.exports = {
|
||||||
Prerequisites: [
|
Prerequisites: [
|
||||||
'basic-requirements',
|
'basic-requirements',
|
||||||
{
|
{
|
||||||
Resources: ['chaos-control-plane', 'agents']
|
Resources: ['chaoscenter', 'chaosagents']
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
Installation: [
|
Installation: [
|
||||||
{
|
{
|
||||||
'Control Plane': [
|
ChaosCenter: [
|
||||||
'cluster-scope-installation',
|
'chaoscenter-cluster-scope-installation',
|
||||||
'namespace-scope-installation',
|
'chaoscenter-namespace-scope-installation',
|
||||||
'setup-without-ingress',
|
'setup-without-ingress',
|
||||||
'setup-with-ingress'
|
'setup-with-ingress'
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
'Chaos Plane': ['agent-install', 'litmusctl']
|
ChaosAgents: ['chaosagents-cluster-scope-installation', 'chaosagents-namespace-scope-installation']
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue