- Get started with running and developing druid operator locally.
- Golang 1.20+
- Kubebuilder v3
- It is recommended to install kind since the project's e2e tests are using it.
Running Operator Locally
We're using Kubebuilder so we are working with its
Makefile and extra custom commands:
# If needed, create a kubernetes cluster (requires kind)
# Install the CRDs
# Run the operator locally
Watch a namespace
# Watch all namespaces
# Watch a single namespace
# Watch all namespaces except: kube-system, default
Building The Operator Docker Image
# In case you want to build it with a custom image:
make docker-build IMG=custom-name:custom-tag
Before submitting a PR, make sure the tests are running successfully.
# Run unit tests
# Run E2E tests (requires kind)
If you changed the CRD API, please make sure the documentation is also updated:
Makefile should contain all commands with explanations. You can also run:
# For help