Skip to main content
Version: 0.9.1

Installation

This document describes how to install Chaos Mesh to perform chaos experiments against your application in Kubernetes.

If you want to try Chaos Mesh on your your laptop (Linux or macOS), you can refer the following two documents:

Prerequisites​

Before deploying Chaos Mesh, make sure the following items have been installed:

  • Kubernetes version >= 1.12
  • RBAC enabled (optional)

Install Chaos Mesh​

The above command installs all the CRDs, required service account configuration, and all components. Before you start running a chaos experiment, verify if Chaos Mesh is installed correctly.

If you are using k3s or k3d, please also specify --k3s flag.

Note:

install.sh is suitable for trying Chaos Mesh out. If you want to use Chaos Mesh in production or other serious scenarios, Helm is the recommended deployment method.

Verify your installation​

Verify if Chaos Mesh is running (For the use of kubectl, you can refer to the documentation.)

kubectl get pod -n chaos-testing

Expected output:

NAME                                        READY   STATUS    RESTARTS   AGE
chaos-controller-manager-6d6d95cd94-kl8gs   1/1     Running   0          3m40s
chaos-daemon-5shkv                          1/1     Running   0          3m40s
chaos-dashboard-d998856f6-vgrjs             1/1     Running   0          3m40s

Uninstallation​

You can uninstall Chaos Mesh by deleting the namespace.

Install by helm​

You also can install Chaos Mesh by helm. Before you start installing, make sure that helm v2 or helm v3 is installed correctly.

Step 1: Add Chaos Mesh repository to Helm repos​

helm repo add chaos-mesh https://charts.chaos-mesh.org

After adding the repository successfully, you can search available version by the following command:

helm search repo chaos-mesh

Step 2: Create custom resource type​

To use Chaos Mesh, you must create the related custom resource type first.

Step 3: Install Chaos Mesh​

Depending on your environment, there are two methods of installing Chaos Mesh:

  • Install in Docker environment

    1. Create namespace chaos-testing:

      kubectl create ns chaos-testing

    2. Install Chaos Mesh using helm:

      • For helm 2.X

      • For helm 3.X

    3. Check whether Chaos Mesh pods are installed:

      kubectl get pods --namespace chaos-testing -l app.kubernetes.io/instance=chaos-mesh

      Expected output:

      NAME                                        READY   STATUS    RESTARTS   AGE
      chaos-controller-manager-6d6d95cd94-kl8gs   1/1     Running   0          3m40s
      chaos-daemon-5shkv                          1/1     Running   0          3m40s
      chaos-daemon-jpqhd                          1/1     Running   0          3m40s
      chaos-daemon-n6mfq                          1/1     Running   0          3m40s
      chaos-dashboard-d998856f6-vgrjs             1/1     Running   0          3m40s

  • Install in containerd environment (kind)

    1. Create namespace chaos-testing:

      kubectl create ns chaos-testing

    2. Install Chaos Mesh using helm:

      • for helm 2.X
      • for helm 3.X

    3. Check whether Chaos Mesh pods are installed:

      kubectl get pods --namespace chaos-testing -l app.kubernetes.io/instance=chaos-mesh

      Expected output:

      NAME                                        READY   STATUS    RESTARTS   AGE
      chaos-controller-manager-6d6d95cd94-kl8gs   1/1     Running   0          3m40s
      chaos-daemon-5shkv                          1/1     Running   0          3m40s
      chaos-daemon-jpqhd                          1/1     Running   0          3m40s
      chaos-daemon-n6mfq                          1/1     Running   0          3m40s
      chaos-dashboard-d998856f6-vgrjs             1/1     Running   0          3m40s

  • Install in containerd environment (k3s)

    1. Create namespace chaos-testing:

      kubectl create ns chaos-testing

    2. Install Chaos Mesh using helm:

      • for helm 2.X

      • for helm 3.X

    3. Check whether Chaos Mesh pods are installed:

      kubectl get pods --namespace chaos-testing -l app.kubernetes.io/instance=chaos-mesh

      Expected output:

      NAME                                        READY   STATUS    RESTARTS   AGE
      chaos-controller-manager-6d6d95cd94-kl8gs   1/1     Running   0          3m40s
      chaos-daemon-5shkv                          1/1     Running   0          3m40s
      chaos-daemon-jpqhd                          1/1     Running   0          3m40s
      chaos-daemon-n6mfq                          1/1     Running   0          3m40s
      chaos-dashboard-d998856f6-vgrjs             1/1     Running   0          3m40s

Note:

Currently, Chaos Dashboard is not installed by default. If you want to try it out, add --set dashboard.create=true in the helm install commands above. Refer to Configuration for more information.

After executing the above commands, you should be able to see the output indicating that all Chaos Mesh pods are up and running. Otherwise, check the current environment according to the prompt message or create an issue for help.