Quickstart: Single-Node RegattaCluster - Regatta

This page walks you through creating your first RegattaCluster resource. Make sure you’ve completed Installation first: the operator must already be running in your cluster.

1. Create a RegattaCluster resource

A minimal RegattaCluster resource looks like this:

apiVersion: regatta.dev/<crd-api-version>
kind: RegattaCluster
metadata:
  name: my-regattadb
  namespace: <namespace>
spec:
  version: "<version>"
  image:
    repository: registry.example.com/regatta
    tag: "<version>"
  security:
    runAsUser: 1000
    runAsGroup: 1001
    fsGroup: 1001
  rdb:
    replicas: 3
    blockStorage:
      size: 60Gi
  repoStorage:
    size: 5Gi
  logs:
    size: 5Gi

Save it to a file under config/examples/, for example config/examples/regatta-minimal.yaml. See Configuration Overview for what every field means.

2. Apply and verify

kubectl -n <namespace> apply -f config/examples/regatta-minimal.yaml
kubectl -n <namespace> get rgc
kubectl -n <namespace> get rgc my-regattadb -o yaml

You can also list every resource the operator generated in one command:

kubectl -n <namespace> get statefulsets,services,configmaps,secrets,pods,pvc \
  -l app.kubernetes.io/instance=my-regattadb

A new RegattaCluster resource does not become Ready immediately: Kubernetes must provision storage and start Pods before the operator can configure and start RegattaDB through the System Manager. Track status.conditions (see Reading RegattaCluster Status) until you see Ready reported as True, rather than expecting readiness right away.

Next steps

Operations to understand how the operator keeps Kubernetes and RegattaDB in sync, and what you can safely change afterward.
Example: Two Local NVMe Devices, One RDB Replica for a static-storage walkthrough.
Troubleshooting if your RegattaCluster resource doesn’t reach Ready.