Files
skills/public/hip-0401.md

2.6 KiB

hip, title, author, type, category, status, implementation-rust, created
hip title author type category status implementation-rust created
0401 Datastore CRD Hanzo Platform Team Standards Track Operator Final shipped 2026-05-19

HIP-0401: Datastore CRD

Abstract

The Datastore CRD models a stateful workload with persistent storage. It is the canonical primitive backing Hanzo Datastore (hanzoai/datastore). Type-routed siblings — SQL, KV, DocDB, S3 — are thin facades that delegate to the same reconciler with a spec.type discriminator. The operator materializes a StatefulSet, headless and ClusterIP Services, PersistentVolumeClaim templates, and KMSSecret references.

Specification

Group + version

hanzo.ai/v1 (group configurable).

Spec fields

Field Type Description
type string datastore, postgresql, valkey, docdb, minio
image ImageSpec repository, tag, pullPolicy
replicas int StatefulSet replica count
storage StorageSpec storageClassName, size, retentionPolicy
resources ResourceRequirements requests/limits
env, envFrom []EnvVar / []EnvFromSource environment
volumes, volumeMounts array extra volumes beyond storage
credentialsSecret string secret holding root creds
kmsSecrets []KMSSecretRef KMS-managed secrets
backup BackupSpec schedule, s3 target, retention
serviceAliases []string extra DNS aliases for ClusterIP
ports []ServicePort exposed ports
networkPolicy NetworkPolicySpec optional
serviceMonitor ServiceMonitorSpec optional Prometheus scrape
command, args []string container entrypoint

Example CR

apiVersion: hanzo.ai/v1
kind: Datastore
metadata:
  name: datastore
  namespace: hanzo
spec:
  type: datastore
  image:
    repository: ghcr.io/hanzoai/datastore
    tag: "26"
  replicas: 1
  storage:
    storageClassName: do-block-storage
    size: 50Gi
    retentionPolicy: Retain
  credentialsSecret: datastore-credentials

Generated K8s resources

  • StatefulSet (one Pod per replica, stable hostnames)
  • Headless Service (for replica discovery)
  • ClusterIP Service (for client traffic; aliases via serviceAliases)
  • PersistentVolumeClaim per replica (from volumeClaimTemplates)
  • NetworkPolicy (if requested)
  • KMSSecret references (if kmsSecrets)

Operator reconciler

  • Rust: ~/work/hanzo/operator/src/controllers/datastore.rs

Status

Implemented in hanzoai/operator v0.3.0+. Backs all stateful workloads in do-sfo3-hanzo-k8s.