Google Sign-In Required

Use your company Google account to access the BetterFleet private content.

Back to private home

BetterFleet Support Private
Skip to content
BetterFleet Dev Wiki
Overview
Initializing search
    bf-dev
    • Home
    • Product Capabilities
    • Process
    • Current Work
    • System Design
    • Software Reference
    • Operations
    bf-dev
    • Home
      • Overview
      • Manage
      • Overview
      • Product Engineering Workflow
      • Product Engineering Delivery
      • Product Engineering Workflow in Linear
        • GitLab Feature Flags
        • In-App Docs Authoring
        • Release Notes
      • Templates
      • Publishing
      • Workflow Companions
      • Overview
      • Active Artifacts
      • Backlog Artifacts
      • Archived Artifacts
      • Overview
      • Microgrid
      • OSCP
        • Challenge
        • Specification
        • Spec
        • Architecture
        • Overview
          • Purpose
          • Architecture Summary
          • Key Design Rules
          • See Also
        • Script Runtime Model
        • Compose Profiles and Modes
        • Repo Topology
        • CI and Release Integration
        • Overview
        • Internal Application Diagrams
          • Overview
          • Web Model
          • Core Model
        • Service Interaction Flows
        • Data and State
          • Index
          • bf-manage-web
          • bf-manage-core
          • bf-manage-connect
          • bf-manage-sitepwrmon
          • bf-manage-incidents
          • bf-telematics
          • bf-depot-sim
          • bf-manage-roaming
          • bf-support-microsite
          • bf-digital-twin
          • bf-schedule-creator
        • Overview
        • Internal Application Diagrams
        • Migration and Flags
        • Simulation Request Lifecycle
          • Index
          • bf-bnl-ui
          • bf-bnl-settings
          • bf-bnl-schedule-analysis-compute
          • bf-route-modelling
          • bf-schedule-creator
          • bf-digital-twin
        • Overview
        • Secrets and Env Strategy
        • Vendors and Local Dependencies
        • ADRs
        • Service Matrix
        • Cloud Dependencies
        • Ports and URLs
      • Onboarding
      • Daily Operations Runbook
        • Overview
        • Staging Hotfix Release
        • Production Hotfix Release
        • Terraform Plan Dry Runs
      • Troubleshooting
      • Testing Guide
    • Purpose
    • Architecture Summary
    • Key Design Rules
    • See Also

    Platform Architecture¶

    Purpose¶

    bf-dev is an integration harness for downstream BetterFleet repositories.

    It owns:

    • Bootstrap automation (./init, template injection, clone workflow)
    • Runtime orchestration (./up, profile.ini, mode selection)
    • Local dependency graph (compose.yaml)
    • Optional interactive control plane (./menu)

    It does not own business logic of downstream services.

    Architecture Summary¶

    flowchart TD
      subgraph Host[Developer host]
        Scripts[Root scripts]
        Profile[Profile file]
        Templates[Environment templates]
      end
    
      Scripts --> Compose[Docker Compose]
      Templates --> Init[Secret injection]
      Init --> ServiceEnv[Service env files]
      ServiceEnv --> Compose
      Profile --> Up[Mode filtered startup]
      Up --> Compose
    
      Compose --> PlanStack[Plan services]
      Compose --> ManageStack[Manage services]
      Compose --> VendorStack[Vendor services]

    Key Design Rules¶

    • Single orchestration repo for multi-repo local development
    • Environment templates are committed; generated .env files are not
    • Service startup order is healthcheck-gated where possible
    • Mode scoping in ./up prevents mixed-stack startup by default

    See Also¶

    • Script Runtime Model
    • Compose Profiles and Modes
    • Repo Topology
    Made with Material for MkDocs