Development Environment

This page describes what you need to install as a developer and contributor to this project, for setting up a development environment.

Operating system

Linux and Mac OS operating systems are officially supported.

Windows users should consider using Windows Subsystem for Linux 2 (WSL 2), a remote Linux machine, or any other solution such as a virtual machine.

Dependencies

Install the following on your machine:

1. go 1.13 or above
2. Docker
3. make
4. jq
5. unzip
6. Maven (mvn)
7. Java Development Kit version 8 or above
8. Mac only: brew install coreutils (installs the timeout command)

Then, run the following command to install additional dependencies:

make install-tools

This installs additional dependencies to hack/tools/bin. The make targets (e.g., make test) are configured to use the binaries from hack/tools/bin. However, you may want to add some of these tools to your system PATH for direct usage from your terminal (e.g., for using kubectl).

Editors

The project is predominantly written in Go so we recommend Visual Studio Code for its good Go support. Alternatively you can select from Editors