Added litmus v2.10.0 docs and updated litmusctl docs (#194)

* Added litmus v2.10.0 docs and updated litmusctl docs

Signed-off-by: Sarthak Jain <[email protected]>

Author: SarthakJain26

website/docs/litmusctl/chaos-workflow-creation.md

@@ -0,0 +1,127 @@
+---
+id: chaos-workflow-creation
+title: Create Chaos Workflows using Litmusctl
+sidebar_label: Create Chaos Workflows
+---
+
+---
+
+# Usage: Litmusctl v0.10.0
+
+> Notes:
+>
+> - For litmusctl v0.10.0 or latest
+> - Compatible with Litmus 2.9.0 or latest
+### litmusctl Syntax
+
+`litmusctl` has a syntax to use as follows:
+
+```shell
+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.
+
+---
+
+### Steps to create a Chaos Workflow
+
+* To setup an account with litmusctl
+```shell
+litmusctl config set-account --endpoint="" --username="" --password=""
+```
+
+* To create a Chaos Workflow by passing a manifest file
+> Note:
+> * To get `project-id`, apply `litmusctl get projects`
+> * To get `agent-id`, apply `litmusctl get agents --project-id=""`
+```shell
+litmusctl create workflow -f custom-chaos-workflow.yml --project-id="" --agent-id=""
+```
+#### Verify the new Chaos Workflow
+
+To verify the successful creation, you can either view the list of chaos workflows at the ChaosCenter dashboard or run the below given command to list the chaos workflow within a given project.
+
+```shell
+litmusctl get workflows --project-id=""
+```
+
+**Output:**
+
+```
+WORKFLOW ID                          WORKFLOW NAME                    WORKFLOW TYPE     NEXT SCHEDULE AGENT ID                             AGENT NAME LAST UPDATED BY
+9433b48c-4ab7-4544-8dab-4a7237619e09 custom-chaos-workflow-1627980541 Non Cron Workflow None          f9799723-29f1-454c-b830-ae8ba7ee4c30 Self-Agent admin
+Showing 1 of 1 workflows
+```
+
+---
+
+### Additional commands
+
+* To list all the chaos workflow runs within a project, issue the following command.
+```shell
+litmusctl get workflowruns --project-id=""
+```
+
+**Output:**
+
+```
+WORKFLOW RUN ID                      STATUS  RESILIENCY SCORE WORKFLOW ID                          WORKFLOW NAME                    TARGET AGENT LAST RUN                 EXECUTED BY
+8ceb712c-1ed4-40e6-adc4-01f78d281506 Running 0.00             9433b48c-4ab7-4544-8dab-4a7237619e09 custom-chaos-workflow-1627980541 Self-Agent   June 1 2022, 10:28:02 pm admin
+Showing 1 of 1 workflow runs
+```
+
+
+* To describe a particular chaos workflow, issue the following command.
+```shell
+litmusctl describe workflow 9433b48c-4ab7-4544-8dab-4a7237619e09 --project-id=""
+```
+
+**Output:**
+
+```
+apiVersion: argoproj.io/v1alpha1
+kind: Workflow
+metadata:
+    creationTimestamp: null
+    labels:
+        cluster_id: f9799723-29f1-454c-b830-ae8ba7ee4c30
+        subject: custom-chaos-workflow_litmus
+        workflow_id: 9433b48c-4ab7-4544-8dab-4a7237619e09
+        workflows.argoproj.io/controller-instanceid: f9799723-29f1-454c-b830-ae8ba7ee4c30
+    name: custom-chaos-workflow-1627980541
+    namespace: litmus
+spec:
+...
+```
+
+
+* To delete a particular chaos workflow, issue the following command.
+```shell
+litmusctl delete workflow df91c6b2-ad33-45ae-9a2f-00cb87978657 --project-id=""
+```
+
+**Output:**
+
+```
+🚀 ChaosWorkflow successfully deleted.
+```
+
+For more information related to flags, Use `litmusctl --help`.
+
+---
+
+## Learn More
+
+- [Learn More about Litmusctl](installation.md)
+- [Installing ChaosAgents in interactive mode](./usage-interactive-mode.md)
+- [Installing ChaosAgents in non interactive mode](./usage-non-interactive-mode.md)
+- [Setup Endpoints and Access ChaosCenter without Ingress](../user-guides/setup-without-ingress.md)
+- [Setup Endpoints and Access ChaosCenter with Ingress](../user-guides/setup-with-ingress.md)

website/docs/litmusctl/usage-interactive-mode.md

@@ -6,12 +6,12 @@ sidebar_label: Using interactive mode
 
 ---
 
-# Usage: Litmusctl v0.3.0
+# Usage: Litmusctl v0.10.0
 
 > Notes:
 >
-> - For litmusctl v0.3.0 or latest
-> - Compatible with Litmus 2.0.0 or latest
+> - For litmusctl v0.10.0 or latest
+> - Compatible with Litmus 2.9.0 or latest
 
 ### litmusctl Syntax
 
@@ -32,11 +32,11 @@ Litmusctl is using the `.litmusconfig` config file to manage multiple accounts
 
 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.
+> Only `litmusctl connect 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](installation.md)
 
-### Steps to create an agent
+### Steps to connect an agent
 
 - To setup an account with litmusctl
 
@@ -61,10 +61,10 @@ Password:
 account.username/admin configured
 ```
 
-- To create an agent in a cluster mode
+- To connect an agent in a cluster mode
 
 ```shell
-litmusctl create agent
+litmusctl connect 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.
@@ -271,9 +271,21 @@ Enter the Project ID: 50addd40-8767-448c-a91a-5071543a2d8e
 **Output:**
 
 ```
-AGENTID                                AGENTNAME          STATUS
-55ecc7f2-2754-43aa-8e12-6903e4c6183a   agent-1            ACTIVE
-13dsf3d1-5324-54af-4g23-5331g5v2364f   agent-2            INACTIVE
+AGENTID                                AGENTNAME          STATUS     REGISTRATION
+55ecc7f2-2754-43aa-8e12-6903e4c6183a   agent-1            ACTIVE     REGISTERED
+13dsf3d1-5324-54af-4g23-5331g5v2364f   agent-2            INACTIVE   NOT REGISTERED                                         
+```
+
+- To disconnect an agent, issue the following command.
+
+```shell
+litmusctl disconnect agent 55ecc7f2-2754-43aa-8e12-6903e4c6183a --project-id=""
+```
+
+**Output:**
+
+```
+🚀 ChaosAgent successfully disconnected.
 ```
 
 For more information related to flags, Use `litmusctl --help`.
@@ -282,5 +294,6 @@ For more information related to flags, Use `litmusctl --help`.
 
 - [Learn More about Litmusctl](installation.md)
 - [Installing ChaosAgents in non interactive mode](./usage-non-interactive-mode.md)
+- [Create Chaos Workflows using Litmusctl](./chaos-workflow-creation.md)
 - [Setup Endpoints and Access ChaosCenter without Ingress](../user-guides/setup-without-ingress.md)
 - [Setup Endpoints and Access ChaosCenter with Ingress](../user-guides/setup-with-ingress.md)

website/docs/litmusctl/usage-non-interactive-mode.md

@@ -6,10 +6,10 @@ sidebar_label: Using non interactive mode
 
 ---
 
-# Usage: Litmusctl v0.3.0
+# Usage: Litmusctl v0.10.0
 > Notes:
-> * For litmusctl v0.3.0 or latest
-> * Compatible with Litmus 2.0.0 or latest
+> * For litmusctl v0.10.0 or latest
+> * Compatible with Litmus 2.9.0 or latest
 
 ### litmusctl Syntax
 `litmusctl` has a syntax to use as follows:
@@ -26,7 +26,7 @@ Litmusctl is using the `.litmusconfig` config file to manage multiple accounts
 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.
+> Only `litmusctl connect 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.
 
 ### Installation modes
 Litmusctl can install an agent in two different modes.
@@ -36,33 +36,33 @@ Litmusctl can install an agent in two different modes.
 
 Note: With namespace mode, the user needs to create the namespace to install the agent as a prerequisite.
 
-### Minimal steps to create an agent
+### Minimal steps to connect an agent
 
 * To setup an account with litmusctl
 ```shell
 litmusctl config set-account --endpoint="" --username="" --password=""
 ```
 
-* To create an agent without a project in a cluster mode
+* To connect an agent without a project in a cluster mode
 >Note: If the user doesn't have any project, it will create a random project and add the agent in that random project.
 ```shell
-litmusctl create agent --agent-name="" --non-interactive
+litmusctl connect agent --agent-name="" --non-interactive
 ```
 
 Or,
 
-* To create an agent with an existing project
+* To connect an agent with an existing project
 > Note: To get `project-id`. Apply `litmusctl get projects`
 
 ```shell
-litmusctl create agent --agent-name="" --project-id="" --non-interactive
+litmusctl connect agent --agent-name="" --project-id="" --non-interactive
 ```
 
 #### 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.
 
-### Flags for `create agent` command
+### Flags for `connect agent` command
 <table>
     <th>Flag</th>
     <th>Short Flag</th>
@@ -219,18 +219,28 @@ litmusctl get agents --project-id=""
 **Output:**
 
 ```
-AGENTID                                AGENTNAME          STATUS 
-55ecc7f2-2754-43aa-8e12-6903e4c6183a   agent-1            ACTIVE 
-13dsf3d1-5324-54af-4g23-5331g5v2364f   agent-2            INACTIVE
+AGENTID                                AGENTNAME          STATUS     REGISTRATION
+55ecc7f2-2754-43aa-8e12-6903e4c6183a   agent-1            ACTIVE     REGISTERED
+13dsf3d1-5324-54af-4g23-5331g5v2364f   agent-2            INACTIVE   NOT REGISTERED                                         
 ```
 
-For more information related to flags, Use `litmusctl --help`.
+- To disconnect an agent, issue the following command.
+
+```shell
+litmusctl disconnect agent 55ecc7f2-2754-43aa-8e12-6903e4c6183a --project-id=""
+```
+
+**Output:**
+
+```
+🚀 ChaosAgent successfully disconnected.
+```
 
----
 
 ## Learn More
 
 - [Learn More about Litmusctl](installation.md)
 - [Installing ChaosAgents in interactive mode](./usage-interactive-mode.md)
+- [Create Chaos Workflows using Litmusctl](./chaos-workflow-creation.md)
 - [Setup Endpoints and Access ChaosCenter without Ingress](../user-guides/setup-without-ingress.md)
 - [Setup Endpoints and Access ChaosCenter with Ingress](../user-guides/setup-with-ingress.md)

website/sidebars.js

@@ -161,7 +161,8 @@ module.exports = {
         'litmusctl/installation',
         {
           'Connect Agent': ['litmusctl/usage-non-interactive-mode', 'litmusctl/usage-interactive-mode']
-        }
+        },
+        'litmusctl/chaos-workflow-creation'
       ]
     },
 

website/versioned_docs/version-2.10.0/architecture/architecture-summary.md

@@ -0,0 +1,16 @@
+---
+id: architecture-summary
+title: Architecture Summary
+sidebar_label: Architecture Summary
+---
+
+---
+<img src={require("../assets/architecture-summary.png").default} alt="Architecture Overview" />
+
+The Litmus architecture can be segregated into two parts:
+
+1. **Control Plane:** Contains the components required for the functioning of Chaos Center, the website-based portal for Litmus.
+
+2. **Execution Plane:** Contains the components required for the injection of chaos in the target resources.
+
+Chaos Center can be used for creating, scheduling, and monitoring Chaos Workflows, a set of chaos experiments defined in a definitive sequence to achieve desired chaos impact on the target resources upon execution. Users can log in to the Chaos Center using valid login credentials and leverage the interactive web UI to define their chaos workflow to target multiple aspects of their infrastructure. Once the user creates a Chaos Workflow using the Chaos Center, it is passed on to the Execution Plane. The Execution Plane can be present either in the host cluster containing the Control Plane if the self agent is being used, or in the target cluster if an external agent is being used. The Execution Plane interprets the Chaos Workflow as a list of steps required for injecting chaos into the target resources. It ensures efficient orchestration of chaos in cloud-native environments using various Kubernetes CRs. Once the Chaos Workflow is executed, Execution Plane sends the chaos result to the Control Plane for their post-processing using either the built-in monitoring dashboard of Litmus or using external observability tools such as Prometheus DB and Grafana dashboard. Litmus also achieves automated Chaos Workflow runs to execute chaos as part of the CI/CD pipeline based on a set of defined conditions using GitOps. 

website/versioned_docs/version-2.10.0/architecture/chaos-control-plane.md

@@ -0,0 +1,40 @@
+---
+id: chaos-control-plane
+title: Chaos Control Plane
+sidebar_label: Chaos Control Plane
+---
+
+---
+
+<img src={require("../assets/chaos-control-plane.png").default} alt="Chaos Control Plane" />
+
+Chaos Control Plane consists of micro-services responsible for the functioning of the Chaos Center, the website-based portal that can be used for interacting with Litmus, apart from the CLI. Chaos Plane facilitates the creation and scheduling of chaos workflows, system observability during the event of chaos, and post-processing and analysis of experiment results. 
+
+## Chaos Control Plane Components
+
+* **Authentication Server:** A Golang micro-service that is responsible for authorizing, authenticating the requests received from Chaos Center and managing users along with their projects. It primarily serves the cause of user creation, user login, resetting the password, updating user information, creating project, managing project related operations.
+
+* **Backend Server:** A GraphQL based Golang micro-service that serves the requests received from Chaos Center, by either querying the database for the relevant information or by fetching information from the Execution Plane.
+
+* **Database:** A NoSQL MongoDB database micro-service that is accountable for storing users' information, past workflows, saved workflow templates, user projects, ChaosHubs, and GitOps details, among the other information.
+
+* **Chaos Center:** Refers to the interfaces used by Litmus for creation and scheduling of chaos workflows, system observability during chaos injection, and post chaos result analysis. It includes: 
+
+  * **Web UI:** A React.js based frontend application micro-service with built-in system observability capabilities and an analytics dashboard. It also facilitates teams of users to collaborate over  chaos workflows using role-based user accounts.
+
+  * **Litmusctl:** A command-line tool that allows management of Litmus Agent Infrastructure components. It can be used to create agents, project, and manage multiple Litmus accounts.
+
+  * **Litmus API:** Refers to two different Litmus APIs, namely Litmus Authentication API and Litmus Portal API:
+
+    * **Litmus Authentication API:** Used to authenticate the identity of a user and to perform several user and project specific tasks like create new users, update profile, update password, create project, invite users to project, get project details etc. It uses the Authentication Server to perform these tasks.
+
+    * **Litmus Portal API:** Provides command-line and UI experience for managing and monitoring the events around chaos workflows. It uses the Backend Server to perform its functions.
+
+## Standard Chaos Control Plane Flow
+
+1. The User logs in to the ChaosCenter using a valid login credential. A default project is created for the user on initial login. Every user is a part of a project and has a role assigned to them. To schedule a workflow, the user needs to have an Editor or Owner role assigned in the project.
+2. The user uploads a Chaos Workflow manifest using the ChaosCenter, which is received by the Backend Server.
+3. Backend Server stores the manifest in the Database and also sends it to the Chaos Agent.
+4. Chaos Agent uses the Chaos Workflow manifest to inject chaos into the target resources. The steps of the Chaos Workflow execution can be visualized using the ChaosCenter.
+5. Chaos Agent returns the results of the chaos experiments that were a part of the workflow back to the Backend Server, along with the experiment logs.
+6. Backend Server then sends the chaos experiment results and logs to the ChaosCenter. It also stores the results into the Database for generating post-chaos workflow statistics and information.