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:
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).
Please note: For fybrik version 0.5.x and lower, Helm version greater than 3.3 but less than 3.7 is required when contributing. On the other side, for fybrik v0.6.x, Helm v3.7 or above is required.
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
Docker hub rate limits
As docker hub introduced rate limits on docker image downloads this may affect development using the local kind setup. One option to fix the limit is to use a docker hub login for downloading the images. The environment will run a docker registry as a proxy for all public images. This registry runs in a docker container next to the kind clusters.
export DOCKERHUB_USERNAME='your docker hub username'
export DOCKERHUB_PASSWORD='your password'