skills/feast-architecture/SKILL.md
┌─────────────────────────────────────────────────────────────────┐
│ Feast Deployment Modes │
│ │
│ Local / Python SDK Kubernetes (feast-operator) │
│ ───────────────── ───────────────────────────────── │
│ feature_store.yaml ←── FeatureStore CR (CRD) │
│ │ │ │
│ ▼ ▼ │
│ FeatureStore (Python) Operator deploys services: │
│ ├── Registry - feature-server (Go or Python) │
│ ├── Provider - offline-store-server │
│ │ ├── OnlineStore - registry-server │
│ │ └── OfflineStore + manages feature_store.yaml config │
│ └── FeatureServer │
│ (Python FastAPI or │
│ Go gRPC/HTTP) │
└─────────────────────────────────────────────────────────────────┘
File: sdk/python/feast/feature_store.py
FeatureStore is the single entry point for all operations. It never reads/writes data
directly — it delegates to the registry (for metadata) and the provider (for infrastructure
and data movement).
FeatureStore(repo_path=".") # loads feature_store.yaml
store.apply(objects) # register feature definitions
store.materialize(...) # offline → online
store.get_online_features(...) # serve
store.get_historical_features(...) # training data
File: sdk/python/feast/repo_config.py — parses feature_store.yaml into typed RepoConfig.
All component classes (online store, offline store, registry) are loaded dynamically from the
type: string via repo_config.ONLINE_STORE_TYPE_MAP / OFFLINE_STORE_TYPE_MAP.
Purpose: Metadata store — persists definitions of entities, feature views, data sources, feature services, permissions.
Backends and their files:
| Backend | File | Notes |
|---|---|---|
| File/GCS/S3 (default) | infra/registry/registry.py | Single proto blob, cached in memory |
| SQL | infra/registry/sql.py | Per-object tables via SQLAlchemy |
| Snowflake | infra/registry/snowflake.py | Snowflake tables |
| Remote | infra/registry/remote.py | Delegates to a remote registry server over gRPC |
How the proto/file backend works:
Registry protobuf (protos/feast/core/Registry.proto)registry: pathcached_registry_proto is refreshed on a TTL (default 10s)Key pattern — apply:
# Python object → proto → stored in registry blob
registry.apply_feature_view(feature_view, project)
# → feature_view.to_proto()
# → upserts into cached_registry_proto.feature_views
# → registry_store.update_registry_proto(proto)
How the SQL backend works:
ProtoBytes, not LargeBinary directly (defined at the top of infra/registry/sql.py). ProtoBytes emits LONGBLOB on MySQL and MariaDB and falls back to LargeBinary's default on every other dialect (BLOB on SQLite, BYTEA on PostgreSQL). Plain LargeBinary maps to MySQL BLOB (64 KB cap), which silently truncates large protos (e.g. a FeatureView) and later fails to deserialize. Any new serialized-proto/blob-metadata column reintroduces that bug if it uses LargeBinary.metadata object in sql.py (the source of truth). metadata.create_all only creates missing tables — it never widens existing columns, so schema changes to existing registries require a manual migration (see docs/reference/registries/sql.md). On MySQL/MariaDB, SqlRegistry._warn_if_narrow_blob_columns logs an error at startup for any registry proto column still typed as the narrow BLOB — a new column is covered automatically as long as it's typed ProtoBytes (the diagnostic selects columns by column.type is ProtoBytes); a column typed as plain LargeBinary would be silently missed.Supporting files:
infra/registry/base_registry.py — abstract interfaceinfra/registry/proto_registry_utils.py — proto serialization helpersinfra/registry/caching_registry.py — adds TTL caching on top of any backendPurpose: Infrastructure lifecycle — creates/updates/tears down online store tables.
Also dispatches online_write_batch and get_historical_features.
File: sdk/python/feast/infra/provider.py
Built-in providers (set via provider: in feature_store.yaml):
local — SQLite online store, file offline (dev default)gcp — Datastore/Bigtable online, BigQuery offlineaws — DynamoDB online, Redshift offlineCustom providers extend Provider and override update_infra / teardown_infra.
Purpose: Low-latency feature serving. Stores the latest feature values per entity key.
Interface: sdk/python/feast/infra/online_stores/online_store.py
Implementations: sdk/python/feast/infra/online_stores/ (redis, dynamodb, sqlite, bigtable, postgres, snowflake, …)
Key methods:
online_write_batch — write entity→feature valuesonline_read — read by entity keysupdate — provision/deprovision tables on feast applyteardown — clean up on feast teardownPurpose: Historical feature retrieval and training data generation (point-in-time joins).
Interface: sdk/python/feast/infra/offline_stores/offline_store.py
Implementations: sdk/python/feast/infra/offline_stores/ (bigquery, snowflake, redshift, duckdb, file, …)
Returns a RetrievalJob (lazy) — no data moves until .to_df() or .to_arrow() is called.
PIT join logic (shared): sdk/python/feast/infra/offline_stores/offline_utils.py
Key methods to implement for a new backend:
class MyOfflineStore(OfflineStore):
def get_historical_features(self, config, feature_views, feature_refs,
entity_df, registry, project, ...) -> RetrievalJob: ...
def pull_latest_from_table_or_query(self, config, data_source,
join_key_columns, feature_name_columns,
timestamp_field, created_timestamp_column,
start_date, end_date) -> RetrievalJob: ...
def pull_all_from_table_or_query(self, config, data_source, join_key_columns,
feature_name_columns, timestamp_field,
start_date, end_date) -> RetrievalJob: ...
def write_logged_features(self, config, data, source, logging_config,
registry) -> None: ... # optional
Config class: subclass FeastConfigBaseModel with a type Literal (short alias + full dotted path). Register in OFFLINE_STORE_TYPE_MAP in sdk/python/feast/repo_config.py.
Data source: each offline store backend pairs with a DataSource subclass (e.g. BigQuerySource, FileSource). Add it to sdk/python/feast/data_sources/ and register in DATA_SOURCE_CLASS_FOR_TYPE.
feast applyfeast apply (CLI → repo_operations.py)
├── Parse Python files → collect FeastObjects
├── store.apply(objects)
│ ├── diff against registry (diff/registry_diff.py)
│ ├── update registry metadata for changed objects
│ └── provider.update_infra(tables_to_keep, tables_to_delete)
│ └── online_store.update(...) ← create/drop tables
└── Write updated registry to storage
feast materializestore.materialize(start_date, end_date)
├── Load feature views from registry
├── For each feature view:
│ ├── offline_store.pull_latest_from_table_or_query(...)
│ │ └── Returns RetrievalJob (lazy)
│ ├── job.to_arrow() ← executes query, fetches Arrow table
│ └── provider.online_write_batch(...)
│ └── online_store.online_write_batch(config, table, data, progress)
└── Update last_updated_timestamp in registry
get_online_featuresstore.get_online_features(features, entity_rows)
├── Resolve feature refs → FeatureViews from registry
├── online_store.online_read(config, table, entity_rows, requested_features)
│ └── Deserialize ValueProto → Python dict
├── Apply OnDemandFeatureView transformations (if any)
└── Return OnlineFeaturesResponse
get_historical_featuresstore.get_historical_features(entity_df, features)
├── Resolve feature refs → FeatureViews from registry
├── offline_store.get_historical_features(config, feature_views, entity_df)
│ └── Point-in-time join:
│ for each entity row, find latest values where
│ event_timestamp ≤ entity_df.event_timestamp
│ (prevents data leakage in training)
└── Returns RetrievalJob → .to_df() / .to_arrow()
File: sdk/python/feast/feature_server.py
A FastAPI app that wraps FeatureStore. Started with feast serve.
Endpoints:
POST /get-online-features — online feature retrievalPOST /push — push features to online/offline storePOST /materialize — trigger materializationGET /health — health checkThe app loads feature_store.yaml at startup, creates a FeatureStore, and periodically
refreshes the registry in the background (async timer).
Directory: go/
Entry point: go/main.go
A high-performance alternative to the Python feature server, written in Go. Supports HTTP, HTTPS, and gRPC transports:
go run go/main.go -type http -port 6566
go run go/main.go -type grpc -port 6566
Key packages:
go/internal/feast/ — Go port of FeatureStore (reads feature_store.yaml, calls online store)go/internal/feast/server/ — HTTP and gRPC server implementationsgo/internal/feast/server/logging/ — feature logging to offline storeThe Go server reads the registry directly (proto file or remote) and calls the online store.
It does not support feast apply or materialization — those remain Python-only.
Directory: infra/feast-operator/
Language: Go (controller-runtime / kubebuilder)
The operator manages the full lifecycle of a Feast deployment on Kubernetes via a
FeatureStore Custom Resource Definition (CRD).
API version: feast.dev/v1
File: infra/feast-operator/api/v1/featurestore_types.go
apiVersion: feast.dev/v1
kind: FeatureStore
metadata:
name: my-feast
spec:
feastProjectName: my_project
services:
offlineStore:
persistence:
file:
type: dask
onlineStore:
persistence:
store:
type: redis
secretRef:
name: redis-credentials
registry:
local:
persistence:
file:
path: /data/registry.db
| Service | What it deploys |
|---|---|
| Online Store server | Deployment + Service for the feature server (Go or Python) |
| Offline Store server | Deployment + Service for the offline feature server |
| Registry server | Deployment + Service for the registry gRPC server |
| feature_store.yaml | ConfigMap auto-generated from the CR spec |
| Materialization jobs | CronJob (spec.services.onlineStore.cronJob) |
| TLS | Certificate management via spec.services.*.tls |
| Auth | OIDC / Kubernetes RBAC via spec.authz |
File: infra/feast-operator/internal/controller/featurestore_controller.go
The FeatureStoreReconciler.Reconcile method runs on every CR change:
FeatureStore CRdeployFeast() → creates/updates Deployments, Services, ConfigMapsOfflineStore, OnlineStore, Registry ready conditions)Supporting services logic: infra/feast-operator/internal/controller/services/
All persistent metadata and the feature server wire format use Protocol Buffers.
Python object (FeatureView, Entity, ...)
├── .to_proto() → Protobuf message → stored in registry or sent over gRPC
└── .from_proto() ← Protobuf message
Proto definitions:
protos/feast/core/ # registry objects (FeatureView, Entity, DataSource, …)
protos/feast/serving/ # serving API (GetOnlineFeaturesRequest/Response)
protos/feast/types/ # Value, EntityKey, Field
When adding a new field to a Feast object:
.proto filemake compile-protos-python (and make compile-protos-go if applicable).to_proto() and .from_proto() in the Python class| Concern | Key file(s) |
|---|---|
| User-facing Python API | sdk/python/feast/feature_store.py |
| Config parsing | sdk/python/feast/repo_config.py |
feast apply CLI logic | sdk/python/feast/repo_operations.py |
| Registry diff | sdk/python/feast/diff/registry_diff.py |
| Registry (proto/file) | sdk/python/feast/infra/registry/registry.py |
| Registry (SQL) | sdk/python/feast/infra/registry/sql.py |
| PIT join | sdk/python/feast/infra/offline_stores/offline_utils.py |
| Online store interface | sdk/python/feast/infra/online_stores/online_store.py |
| Entity key serialization | sdk/python/feast/infra/online_stores/helpers.py |
| Python feature server | sdk/python/feast/feature_server.py |
| Go feature server | go/main.go, go/internal/feast/server/ |
| Operator CRD types | infra/feast-operator/api/v1/featurestore_types.go |
| Operator controller | infra/feast-operator/internal/controller/featurestore_controller.go |
| Operator services | infra/feast-operator/internal/controller/services/ |
| Proto definitions | protos/feast/ |
| Web UI | ui/ (React) |
The docs/ directory contains user-facing architecture documentation that complements this skill:
| Topic | Doc |
|---|---|
| Architecture overview | docs/getting-started/architecture/overview.md |
| Push vs pull model | docs/getting-started/architecture/push-vs-pull-model.md |
| Write patterns | docs/getting-started/architecture/write-patterns.md |
| Feature transformation | docs/getting-started/architecture/feature-transformation.md |
| RBAC / authorization | docs/getting-started/architecture/rbac.md |
| Online store component | docs/getting-started/components/online-store.md |
| Offline store component | docs/getting-started/components/offline-store.md |
| Registry component | docs/getting-started/components/registry.md |
| Feature server component | docs/getting-started/components/feature-server.md |
| Provider component | docs/getting-started/components/provider.md |
| Compute engine | docs/getting-started/components/compute-engine.md |
| ADRs (design decisions) | docs/adr/ |