--- id: chaoscenter-namespace-scope-installation title: ChaosCenter Namespace Scope Installation sidebar_label: Namespace 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 [Required only if namespace isn't there] - The chaoscenter components can be placed in any namespace, though it is typically placed in "litmus". ```bash kubectl create ns litmus ``` > The ChaosCenter can be placed in any namespace, though it is typically placed in `litmus`. Ignore if you already have the namespace where you want to install Litmus created. #### Step-3: Install the required Litmus CRDs The cluster-admin or an equivalent user with the right permissions are required to install the CRDs upfront. ```bash kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/litmus-portal-crds.yml ``` Expected Output ```bash customresourcedefinition.apiextensions.k8s.io/clusterworkflowtemplates.argoproj.io created customresourcedefinition.apiextensions.k8s.io/cronworkflows.argoproj.io created customresourcedefinition.apiextensions.k8s.io/workflows.argoproj.io created customresourcedefinition.apiextensions.k8s.io/workflowtemplates.argoproj.io created customresourcedefinition.apiextensions.k8s.io/chaosengines.litmuschaos.io created customresourcedefinition.apiextensions.k8s.io/chaosexperiments.litmuschaos.io created customresourcedefinition.apiextensions.k8s.io/chaosresults.litmuschaos.io created customresourcedefinition.apiextensions.k8s.io/eventtrackerpolicies.eventtracker.litmuschaos.io created ``` #### Step-4: Install Litmus ChaosCenter ```bash helm install chaos litmuschaos/litmus --namespace=litmus --set portalScope=namespace ``` Expected Output ```bash 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 ** #### **Set the namespace on which you want to install Litmus ChaosCenter** ```bash export LITMUS_PORTAL_NAMESPACE="" kubectl get ns ${LITMUS_PORTAL_NAMESPACE} ``` > If the namespace is not already present then create the target namespace `kubectl create ns ${LITMUS_PORTAL_NAMESPACE}` or `kubectl create ns ` Expected Output ```bash NAME STATUS AGE litmus Active 79m ``` #### **Install the required Litmus CRDs** The cluster-admin or an equivalent user with the right permissions are required to install the CRDs upfront. ```bash kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/litmus-portal-crds.yml ``` Expected Output ```bash customresourcedefinition.apiextensions.k8s.io/clusterworkflowtemplates.argoproj.io created customresourcedefinition.apiextensions.k8s.io/cronworkflows.argoproj.io created customresourcedefinition.apiextensions.k8s.io/workflows.argoproj.io created customresourcedefinition.apiextensions.k8s.io/workflowtemplates.argoproj.io created customresourcedefinition.apiextensions.k8s.io/chaosengines.litmuschaos.io created customresourcedefinition.apiextensions.k8s.io/chaosexperiments.litmuschaos.io created customresourcedefinition.apiextensions.k8s.io/chaosresults.litmuschaos.io created customresourcedefinition.apiextensions.k8s.io/eventtrackerpolicies.eventtracker.litmuschaos.io created ``` #### **Install Litmus ChaosCenter** Applying the manifest file will install all the required service account configuration and ChaosCenter. ```bash curl https://raw.githubusercontent.com/litmuschaos/litmus/master/docs/2.0.0/litmus-namespaced-2.0.0.yaml --output litmus-portal-namespaced-K8s-template.yml envsubst < litmus-portal-namespaced-K8s-template.yml > ${LITMUS_PORTAL_NAMESPACE}-ns-scoped-litmus-portal-manifest.yml kubectl apply -f ${LITMUS_PORTAL_NAMESPACE}-ns-scoped-litmus-portal-manifest.yml -n ${LITMUS_PORTAL_NAMESPACE} ``` > You need to export the namespace in order for the above step to work `export LITMUS_PORTAL_NAMESPACE=""`. Ignore if already done in the first step. Expected Output ```bash configmap/litmus-portal-admin-config created deployment.apps/litmusportal-frontend created service/litmusportal-frontend-service created serviceaccount/litmus-server-account created role.rbac.authorization.k8s.io/litmus-server created rolebinding.rbac.authorization.k8s.io/litmus-server-rb created deployment.apps/litmusportal-server created service/litmusportal-server-service created statefulset.apps/mongo created service/mongo-service created ``` ## **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 ``` > Note: With the namespace mode of the control panel, we need to set the endpoint of the chaos center server according to the use case. By default, it is `http://litmusportal-server-service:9002` To alter, Apply: ```bash kubectl set env deployment/litmusportal-server -n litmus --containers="graphql-server" PORTAL_ENDPOINT="http://172.132.44.44:3231" ``` --- #### **Verify Successful Registration of the Self Agent post [Account Configuration](setup-without-ingress)** Once the project is created, the cluster is automatically registered as a chaos target via installation of [ChaosAgents](../getting-started/resources.md#chaosagents). This is represented as [Self-Agent](../getting-started/resources.md#types-of-chaosagents) in [ChaosCenter](../getting-started/resources.md#chaosagents). ```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 Cluster Scope](chaoscenter-cluster-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)