Version: 1.0.0

Set up the development environment

This document walks you through the environment setup process for Chaos Mesh development.

Prerequisites

Prepare the toolchain

Make sure you have the above prerequisites met. Now follow the steps below to prepare the toolchain for compiling Chaos Mesh:

  1. Clone the Chaos Mesh repo to your local machine.

    git clone https://github.com/chaos-mesh/chaos-mesh.git
    cd chaos-mesh
  2. Install the Kubernetes API development framework - kubebuilder and kustomize.

    make ensure-all
  3. Make sure Docker is installed and running on your local machine.

  4. Make sure ${GOPATH}/bin is in your PATH.

    echo 'export PATH=$(go env GOPATH)/bin:${PATH}' >> ~/.bash_profile
    source ~/. bash_profile

Note:

If your yarn is newly installed, you might need to restart the terminal to make it available.

Now you can test the toolchain by running:

make

If there is no error in the output, the compiling toolchain is successfully configured.

Prepare the deployment environment

With the toolchain ready, you still need a local Kubernetes cluster as the deployment environment. Because kind is already installed, you can now set up the Kubernetes cluster directly:

hack/kind-cluster-build.sh

The above script will create a Kubernetes cluster by kind. When you don't need this cluster, you can run the following command to delete it:

kind delete cluster --name=kind

Next step

Congratulations! You are now all set up for Chaos Mesh development. Try the following tasks: