GitHub - stevefan1999-personal/surrealdb-operator

┌──────────────────────────────────────────────────────────┐
│                    Kubernetes Cluster                     │
│                                                          │
│  ┌───────────────────────┐   ┌────────────────────────┐  │
│  │  SurrealDB Operator   │   │   TiDB Operator (ext)  │  │
│  │  ┌─────────────────┐  │   │   Manages TiKV/PD      │  │
│  │  │  Cluster Ctrl   │──┼───►   StatefulSets         │  │
│  │  ├─────────────────┤  │   └────────────────────────┘  │
│  │  │  Backup Ctrl    │──┼──►                            │
│  │  └─────────────────┘  │   ┌────────────────────────┐  │
│  └───────────────────────┘   │   Velero (ext)         │  │
│                              │   Backup / Schedule /  │  │
│                              │   Restore / BSL        │  │
│  ┌───────────┐ ┌───────────┐ └────────────────────────┘  │
│  │ SurrealDB │ │ SurrealDB │                              │
│  │ Pod       │ │ Pod       │  tikv://pd:2379             │
│  └─────┬─────┘ └─────┬─────┘                             │
│        └──────┬───────┘                                  │
│  ┌────────────▼───────────────────────┐                  │
│  │  PD StatefulSet + TiKV StatefulSet │                  │
│  └────────────────────────────────────┘                  │
└──────────────────────────────────────────────────────────┘

kubectl apply -f https://github.com/stevefan1999-personal/surrealdb-operator/releases/latest/download/surrealdbcluster-crd.yaml

kubectl apply -f deploy/crds/surrealdbcluster-crd.yaml

# Development (single replica, minimal resources)
kubectl apply -k deploy/kustomize/base

# Production (2 replicas, higher resource limits)
kubectl apply -k deploy/kustomize/overlays/production

kubectl apply -f - <<'EOF'
apiVersion: surrealdb.io/v1alpha1
kind: SurrealDbCluster
metadata:
  name: my-cluster
  namespace: default
spec:
  surrealdb:
    replicas: 1
    image:
      repository: surrealdb/surrealdb
      tag: v3.0.5
    port: 8000
    logLevel: info
    auth:
      rootUsername: root
      rootPasswordSecretRef:
        name: surrealdb-root-password
        key: password
  storage:
    backend: memory
  service:
    type: ClusterIP
    port: 8000
EOF

apiVersion: surrealdb.io/v1alpha1
kind: SurrealDbCluster
metadata:
  name: prod-cluster
  namespace: surrealdb
spec:
  surrealdb:
    replicas: 3
    image:
      repository: surrealdb/surrealdb
      tag: v3.0.5
    logLevel: warn
    auth:
      rootUsername: root
      rootPasswordSecretRef:
        name: surrealdb-root-password
        key: password
    resources:
      requests:
        cpu: 500m
        memory: 512Mi
      limits:
        cpu: "2"
        memory: 2Gi

  storage:
    backend: tikv
    tikv:
      pdReplicas: 3
      tikvReplicas: 3
      pdStorage:
        storageClassName: fast-ssd
        size: 1Gi
      tikvStorage:
        storageClassName: fast-ssd
        size: 50Gi

  service:
    type: ClusterIP
    port: 8000

kubectl get surrealdbcluster my-cluster
kubectl describe surrealdbcluster my-cluster

kubectl get secret my-cluster-auth -o jsonpath='{.data.password}' | base64 -d

kubectl get surrealdbcluster my-cluster -o jsonpath='{.status.auth.generatedSecretName}'

# 1. Install cert-manager (if not already installed)
kubectl apply -f https://github.com/cert-manager/cert-manager/releases/latest/download/cert-manager.yaml

# 2. Create a self-signed ClusterIssuer (for development / testing)
kubectl apply -f - <<'EOF'
apiVersion: cert-manager.io/v1
kind: ClusterIssuer
metadata:
  name: selfsigned-issuer
spec:
  selfSigned: {}
EOF

# 3. Create a SurrealDbCluster with TLS enabled
kubectl apply -f - <<'EOF'
apiVersion: surrealdb.io/v1alpha1
kind: SurrealDbCluster
metadata:
  name: my-cluster
  namespace: default
spec:
  surrealdb:
    replicas: 1
  storage:
    backend: memory
  tls:
    enabled: true
    issuerRef:
      name: selfsigned-issuer
      kind: ClusterIssuer
EOF

$ just --list
Available recipes:
    build                 # Build the operator
    clean                 # Clean build artifacts
    demo endpoint username password # Run the demo console app
    deploy                # Deploy operator via kustomize base
    deploy-crds           # Apply CRD manifests to the cluster
    deploy-local          # Deploy operator via local overlay (for local development)
    gen-crds              # Generate CRD YAML via KubeOps CLI; keeps only our CRD, discards external stubs
    lint                  # Run code formatting/analyzer lint checks
    publish tag           # Publish operator container image for a single arch (amd64)
    publish-multiarch tag # Publish multi-arch operator image (amd64 + arm64 manifest)
    restore               # Restore NuGet packages
    run                   # Run the operator locally against the k0s cluster
    test                  # Run all tests (unit + integration + e2e)
    test-e2e              # Run backup/restore e2e tests against the local k0s cluster
    test-integration      # Run operator integration tests against the local k0s cluster
    test-operator         # Alias for test-integration
    test-unit             # Run all unit tests

just restore    # restore NuGet packages
just lint       # verify dotnet formatting/analyzers
just build      # compile
just test-unit  # unit tests (no cluster needed)
just test       # all tests including integration/e2e (requires k0s/k3s + dependencies)

just run   # uses KUBECONFIG=/var/lib/k0s/pki/admin.conf