Was this page helpful?
Contributing to ScyllaDB Operator¶
ScyllaDB Operator is an open-source project. Contributions of all kinds are welcome — bug reports, documentation improvements, feature requests, and code.
Getting started¶
Before contributing, read the CONTRIBUTING.md file in the repository root. It covers:
Setting up the development environment (Go,
kind, and required tools).Building the Operator binary and image.
Running the end-to-end and unit test suites.
The contribution workflow (fork → branch → PR).
Coding conventions and commit message guidelines.
Quick start¶
Clone the repository and build the Operator:
git clone https://github.com/scylladb/scylla-operator.git
cd scylla-operator
make build
Run unit tests:
make test
Run the linter:
make lint
Deploy to a local kind cluster for development:
make deploy
Deploying a custom build¶
To build and push a custom Operator image to your own registry:
IMAGE=<your-registry>/scylla-operator:<tag> make build-image
IMAGE=<your-registry>/scylla-operator:<tag> make push-image
Then update the Operator deployment to use your image:
kubectl -n scylla-operator set image deployment/scylla-operator \
scylla-operator=<your-registry>/scylla-operator:<tag>
Warning
Custom builds are intended for development and testing only. ScyllaDB Support does not cover clusters running custom Operator images.
Reporting issues¶
Report issues on the GitHub issue tracker.
Before opening a new issue:
Search existing issues to avoid duplicates.
Include the Operator version (
kubectl -n scylla-operator get deployment scylla-operator -o jsonpath='{.spec.template.spec.containers[0].image}').Attach a debugging information archive if the issue is a runtime problem.