--- id: installation title: ChaosCenter Cluster Scope Installation sidebar_label: Installation --- --- ## 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 Users looking to use Litmus for the first time have two options available to them today. One way is to use a hosted Litmus service like [ChaosNative Litmus Cloud](https://cloud.chaosnative.com/). Alternatively, users looking for some more flexibility can install Litmus into their own Kubernetes cluster. Users choosing the self-hosted option can refer to our Install and Configure docs for installing alternate versions and more detailed instructions. import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; Installation of Self-Hosted Litmus can be done using either of the below methods:
  • Helm3 chart
  • Kubectl yaml spec file

    • Refer to the below details for Self-Hosted Litmus installation.     ChaosNative, the founders of Litmus, offers a free service for community members which makes getting started with Litmus easy. Create an account to get started. Once logged in, create a new hosted control plane and connect to it via the up CLI. Litmus can be used as a hosted cloud service using ChaosNative Litmus Cloud. ChaosNative Litmus Cloud executes your Chaos Workflows in the cloud by managing all your Chaos Control Plane components, while the Chaos Execution Plane components exist on your Kubernetes cluster as part of an external agent.

    To get started with ChaosNative Litmus Cloud, visit ChaosNative Litmus Cloud and register for free. You can skip the below installation steps.     ### 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 can be placed in any namespace, but for this scenario we are choose `litmus` as the namespace. ```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.0.0/litmus-2.0.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-frontend-97c8bf86b-mx89w 1/1 Running 2 6m24s litmusportal-server-5cfbfc88cc-m6c5j 2/2 Running 2 6m19s mongo-0 1/1 Running 0 6m16s ``` - 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.100.105.154 9091:30229/TCP 7m14s litmusportal-server-service NodePort 10.100.150.175 9002:30479/TCP,9003:31949/TCP 7m8s mongo-service ClusterIP 10.100.226.179 27017/TCP 7m6s ``` --- ## **Accessing the ChaosCenter** To setup and login to ChaosCenter 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. Once you have the PORT copied in your clipboard, simply use your IP and PORT in this manner `:` to access the Litmus ChaosCenter. For example: ```yaml http://172.17.0.3:30385/ ``` > Where `172.17.0.3` is my NodeIP and `30385` is the frontend service PORT. If using a LoadBalancer, the only change would be to provide a `:`. [Learn more about how to access ChaosCenter with LoadBalancer](../user-guides/setup-without-ingress.md#with-loadbalancer) You should be able to see the Login Page of Litmus ChaosCenter. The **default credentials** are ```yaml Username: admin Password: litmus ``` By default you are assigned with a default project with Owner permissions. ## **Verify Successful Registration of the Self Agent** Once the project is created, the cluster is automatically registered as a chaos target via installation of [ChaosAgents](resources.md#chaosagents). This is represented as [Self-Agent](resources.md#types-of-chaosagents) in [ChaosCenter](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-5cfbfc88cc-m6c5j 2/2 Running 1 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 ``` ## Resources ## Learn more - [Install ChaosCenter in Namespace Scope](../user-guides/chaoscenter-namespace-scope-installation.md) - [Connect External ChaosAgents to ChaosCenter](../user-guides/chaosagents-installation.md) - [Setup Endpoints and Access ChaosCenter without Ingress](../user-guides/setup-without-ingress.md) - [Setup Endpoints and Access ChaosCenter with Ingress](../user-guides/setup-with-ingress.md)