Merge pull request #19 from S-ayanide/installation
chore(docs): Added Litmus Installation Docs
This commit is contained in:
Ajesh Baby
GitHub
commit
f8ddc8538d
|
|
@ -57,6 +57,7 @@ aws
|
|||
awsregion
|
||||
ba
|
||||
backOff
|
||||
Backend
|
||||
baremetal
|
||||
Baremetal
|
||||
bd
|
||||
|
|
@ -74,6 +75,7 @@ cassandra
|
|||
cd
|
||||
cde
|
||||
ce
|
||||
cfdd
|
||||
Centric
|
||||
chaoexperiment
|
||||
ChaosChart
|
||||
|
|
@ -159,6 +161,7 @@ cp
|
|||
cpu
|
||||
Cpu
|
||||
cr
|
||||
CronWorkflow
|
||||
CrashLoopBackOff
|
||||
crd
|
||||
CRD
|
||||
|
|
@ -177,6 +180,7 @@ cstorvolumereplicas
|
|||
customresourcedefinition
|
||||
Customresourcedefinition
|
||||
da
|
||||
dknv
|
||||
daemonset
|
||||
daemonsets
|
||||
datasource
|
||||
|
|
@ -224,6 +228,7 @@ ENVs
|
|||
EoT
|
||||
EOT
|
||||
errored
|
||||
else's
|
||||
et
|
||||
eth
|
||||
ethernet
|
||||
|
|
@ -248,6 +253,7 @@ failstep
|
|||
faq
|
||||
Fdocker
|
||||
fff
|
||||
ffbccbfff
|
||||
fieldPath
|
||||
fieldRef
|
||||
fieldSelector
|
||||
|
|
@ -369,11 +375,13 @@ LitmusChaos
|
|||
litmuslib
|
||||
LitmusLib
|
||||
litmusresults
|
||||
litmusportal
|
||||
liveness
|
||||
LIVENESS
|
||||
livenss
|
||||
lname
|
||||
LoadBalancer
|
||||
LoadBalancerIP
|
||||
localhost
|
||||
LocalObjectReference
|
||||
localpv
|
||||
|
|
@ -396,10 +404,14 @@ minChaosInterval
|
|||
Minikube
|
||||
minio
|
||||
mountPath
|
||||
mongo
|
||||
msg
|
||||
MustRunAs
|
||||
mv
|
||||
myhtop
|
||||
MyHub
|
||||
MyHubs
|
||||
myhub
|
||||
mysql
|
||||
namespace
|
||||
namespaced
|
||||
|
|
@ -411,6 +423,7 @@ nfs
|
|||
NFS
|
||||
ng
|
||||
nginx
|
||||
NodeIP
|
||||
nodename
|
||||
nodeName
|
||||
nodeport
|
||||
|
|
@ -510,6 +523,8 @@ ResourceRequirements
|
|||
responseCode
|
||||
restorecon
|
||||
rlt
|
||||
rl
|
||||
rightarrow
|
||||
RMW
|
||||
RoleBinding
|
||||
roleRef
|
||||
|
|
@ -639,6 +654,7 @@ VMware
|
|||
volumeMount
|
||||
WithError
|
||||
WebUI
|
||||
weightage
|
||||
wordpress
|
||||
workDays
|
||||
workHours
|
||||
|
|
|
|||
|
|
@ -1,5 +1,107 @@
|
|||
---
|
||||
id: litmus-install
|
||||
title: Litmus Installation
|
||||
title: How to install Litmus
|
||||
sidebar_label: Litmus
|
||||
---
|
||||
|
||||
---
|
||||
<iframe width="560" height="315" src="https://www.youtube.com/embed/rOrKegj5ePI" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
|
||||
|
||||
### **Create a Litmus namespace in Kubernetes**
|
||||
|
||||
```bash
|
||||
kubectl create ns litmus
|
||||
```
|
||||
|
||||
### **Add the Litmus Helm Chart**
|
||||
|
||||
To get started you need to add the **litmuschaos** helm repo
|
||||
|
||||
```bash
|
||||
helm repo add litmuschaos https://litmuschaos.github.io/litmus-helm/
|
||||
```
|
||||
|
||||
### **Install Litmus**
|
||||
|
||||
The helm chart will install all the CRDs, required service account configuration, and chaos-operator required both for the core services as well as the portal to run.
|
||||
|
||||
```bash
|
||||
helm install chaos litmuschaos/litmus-2.0 --namespace litmus
|
||||
```
|
||||
|
||||
<span style={{color: 'green'}}><b>Expected Output</b></span>
|
||||
|
||||
```
|
||||
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 Frontend, Backend and Database Pods are running**
|
||||
|
||||
```bash
|
||||
kubectl get pods -n litmus
|
||||
```
|
||||
|
||||
<span style={{color: 'green'}}><b>Expected Output</b></span>
|
||||
|
||||
```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
|
||||
```
|
||||
|
||||
<br />
|
||||
|
||||
### **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
|
||||
```
|
||||
|
||||
<span style={{color: 'green'}}><b>Expected Output</b></span>
|
||||
|
||||
```bash
|
||||
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
|
||||
chaos-litmus-portal-mongo ClusterIP 10.104.107.117 <none> 27017/TCP 2m
|
||||
litmusportal-frontend-service NodePort 10.101.81.70 <none> 9091:30385/TCP 2m
|
||||
litmusportal-server-service NodePort 10.108.151.79 <none> 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 `<NodeIP>:<PORT>` 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 `<LoadBalancerIP>:<PORT>`
|
||||
|
||||
You should be able to see the Login Page of Litmus. The **default credentials** are
|
||||
|
||||
```yaml
|
||||
Username: admin
|
||||
Password: litmus
|
||||
```
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@ module.exports = {
|
|||
"probes",
|
||||
// "cross-cloud-control",
|
||||
// "litmusctl",
|
||||
// "crds",
|
||||
// "crds",
|
||||
// "rbac",
|
||||
// "service-acounts",
|
||||
],
|
||||
|
|
|
|||
Loading…
Reference in New Issue