diff --git a/.wordlist.txt b/.wordlist.txt index f934a98..24aee62 100644 --- a/.wordlist.txt +++ b/.wordlist.txt @@ -159,6 +159,7 @@ cp cpu Cpu cr +CronWorkflow CrashLoopBackOff crd CRD @@ -224,6 +225,7 @@ ENVs EoT EOT errored +else's et eth ethernet @@ -400,6 +402,9 @@ msg MustRunAs mv myhtop +MyHub +MyHubs +myhub mysql namespace namespaced @@ -510,6 +515,7 @@ ResourceRequirements responseCode restorecon rlt +rightarrow RMW RoleBinding roleRef @@ -639,6 +645,7 @@ VMware volumeMount WithError WebUI +weightage wordpress workDays workHours diff --git a/website/docs/litmus-installation.md b/website/docs/litmus-installation.md index 6d7706e..a3809d2 100644 --- a/website/docs/litmus-installation.md +++ b/website/docs/litmus-installation.md @@ -29,11 +29,29 @@ The helm chart will install all the CRDs, required service account configuration helm install chaos litmuschaos/litmus-2.0 --namespace litmus ``` +Expected Output + +``` +NAME: chaos +LAST DEPLOYED: Mon Mar 15 18:27:42 2021 +NAMESPACE: litmus +STATUS: deployed +REVISION: 1 +TEST SUITE: None +NOTES: +Thank you for installing litmus-portal 😀 + +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. ### **Verify your installation** -**Verify if the Chaos Operator is running** +**Verify if the Frontend, Backend and Database Pods are running** ```bash kubectl get pods -n litmus @@ -41,10 +59,11 @@ kubectl get pods -n litmus Expected Output -
- -chaos-operator-ce-554d6c8f9f-slc8k 1/1 Running 0 6m41s -
+```bash +chaos-litmus-portal-frontend-ff8b554dc-q5rl4 1/1 Running 0 2m6s +chaos-litmus-portal-mongo-6764cfdd59-c9r56 1/1 Running 0 2m6s +chaos-litmus-portal-server-5ffbccbfff-dknv8 2/2 Running 0 2m6s +```
@@ -56,14 +75,11 @@ kubectl get crds | grep chaos Expected Output -
-chaosengines.litmuschaos.io 2019-10-02T08:45:25Z -
-chaosexperiments.litmuschaos.io 2019-10-02T08:45:26Z -
-chaosresults.litmuschaos.io 2019-10-02T08:45:26Z -
-
+```bash +chaosengines.litmuschaos.io 2021-03-15T12:57:27Z +chaosexperiments.litmuschaos.io 2021-03-15T12:57:27Z +chaosresults.litmuschaos.io 2021-03-15T12:57:27Z +```
@@ -75,11 +91,47 @@ kubectl api-resources | grep chaos Expected Output -
-chaosengines litmuschaos.io true ChaosEngine -
-chaosexperiments litmuschaos.io true ChaosExperiment -
-chaosresults litmuschaos.io true ChaosResult -
-
+```bash +chaosengines litmuschaos.io true ChaosEngine +chaosexperiments litmuschaos.io true ChaosExperiment +chaosresults litmuschaos.io true ChaosResult +``` + +### **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 27017/TCP 2m +litmusportal-frontend-service NodePort 10.101.81.70 9091:30385/TCP 2m +litmusportal-server-service NodePort 10.108.151.79 9002:32456/TCP,9003:31160/TCP 2m +``` + +> **Note**: In this case the PORT for `litmusportal-frontend-service` is `30385`. Yours will be different. + +### **Accessing the Portal** + +Once you have the PORT copied in your clipboard, simply use your NodeIP and PORT in this manner `:` to access the portal. + +For example: + +```yaml +http://172.17.0.3:30385/ +``` +> Where `172.17.0.3` is my NodeIP and `30385` is the frontend service PORT. You can also use a LoadBalancer if not NodePort, the only change would be to provide a `:` + +You should be able to see the Login Page of Litmus. The **default credentials** are + +```yaml +Username: admin +Password: litmus +``` + +![Login](https://i.ibb.co/x7jzYDz/Login.png) \ No newline at end of file