Installing the chart

Prerequisites

• Kubernetes 1.21+
• Helm 3.0+

Installation steps

All examples in this guide use the public chart and images. If you've mirrored the repository for your own use (for example, to your Docker Hub namespace), update your commands to reference the mirrored chart instead of the public one.

For example:

• Public chart: dhi.io/<repository>:<tag>
• Mirrored chart: <your-namespace>/dhi-<repository>:<tag>

For more details about customizing the chart to reference other images, see the documentation⁠.

Step 1: Optional. Mirror the Helm chart and/or its images to your own registry

To optionally mirror a chart to your own third-party registry, you can follow the instructions in How to mirror an image⁠ for either the chart, the image, or both.

The same regctl tool that is used for mirroring container images can also be used for mirroring Helm charts, as Helm charts are OCI artifacts.

For example:

regctl image copy \
    "${SRC_CHART_REPO}:${TAG}" \
    "${DEST_REG}/${DEST_CHART_REPO}:${TAG}" \
    --referrers \
    --referrers-src "${SRC_ATT_REPO}" \
    --referrers-tgt "${DEST_REG}/${DEST_CHART_REPO}" \
    --force-recursive

Step 2: Create a Kubernetes secret for pulling images

The Docker Hardened Images that the chart uses require authentication. To allow your Kubernetes cluster to pull those images, you need to create a Kubernetes secret with your Docker Hub credentials or with the credentials for your own registry.

Follow the authentication instructions for DHI in Kubernetes⁠.

For example:

kubectl create secret docker-registry helm-pull-secret \
  --docker-server=dhi.io \
  --docker-username=<Docker username> \
  --docker-password=<Docker token> \
  --docker-email=<Docker email>

Step 3: Install the Helm chart

To install the chart, use helm install. Make sure you use helm login to log in before running helm install. Optionally, you can also use the --dry-run flag to test the installation without actually installing anything.

helm install my-spicedb-operator oci://dhi.io/spicedb-operator-chart --version <version> \
  --set "imagePullSecrets[0].name=helm-pull-secret"

Replace <version> with the desired chart version. If the chart is in your own registry or repository, replace dhi.io with your own registry and namespace. Replace helm-pull-secret with the name of the image pull secret you created earlier.

Step 4: Verify the installation

Check that the SpiceDB Operator is running:

kubectl get deployment -n default
kubectl get pods -n default -l app.kubernetes.io/name=spicedb-operator

You should see the operator pod in a Running state.

Step 5: Deploy a SpiceDB instance

After the operator is installed, create a SpiceDBCluster resource to deploy a SpiceDB instance. First, create a secret with the datastore credentials and a pre-shared key:

kubectl create secret generic my-spicedb-secret \
  --from-literal=datastore_uri="memory://" \
  --from-literal=preshared_key="your-preshared-key"

Then apply a SpiceDBCluster manifest:

apiVersion: authzed.com/v1alpha1
kind: SpiceDBCluster
metadata:
  name: my-spicedb
spec:
  config:
    datastoreEngine: memory
  secretName: my-spicedb-secret

kubectl apply -f spicedbcluster.yaml

Verify the SpiceDB cluster is running:

kubectl get spicedbcluster my-spicedb
kubectl get pods -l authzed.com/cluster=my-spicedb

For more information on configuring and using SpiceDB, see the official SpiceDB documentation⁠.

Uninstall

helm uninstall my-spicedb-operator