- - Download the latest litmusctl(master) binary from: | Platforms | Download Link | @@ -59,6 +43,22 @@ To install the latest version of litmusctl follow the below steps:
+- 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) | + +
+ - Extract the binary ```shell diff --git a/website/docs/getstarted.md b/website/docs/getstarted.md index 37b1627e..68e21b4a 100644 --- a/website/docs/getstarted.md +++ b/website/docs/getstarted.md @@ -12,16 +12,15 @@ sidebar_label: Pre-requisites - Persistent volume of 20GB - Recommend to have a Persistent volume(PV) of 20GB, You can start with 1GB for test purposes as well. This PV is used as persistent storage to store the chaos config and chaos-metrics in the Portal. By default, litmus install would use the default storage class to allocate the PV. Provide this value + Recommend to have a Persistent volume(PV) of 20GB, You can start with 1GB for test purposes as well. This PV is used as persistent storage to store the chaos config and chaos-metrics in the Portal. By default, litmus install would use the default storage class to allocate the PV. Provide this value - Helm3 or Kubectl - ## Getting Started Running chaos on your application involves the following steps: -[Install Litmus](litmus-install) +[Install Litmus](litmus-install-cluster-mode) [How to Create and Run a Workflow](create-workflow) diff --git a/website/docs/litmus-installation.md b/website/docs/litmus-installation-cluster.md similarity index 86% rename from website/docs/litmus-installation.md rename to website/docs/litmus-installation-cluster.md index 60b7c37b..9a87d653 100644 --- a/website/docs/litmus-installation.md +++ b/website/docs/litmus-installation-cluster.md @@ -1,7 +1,7 @@ --- -id: litmus-install -title: Litmus Chaos Control Plane -sidebar_label: Control Plane +id: litmus-install-cluster-mode +title: Litmus Chaos Control Plane (Cluster Mode) +sidebar_label: Control Plane (Cluster Mode) --- --- @@ -12,17 +12,16 @@ sidebar_label: Control Plane - Kubernetes 1.15 or later. -- Persistent volume of 20GB - - Recommend to have a Persistent volume(PV) of 20GB, You can start with 1GB for test purposes as well. This PV is used as persistent storage to store the chaos config and chaos-metrics in the Portal. By default, litmus install would use the default storage class to allocate the PV. Provide this value +- Recommend to have a Persistent volume(PV) of 20GB, You can start with 1GB for test purposes as well. This PV is used as persistent storage to store the chaos config and chaos-metrics in the Portal. By default, litmus would use the default storage class to allocate the PV. - Helm3 or Kubectl -## Installation +## Installation Installation of Litmus can be done using either of the below methods -- [Helm3](#helm_install) chart or -- [Kubectl](#kubectl_install) yaml spec file + +- [Helm3](#helm_install) chart or +- [Kubectl](#kubectl_install) yaml spec file ### Installation Steps @@ -58,19 +57,13 @@ namespace/litmus created ```bash root@demo:~# helm install chaos litmuschaos/litmus-2-0-0-beta --namespace=litmus --devel -NAME: chaos -LAST DEPLOYED: Fri Sep 29 06:19:50 2020 -NAMESPACE: litmus -STATUS: deployed -REVISION: 1 -TEST SUITE: None ``` Expected Output ``` NAME: chaos -LAST DEPLOYED: Mon Mar 15 18:27:42 2021 +LAST DEPLOYED: Tue Jun 15 19:20:09 2021 NAMESPACE: litmus STATUS: deployed REVISION: 1 @@ -81,27 +74,30 @@ Thank you for installing litmus-2-0-0-beta 😀 Your release is named chaos and its installed to namespace: litmus. Visit https://docs.litmuschaos.io/docs/getstarted/ to find more info. + ``` > **Note:** Litmus uses Kubernetes CRDs to define chaos intent. Helm3 handles CRDs better than Helm2. Before you start running a chaos experiment, verify if Litmus is installed correctly. ### **Install Litmus using kubectl ** -#### **Create a Litmus namespace in Kubernetes** +#### **Create a Litmus namespace in Kubernetes** ```bash kubectl create ns litmus ``` + #### **Install Litmus** Applying the manifest file will install all the required service account configuration and chaos control plane. + ```bash kubectl apply -f https://litmuschaos.github.io/litmus/2.0.0-Beta/litmus-2.0.0-Beta.yaml ``` ## **Verify your installation** -**Verify if the frontend, backend, and database Pods are running** +**Verify if the frontend, server, and database pod are running** ```bash kubectl get pods -n litmus @@ -115,8 +111,6 @@ chaos-litmus-portal-mongo-6764cfdd59-c9r56 1/1 Running 0 2m6s chaos-litmus-portal-server-5ffbccbfff-dknv8 2/2 Running 0 2m6s ``` -
- ## **Setup the Portal** To setup and login to Litmus Portal expand the available services just created and copy the `PORT` of the `litmusportal-frontend-service` service diff --git a/website/docs/litmus-installation-namespace.md b/website/docs/litmus-installation-namespace.md new file mode 100644 index 00000000..08383533 --- /dev/null +++ b/website/docs/litmus-installation-namespace.md @@ -0,0 +1,236 @@ +--- +id: litmus-install-namespace-mode +title: Litmus Chaos Control Plane (Namespace Mode) +sidebar_label: Control Plane (Namespace Mode) +--- + +--- + + + +## Pre-requisites + +- Kubernetes 1.15 or later. + +- Recommend to have a Persistent volume(PV) of 20GB, You can start with 1GB for test purposes as well. This PV is used as persistent storage to store the chaos config and chaos-metrics in the Portal. By default, litmus would use the default storage class to allocate the PV. + +- Helm3 or Kubectl + +## Installation + +Installation of Litmus can be done using either of the below methods + +- [Helm3](#helm_install) chart or +- [Kubectl](#kubectl_install) yaml spec file + +### **Install Litmus using Helm ** + +The helm chart will install all the required service account configuration and chaos control plane. + +The following steps will help you install litmus via helm. + +#### Step-1: Add the litmus helm repository + +```bash +root@demo:~# helm repo add litmuschaos https://litmuschaos.github.io/litmus-helm/ +"litmuschaos" has been added to your repositories +``` + +```bash +root@demo:~# helm repo list +NAME URL +litmuschaos https://litmuschaos.github.io/litmus-helm/ +``` + +#### Step-2: Create the litmus namespace + +- The litmus infra components will be placed in this namespace. + +**Note**: The chaos control plane can be placed in any namespace, though it is typically placed in "litmus". + +```bash +root@demo:~# kubectl create ns litmus +namespace/litmus created +``` + +#### Step-3: Install the litmus chaos control plane + +```bash +root@demo:~# helm install chaos litmuschaos/litmus-2-0-0-beta --namespace=litmus --devel --set portalScope=namespace +``` + +Expected Output + +```bash +NAME: chaos +LAST DEPLOYED: Tue Jun 15 19:20:09 2021 +NAMESPACE: litmus +STATUS: deployed +REVISION: 1 +TEST SUITE: None +NOTES: +Thank you for installing litmus-2-0-0-beta 😀 + +Your release is named chaos and its installed to namespace: litmus. + +Visit https://docs.litmuschaos.io/docs/getstarted/ to find more info. + +``` + +> **Note:** Litmus uses Kubernetes CRDs to define chaos intent. Helm3 handles CRDs better than Helm2. Before you start running a chaos experiment, verify if Litmus is installed correctly. + +- The cluster-admin or an equivalent user with the right permissions are required to install them CRDs upfront. To apply LitmusCRDs: + +```bash +kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/litmus-portal-crds.yml +``` + +Output: + +```bash +customresourcedefinition.apiextensions.k8s.io/clusterworkflowtemplates.argoproj.io created +customresourcedefinition.apiextensions.k8s.io/cronworkflows.argoproj.io created +customresourcedefinition.apiextensions.k8s.io/workflows.argoproj.io created +customresourcedefinition.apiextensions.k8s.io/workflowtemplates.argoproj.io created +customresourcedefinition.apiextensions.k8s.io/chaosengines.litmuschaos.io created +customresourcedefinition.apiextensions.k8s.io/chaosexperiments.litmuschaos.io created +customresourcedefinition.apiextensions.k8s.io/chaosresults.litmuschaos.io created +customresourcedefinition.apiextensions.k8s.io/eventtrackerpolicies.eventtracker.litmuschaos.io created +``` + +### **Install Litmus using kubectl ** + +#### **Install Litmus** + +- Set the namespace on which you want to install litmus. + +```bash +export LITMUS_PORTAL_NAMESPACE="
+ +## **Setup the Portal** + +To setup and login to Litmus Portal expand the available services just created and copy the `PORT` of the `litmusportal-frontend-service` service + +```bash +kubectl get svc -n litmus +``` + +Expected Output + +```bash +NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +chaos-litmus-portal-mongo ClusterIP 10.104.107.117
.default})
diff --git a/website/docs/litmus-uninstallation.md b/website/docs/litmus-uninstallation.md
index 13a0286a..2f959f2d 100644
--- a/website/docs/litmus-uninstallation.md
+++ b/website/docs/litmus-uninstallation.md
@@ -6,10 +6,20 @@ sidebar_label: Control Plane
---
-### **Uninstallation of Litmus Control Plane**
+### **Uninstallation of Litmus Control Plane using Helm**
-The helm chart uninstall installs the control plane components
+The helm chart uninstall the control plane components
```bash
helm uninstall litmuschaos --namespace litmus
+kubectl delete ns litmus
```
+
+ ----
+
+### **Uninstallation of Litmus Control Plane using kubectl**
+
+```bash
+kubectl delete ns litmus
+```
+
diff --git a/website/docs/namespaced-mode.md b/website/docs/namespaced-mode.md
deleted file mode 100644
index 55f7f72d..00000000
--- a/website/docs/namespaced-mode.md
+++ /dev/null
@@ -1,219 +0,0 @@
----
-id: namespaced-mode
-title: Namespaced Mode
-sidebar_label: Namespaced Mode
-original_id: namespaced-mode
----
-
----
-
-### What is Namespaced Mode?
-
-Namespaced mode is the other end of the orchestration spectrum & is an antithesis of the admin-mode of operation. Here, the ChaosOperator as well as the chaos resources (chaosexperiment, chaosengine, chaosresult CRs, the experiment pods and chaos workflows) are run in the same namespace where the application under test (AUT) resides. This mode serves the use-cases where the developers/users don't typically have much autonomy over cluster usage and operate strictly within a specific allotted namespace. However, in this case, too, the cluster-admin or an equivalent user with the right permissions are required to install them CRDs upfront.
-
-Note that this mode of operation restricts the scope of chaos experiments to those at the pod-level, as the node/infra level experiments need cluster-wide access.
-
-### How to use Namespaced Mode?
-
-In order to use Namespaced Mode, you just have to install the namespace-scoped litmus operator manifest in the desired (app) namespace. This installs the ChaosOperator, configured to watch for ChaosEngine resources in the same namespace while also setting up the RBAC that can be used for the execution of the standard (generic suite) of chaos experiments.
-
-### Supported Experiments in Namespaced Mode
-
-- [Pod Delete](https://docs.litmuschaos.io/docs/pod-delete/)
-- [Container Kill](https://docs.litmuschaos.io/docs/container-kill/)
-- [Pod Network Loss](https://docs.litmuschaos.io/docs/pod-network-loss/)
-- [Pod Network Latency](https://docs.litmuschaos.io/docs/pod-network-latency/)
-- [Pod Network Duplication](https://docs.litmuschaos.io/docs/pod-network-duplication/)
-- [Pod Network Corruption](https://docs.litmuschaos.io/docs/pod-network-corruption/)
-- [Pod CPU Hog](https://docs.litmuschaos.io/docs/pod-cpu-hog/)
-- [Pod Memory Hog](https://docs.litmuschaos.io/docs/pod-memory-hog/)
-- [Disk Fill](https://docs.litmuschaos.io/docs/disk-fill/)
-- [Pod Autoscaler](https://docs.litmuschaos.io/docs/pod-autoscaler/)
-
-### Role Based Access Control (RBAC) Permission in Namespaced Mode
-
-In Namespace mode the RBAC for different [litmus components](https://github.com/litmuschaos/litmus/tree/master/litmus-portal/graphql-server/manifests/namespace) are as follows,
-
-- [Argo](https://github.com/litmuschaos/litmus/blob/master/litmus-portal/graphql-server/manifests/namespace/1a_argo_rbac.yaml)
-- [Litmus Cluster Scope](https://github.com/litmuschaos/litmus/blob/master/litmus-portal/graphql-server/manifests/namespace/2a_litmus_rbac.yaml)
-- [Litmus Admin](https://github.com/litmuschaos/litmus/blob/master/litmus-portal/graphql-server/manifests/namespace/3a_agents_rbac.yaml)(for running experiments)
-- [Subscriber](https://github.com/litmuschaos/litmus/blob/master/litmus-portal/graphql-server/manifests/namespace/3a_agents_rbac.yaml)
-- [Litmus Event Tracker](https://github.com/litmuschaos/litmus/blob/master/litmus-portal/graphql-server/manifests/namespace/3a_agents_rbac.yaml)
-
-### Install Litmus Portal in Namespaced Mode
-
-To install Litmus portal on namespaced mode we need to run the following steps:
-
-#### Checkout the namespace
-
-Check the namespace on which you want to install litmus.
-
-```bash
-export LITMUS_PORTAL_NAMESPACE="