Skip to content

Architecture Documentation

This directory contains the architectural documentation for floe.

DocumentDescription
Four-Layer OverviewFoundation, Configuration, Services, and Data layers
Platform EnforcementHow platform constraints are enforced at compile time
Platform ServicesLayer 3 long-lived services (Dagster, Polaris, Cube, etc.)
Plugin ArchitecturePlugin system design and entry point registration
Opinionation BoundariesWhat’s enforced vs pluggable
InterfacesAbstract Base Classes for all plugin types
Platform ArtifactsOCI registry storage for platform configurations
Storage IntegrationObject storage (MinIO/S3/GCS/Azure) + Iceberg
OCI Registry RequirementsRegistry configuration, signing, air-gapped deployment

See ADR Index for all Architecture Decision Records.

ADRDecision
0016Four-layer architecture with compile-time enforcement
0018Enforced (Iceberg, dbt, K8s) vs Pluggable (compute, orchestrator)
0021Medallion default, Data Mesh support
0022Security: RBAC, network policies, pod security
0023Secrets: K8s Secrets, ESO, Vault backends
0024Identity: Keycloak default, pluggable IdPs
  • Contracts - Interface contracts and schemas
  • Guides - Implementation guides (Arc42 structure)
  • floe Root - Main documentation index