litmuschaos
/
litmus-docs
mirror of https://github.com/litmuschaos/litmus-docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
litmus-docs/website/docs/getting-started-namespace-s...

8.9 KiB
Raw Blame History

id title sidebar_label
namespace-scope-installation Litmus Namespace Scope Installation Namespace Scope

Prerequisites

Before deploying LitmusChaos, make sure the prerequisites are met.

Installation

Installation of Litmus can be done using either of the below methods

**Install Litmus using Helm **

The helm chart will install all the required service account configuration and chaos control plane.

The following steps will help you install litmus via helm.

Step-1: Add the litmus helm repository

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 <span style={{color: '#909191'}}>[Required only if namespace isn't there]

The Litmus infra components will be placed in this namespace.

kubectl create ns <LITMUS_PORTAL_NAMESPACE>

The chaos control plane 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.

kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/litmus-portal-crds.yml

<span style={{color: 'green'}}>Expected Output

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 the litmus chaos control plane

helm install chaos litmuschaos/litmus-2-0-0-beta --namespace=<LITMUS_PORTAL_NAMESPACE> --devel --set portalScope=namespace

<span style={{color: 'green'}}>Expected Output

NAME: chaos
LAST DEPLOYED: Tue Jun 15 19:20:09 2021
NAMESPACE: <LITMUS_PORTAL_NAMESPACE>
STATUS: deployed
REVISION: 1
TEST SUITE: None
NOTES:
Thank you for installing litmus-2-0-0-beta 😀

Your release is named chaos and its installed to namespace: <LITMUS_PORTAL_NAMESPACE>.

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.

**Install Litmus using kubectl **

Set the namespace on which you want to install Litmus

export LITMUS_PORTAL_NAMESPACE="<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 <Your Namespace>

<span style={{color: 'green'}}>Expected Output

NAME                        STATUS   AGE
<LITMUS_PORTAL_NAMESPACE>   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.

kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/litmus-portal-crds.yml

<span style={{color: 'green'}}>Expected Output

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

Applying the manifest file will install all the required service account configuration and chaos control plane.

curl https://raw.githubusercontent.com/litmuschaos/litmus/master/docs/2.0.0-Beta/litmus-namespaced-2.0.0-Beta.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="<namespace>". Ignore if already done in the first step.

<span style={{color: 'green'}}>Expected Output

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:

    kubectl get pods -n <LITMUS_PORTAL_NAMESPACE>

    <span style={{color: 'green'}}>Expected Output

    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:

    kubectl get svc -n <LITMUS_PORTAL_NAMESPACE>

    <span style={{color: 'green'}}>Expected Output

    NAME                            TYPE        CLUSTER-IP      EXTERNAL-IP PORT(S)                       AGE
litmusportal-frontend-service   NodePort    10.100.105.154  <none>      9091:30229/TCP                7m14s
litmusportal-server-service     NodePort    10.100.150.175  <none>      9002:30479/TCP,9003:31949/TCP 7m8s
mongo-service                   ClusterIP   10.100.226.179  <none>      27017/TCP                     7m6s

Resources

Videos

Blogs


Getting Started with Litmus 2.0 in Google Kubernetes Engine

Getting Started with LitmusChaos 2.0 in Azure Kubernetes Service

Get Started with LitmusChaos in Minutes

Learn More