Skip to main content

Repository Organization Overview

FleetForge splits OSS contracts, runtime implementations, and enterprise extension points into clear surfaces. Use this map when navigating the repo or planning new features.

Contracts & Shared Definitions​

  • api/contracts/ – Rust crates exporting generated gRPC types and public traits/interfaces (no business logic). Consumers: runtime, CLI, SDK bridges, enterprise plugins.
  • api/proto/public/ – Buf module containing all public protobuf definitions; CI enforces breaking-change checks.
  • api/schemas/ – Canonical JSON Schemas embedded across runtime, SDKs, and docs.

Runtime & Core Crates (OSS)​

  • core/runtime/ – Orchestrator state machine consuming trait-based contracts (Scheduler, PolicyEngine, ReplayStore, ProviderAdapter, etc.).
  • core/runtime-api/ – gRPC/HTTP server wiring for the runtime, depending on api/contracts for types.
  • core/policy/, core/storage/, core/telemetry/, core/bus/, core/prompt/, core/trust/ – Baseline implementations that satisfy the public contracts.
  • core/ctl/ and ctl/ – CLI tools that use shared contracts to interact with the runtime.

SDKs & Tooling​

  • sdk/typescript/, sdk/python/ – Client SDKs generated from api/proto/public and schemas.
  • examples/, evals/, benchmarks/, docs/ – Support tooling that relies on the OSS runtime.

Plugins & Enterprise Hooks​

  • plugins/loader-rs/, plugins/loader-ts/ – Plugin loaders that register optional enterprise features via shared library loading or dynamic imports once a license is validated.
  • policy-packs/ – OSS policy packs (prompt injection, PII, demos).
  • policy-packs-enterprise/ – Placeholder for regulated/commercial packs distributed privately.

Console Surfaces​

  • console/ce/ – OSS operator console (runs, traces, replay).
  • console/ee/ – Enterprise panels (compliance, SLOs, audit exports) activated via dynamic imports and license checks.

Private/Enterprise Code​

  • internal/cloud-control-plane/ – Managed control-plane scaffolding (multi-tenant provisioning, metering, quotas) kept in private distribution.

Distribution Assets​

  • deploy/helm/ – Base Helm chart; overlays under charts/fleetforge-oss and charts/fleetforge-enterprise align with OSS vs. EE deployments.
  • Container targets: fleetforge-runtime:oss (baseline runtime) and fleetforge-runtime:ee (runtime with enterprise plugins pre-bundled or mounted via sidecar volumes).

CI & Governance​

  • Buf breaking/lint checks, reuse lint, and OpenSSF Scorecard workflows keep public APIs stable and licensing hygiene intact.

When adding new components, decide whether they belong in OSS contracts/implementations, enterprise plugins, or private surfaces, and update this document accordingly.