The Stroom K8s Operator is a Kubernetes operator written in Go and developed using the Operator SDK.

Its purpose is to simplify the deployment and operational management of a Stroom cluster in a Kubernetes environment.

Documentation: https://gradata-systems.github.io/stroom-k8s-operator/

The documentation covers installation (Helm, including air-gapped), configuring a StroomCluster, databases and backups, task autoscaling, day-2 operations, troubleshooting and a full CRD reference.

This project is not related to stroom-kubernetes, which is a Helm chart for deploying a Stroom stack, including optional components like Kafka. The purpose of this Operator is to focus on the Stroom deployment and automation.

1. Custom Resource Definitions (CRDs) for defining the desired state of a Stroom cluster, nodes and database
2. Ability to designate dedicated Processing and Frontend nodes and route event traffic appropriately
3. Automatic secrets management (e.g. secure database credential generation and storage)
4. Simple deployment via Helm charts

1. Scheduled database backups
2. Stroom node audit log shipping
3. Stroom node lifecycle management
   1. Prevent node shutdown while Stroom processing tasks are still active
   2. Automatic task draining during shutdown
   3. Rolling Stroom version upgrades
4. Automatically scale the maximum tasks for each Stroom node by continually assessing average CPU usage

The operator requires Stroom to use an external OpenID Connect identity provider. See the prerequisites before you start.

helm install -n stroom-operator-system --create-namespace stroom-operator-crds \
oci://ghcr.io/gradata-systems/helm-charts/stroom-operator-crds

helm install -n stroom-operator-system stroom-operator \
oci://ghcr.io/gradata-systems/helm-charts/stroom-operator

Then follow the quick start to deploy a Stroom cluster. Example resources are in ./samples.

If you are just looking to install the Operator and don't wish to make any changes, you can skip this section.

You need Go (the version in go.mod) and Docker. The Makefile downloads the other tools it uses into bin/.

make build                                   # build the operator binary
make test                                    # unit and envtest tests
make docker-build IMG=<registry>/<image>:<tag>   # build the operator image
make test-e2e                                # end-to-end tests in a kind cluster; see test/e2e/README.md

See RELEASING.md for how releases are published.

The documentation source is in ./docs and is published with MkDocs Material. If you change the API types in api/v1, regenerate the CRD reference with hack/gen-crd-docs.sh. See Contributing to the docs.