These guides cover the FeatureStore Custom Resource (CR) from an operator perspective —
what to put in the CR, how the operator translates it into Kubernetes objects, and where to
look for store-specific YAML options in the Feast SDK docs.
| Layer | Source | What it covers |
|---|---|---|
| CR field reference | api/markdown/ref.md |
Every field, type, validation constraint — auto-generated from Go types |
| Operator guides (this folder) | Narrative how-tos | CR→K8s behavior, Secret formats, PVC patterns, operator-specific trade-offs |
| Feast SDK reference | feast/docs/reference/ |
Store-specific feature_store.yaml options (online/offline store drivers, registry drivers, etc.) |
| Sample CRs | config/samples/ |
Copy-paste starting points for common configurations |
Rule of thumb: if you need to know what to put in the CR and why, read the operator guides. If you need to know which keys a particular store driver accepts, read the Feast SDK docs for that store.
| # | Guide | Topic |
|---|---|---|
| 1 | Project Provisioning | feastProjectDir: cloning a git repo vs feast init templates |
| 2 | Persistence | File (path + PVC) vs DB store for offline/online/registry; Secret format |
| 3 | Serving & Observability | Feature server workers, log level, Prometheus metrics, offline push batching, MCP |
| 4 | Registry Topology | Local vs remote registry, cross-namespace feastRef, remote TLS |
| 5 | Security | Kubernetes RBAC roles vs OIDC auth; TLS for all servers |
| 6 | Batch Jobs | batchEngine ConfigMap contract, cronJob for scheduled materialization |
| 7 | OpenLineage & Materialization | Lineage transports, API key Secret, materialization batch size |
- "How do I point the operator at my existing git feature repo?" → Guide 1
- "How do I wire Postgres/Redis/DuckDB as my store?" → Guide 2
- "How do I enable Prometheus scraping for the feature server?" → Guide 3
- "How do I make all services share a remote registry?" → Guide 4
- "How do I enable Kubernetes RBAC or OIDC auth?" → Guide 5
- "How do I schedule nightly materialization?" → Guide 6
- "How do I send lineage events to Marquez?" → Guide 7
- "What are all valid fields on
ServingConfig?" → API ref
Horizontal scaling, HPA, PodDisruptionBudget, affinity, and topology spread constraints are covered in the main Feast docs: