From 0ec65b1cedfa5d7ab25bf77437c9c0d913261cf9 Mon Sep 17 00:00:00 2001 From: Gbadebo Bello Date: Sun, 4 Jul 2021 16:35:15 +0100 Subject: [PATCH] Modified Litnmus Installation steps(Cluster and Namespace modes) Signed-off-by: Gbadebo Bello --- website/docs/getstarted.md | 6 ++--- website/docs/litmus-installation-cluster.md | 4 ++-- website/docs/litmus-installation-namespace.md | 23 +++++++++++++------ 3 files changed, 21 insertions(+), 12 deletions(-) diff --git a/website/docs/getstarted.md b/website/docs/getstarted.md index 68e21b4a..ed947762 100644 --- a/website/docs/getstarted.md +++ b/website/docs/getstarted.md @@ -20,11 +20,11 @@ sidebar_label: Pre-requisites Running chaos on your application involves the following steps: -[Install Litmus](litmus-install-cluster-mode) +- [Install Litmus](litmus-install-cluster-mode) -[How to Create and Run a Workflow](create-workflow) +- [How to Create and Run a Workflow](create-workflow) -[Observe ChaosResults](observe-workflow) +- [Observe ChaosResults](observe-workflow)
diff --git a/website/docs/litmus-installation-cluster.md b/website/docs/litmus-installation-cluster.md index c0645042..98b5f26b 100644 --- a/website/docs/litmus-installation-cluster.md +++ b/website/docs/litmus-installation-cluster.md @@ -22,7 +22,7 @@ Installing Litmus in cluster mode gives Litmus access to cluster wide resources. ## Installation -Installation of Litmus can be done using either of the below methods +Installation of Litmus can be done using either of the below methods; - [Helm3](#helm_install) chart or - [Kubectl](#kubectl_install) yaml spec file @@ -42,7 +42,7 @@ helm repo list #### Step-2: Create the litmus namespace -- The litmus infra components will be placed in this 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". diff --git a/website/docs/litmus-installation-namespace.md b/website/docs/litmus-installation-namespace.md index 9d181d7c..ebc00402 100644 --- a/website/docs/litmus-installation-namespace.md +++ b/website/docs/litmus-installation-namespace.md @@ -16,7 +16,7 @@ Installing Litmus in namespace mode limits Litmus access to a particluar namespa - 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. +- It is Recommended 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 @@ -42,7 +42,7 @@ helm repo list #### Step-2: Create the litmus namespace -- The litmus infra components will be placed in this 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". @@ -76,7 +76,7 @@ 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: +The cluster-admin or an equivalent user with the right permissions are required to install the CRDs upfront. To apply LitmusCRDs, run the command below. ```bash kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/litmus-portal-crds.yml @@ -99,7 +99,7 @@ customresourcedefinition.apiextensions.k8s.io/eventtrackerpolicies.eventtracker. #### **Install Litmus** -- Set the namespace on which you want to install litmus. +Set the namespace on which you want to install litmus. ```bash export LITMUS_PORTAL_NAMESPACE="" @@ -109,7 +109,7 @@ kubectl get ns ${LITMUS_PORTAL_NAMESPACE} kubectl create ns ${LITMUS_PORTAL_NAMESPACE} ``` -- The cluster-admin or an equivalent user with the right permissions are required to install them CRDs upfront. To apply LitmusCRDs: +The cluster-admin or an equivalent user with the right permissions are required to install them CRDs upfront. To apply LitmusCRDs, run: ```bash kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/litmus-portal-crds.yml @@ -128,7 +128,7 @@ customresourcedefinition.apiextensions.k8s.io/chaosresults.litmuschaos.io create customresourcedefinition.apiextensions.k8s.io/eventtrackerpolicies.eventtracker.litmuschaos.io created ``` -- Replace namespace with the target namespace. +Replace namespace with the target namespace. ```bash export LITMUS_PORTAL_NAMESPACE="" @@ -157,14 +157,23 @@ service/mongo-service created **Verify if the frontend, server, and database pods are running** +<<<<<<< HEAD - Check the pods in litmus namespace: +======= +Check the litmus CRDs: +>>>>>>> 46a701c (Modified Litnmus Installation steps(Cluster and Namespace modes)) ```bash kubectl get pods -n litmus ``` +<<<<<<< HEAD Expected Output +======= +Check the pods in litmus namespace: + +>>>>>>> 46a701c (Modified Litnmus Installation steps(Cluster and Namespace modes)) ```bash NAME READY STATUS RESTARTS AGE litmusportal-frontend-97c8bf86b-mx89w 1/1 Running 2 6m24s @@ -172,7 +181,7 @@ service/mongo-service created mongo-0 1/1 Running 0 6m16s ``` -- Check the services running in litmus namespace: +Check the services running in litmus namespace: ```bash kubectl get svc -n litmus