spicedb-operator

SpiceDB Operator

A Kubernetes controller for managing instances of SpiceDB

Features:

• Create, manage, and scale fully-configured SpiceDB clusters with a single Custom Resource
• Run migrations automatically when upgrading SpiceDB versions

See CONTRIBUTING.md for instructions on how to contribute and perform common tasks like building the project and running tests.

Quickstart

The quickstart.yaml has definitions that will:

• Run cockroachdb
• Create a spicedb namespace
• Install the operator and the CRDs
• Create a 3 node spicedb cluster configured to talk to the cockroach cluster

We recommend using a local cluster like [kind] or [docker destktop].

Example

apiVersion: authzed.com/v1alpha1
kind: SpiceDBCluster
metadata:
  name: spicedb
  namespace: spice
spec:
  # config for spicedb
  config:
    replicas: "2"
    datastoreEngine: cockroachdb
  # a secret in the same namespace 
  secretName: spicedb
status:
  image: spicedb:dev
  observedGeneration: 1
  secretHash: hashOfSecret
---
apiVersion: v1
kind: Secret
metadata:
  name: spicedb
  namespace: spice
data:
  datastore_uri: "postgresql:///the-url-of-your-datastore"
  preshared_key: "averysecretpresharedkey"