This document describes how to set up the development environment and how to develop Vald.
Set up environment
- When using Docker related environment, you can use any OS that supports Docker.
- When using native environment,
amd64 is recommended because
NGT, the vector search library we use, is optimized for
But you can also build and test
arm64 with the same way as described below.
This is the easiest way to start developing
Vald. You can just open our devcontainer.json with
VS Code and go.
We don’t officially have a setup documentation for now, but you can take a look at the
That’s everything you need to build and test
Vald, so you can use it as a reference.
If you would like to use the
Dockerfiledirectlly, please note that
docker-in-dockerenvironment is required to run our E2E tests. In devcontainer,
VS Codehandles it for us.
The command below will run all the unit tests.
The steps below will deploy a Vald cluster to the local
k3d cluster and run the E2E tests.
- Run the commands below.
# Download the dataset make hack/benchmark/assets/dataset/fashion-mnist-784-euclidean.hdf5 # Start k3d make k3d/start # Wait for a while until the cluster is ready # You might want to use k9s for this # Deploy Vald make k8s/vald/deploy # Wait for a while until the deployment is ready # Run E2E tests make e2e E2E_WAIT_FOR_CREATE_INDEX_DURATION=3m # The result will be shown in three minutes or so # Delete the cluster make k8s/vald/delete