Start with install notes or jump straight into the API.

Operations

Index CRD

An Index represents one namespace exposed through the gateway. It declares the backend, snapshot policy, cache posture, consistency mode, and access metadata.

apiVersion: hevlayer.com/v1
kind: Index
metadata:
  name: products
  namespace: layer
spec:
  backend:
    kind: turbopuffer
    region: aws-us-east-1
    namespace: products
    distanceMetric: cosine_distance
  metadata:
    labels:
      app: shop
    tags:
      - catalog
  snapshot:
    interval: 5m
    retention: never
    facetFields:
      - category
      - brand
  cache:
    ttl: 24h
    capGiB: 64
    mode: standard
    warming:
      threads: 4
  consistency: strong

Backend

FieldPurpose
backend.kindturbopuffer in the 0.1 runtime.
backend.regionBackend region identifier.
backend.namespaceOptional upstream namespace override. Defaults to the Index name.
backend.distanceMetricVector metric, default cosine_distance.

Snapshot policy

snapshot.facetFields is the user-facing source of fields the gateway materializes into durable snapshots. retention defaults to never in 0.1 because automatic snapshot GC is not shipped yet.

Cache policy

cache.warming.threads defaults to 4. Aerospike remains an ephemeral cache; durable snapshot history stays in S3.

Status

The operator reports observed generation, snapshot scheduling metadata, metadata sync state, and conditions.