--- id: chaoscenter-cluster-scope-installation title: ChaosCenter Cluster Scope Installation sidebar_label: Cluster Scope --- --- ## Prerequisites Before deploying LitmusChaos, make sure the following items are there - Kubernetes 1.17 or later - A Persistent volume of 20GB :::note 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](https://v3.helm.sh/) or [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl) ## Installation Installation of Litmus can be done using either of the below methods - [Helm3](#install-litmus-using-helm) chart - [Kubectl](#install-litmus-using-kubectl) yaml spec file ### Install Litmus using Helm The helm chart will install all the required service account configuration and ChaosCenter. The following steps will help you install Litmus ChaosCenter via helm. #### Step-1: Add the litmus helm repository ```bash helm repo add litmuschaos https://litmuschaos.github.io/litmus-helm/ helm repo list ``` #### Step-2: Create the namespace on which you want to install Litmus ChaosCenter - The chaoscenter components can be placed in any namespace, though it is typically placed in "litmus". ```bash kubectl create ns litmus ``` #### Step-3: Install Litmus ChaosCenter ```bash helm install chaos litmuschaos/litmus --namespace=litmus ``` Expected Output ``` 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 😀 Your release is named chaos and its installed to namespace: litmus. Visit https://docs.litmuschaos.io 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 ** #### **Install Litmus ChaosCenter** Applying the manifest file will install all the required service account configuration and ChaosCenter. ```bash kubectl apply -f https://litmuschaos.github.io/litmus/2.14.0/litmus-2.14.0.yaml ``` > If you are installing Litmus in any other namespace apart from `litmus` namespace, make sure to change the same in the manifest too `https://litmuschaos.github.io/litmus/2.14.0/litmus-2.14.0.yaml`. ## **Verify your installation** #### **Verify if the frontend, server, and database pods are running** - Check the pods in the namespace where you installed Litmus: ```bash kubectl get pods -n litmus ``` Expected Output ```bash NAME READY STATUS RESTARTS AGE litmusportal-server-6fd57cc89-6w5pn 1/1 Running 0 57s litmusportal-auth-server-7b596fff9-5s6g5 1/1 Running 0 57s mongo-0 1/1 Running 0 57s litmusportal-frontend-55974fcf59-cxxrf 1/1 Running 0 58s ``` - Check the services running in the namespace where you installed Litmus: ```bash kubectl get svc -n litmus ``` Expected Output ```bash NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE litmusportal-frontend-service NodePort 10.43.79.17 9091:31846/TCP 102s litmusportal-server-service NodePort 10.43.30.54 9002:31245/TCP,8000:32714/TCP 101s litmusportal-auth-server-service NodePort 10.43.81.108 9003:32618/TCP,3030:31899/TCP 101s mongo-service ClusterIP 10.43.227.10 27017/TCP 101s mongo-headless-service ClusterIP None 27017/TCP 101s ``` --- #### **Verify Successful Registration of the Self Chaos Delegate post [Account Configuration](setup-without-ingress)** Once the project is created, the cluster is automatically registered as a chaos target via installation of [Chaos Delegate](../getting-started/resources.md#chaosagents). This is represented as [Self Chaos Delegate](../getting-started/resources.md#types-of-chaosagents) in [ChaosCenter](../getting-started/resources.md#chaoscenter). ```bash kubectl get pods -n litmus ``` ```bash NAME READY STATUS RESTARTS AGE chaos-exporter-547b59d887-4dm58 1/1 Running 0 5m27s chaos-operator-ce-84ddc8f5d7-l8c6d 1/1 Running 0 5m27s event-tracker-5bc478cbd7-xlflb 1/1 Running 0 5m28s litmusportal-frontend-97c8bf86b-mx89w 1/1 Running 0 15m litmusportal-server-6fd57cc89-6w5pn 1/1 Running 0 15m litmusportal-auth-server-7b596fff9-5s6g5 1/1 Running 0 15m mongo-0 1/1 Running 0 15m subscriber-958948965-qbx29 1/1 Running 0 5m30s workflow-controller-78fc7b6c6-w82m7 1/1 Running 0 5m32s ``` ## Resource Requirements of Control-plane components The Resource requests provided here have been estimated using data gathered manually through different methods - - Using command `kubectl top` - Recommendations from Vertical-Pod-Autoscaler - Recommendations by a great utility [Goldilocks](https://github.com/FairwindsOps/goldilocks). These resources are getting monitored continuously and the information below will be updated as the metrics changes. :::note **The metrics given below shows resources consumed when ChaosCenter is used at medium scale.The resources may need to be increased when used at higher scale.** :::
Pod Container CPU Memory
litmusportal-frontend litmusportal-frontend 25m 300M
litmusportal-server auth-server 25m 150M
litmusportal-server graphql-server 25m 350M
mongodb mongodb 25m 350M
## Resources ## Learn more - [Install ChaosCenter in Namespace Scope](chaoscenter-namespace-scope-installation.md) - [Setup Endpoints and Access ChaosCenter without Ingress](setup-without-ingress.md) - [Setup Endpoints and Access ChaosCenter with Ingress](setup-with-ingress.md)