<#7294 docs: add devbox-based local development gu...
# flyte-github
a
#7294 docs: add devbox-based local development guide Pull request opened by pingsutw Why are the changes needed? New contributors had no documented path for running a full Flyte stack locally. The existing
manager/README.md
was also stale: it referenced a Queue Service and State Service that no longer exist, claimed SQLite as the backend, and listed an outdated set of services. What changes were proposed in this pull request? • Add a Running Flyte Locally section to
CONTRIBUTING.md
covering
make devbox-build
,
make devbox-run FLYTE_DEV=true
,
make devbox-stop
, and
make -C manager run
, plus a
manager/config.yaml
snippet and a pointer to
manager/README.md
. • Refresh
manager/README.md
to match the current code: • Replace the
make build
/ "bring your own cluster" instructions with the devbox flow. • Drop the non-existent Queue Service and State Service; document the actual services (Runs, Executor/Operator, Actions, DataProxy, Events, Cache, Secret, App + Internal App Proxy). • Switch the database story from SQLite to PostgreSQL (config snippet,
psql
usage, Docker example, architecture diagram). • Rewrite the architecture diagram and "How It Works" flow so the Actions Service correctly watches TaskAction CRs and forwards updates to the SDK controller via
WatchForUpdates
. • Update the
API Endpoints
section to list the Connect handlers actually mounted in
runs/setup.go
and
actions/setup.go
. How was this patch tested? Documentation-only change. Verified by running the documented flow locally: •
make devbox-build
•
make devbox-run FLYTE_DEV=true
•
make -C manager run
Labels • changed Check all the applicable boxes • I updated the documentation accordingly. • All new and existing tests passed. • All commits are signed-off. • #6583 • docs: add devbox-based local development guide 👈 flyteorg/flyte