docs: add devbox-based local development guide#7294
Merged
Conversation
popojk
reviewed
Apr 28, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR aims to improve contributor documentation for running a full Flyte stack locally (devbox + locally running flyte-manager) and refreshes the manager docs to match the current Flyte 2 service layout.
Changes:
- Added a “Running Flyte Locally” section to
CONTRIBUTING.mddescribing the devbox workflow and manager configuration. - Updated
manager/README.mdto reflect current services/endpoints and Postgres usage. - Added several new top-level docs/config/scripts (including a tarball artifact) that appear duplicative or out-of-scope for a docs-only PR.
Reviewed changes
Copilot reviewed 7 out of 8 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
CONTRIBUTING.md |
Adds devbox-based local development instructions and a sample manager/config.yaml snippet. |
manager/README.md |
Refreshes manager service list, endpoints, and “How it works” narrative. |
start-rustfs.sh |
Adds a RustFS startup script (but duplicates existing scripts/start-rustfs.sh). |
config/k3d/cluster.yaml |
Adds a k3d cluster config file (currently appears unused/unreferenced). |
BACKEND_README.md |
Adds a backend overview doc (duplicates docs/BACKEND_README.md and appears outdated). |
DOCKER_QUICK_START.md |
Adds a Docker quick-start doc (duplicates docs/DOCKER_QUICK_START.md). |
IMPLEMENTATION_SPEC.md |
Adds an implementation spec (duplicates docs/IMPLEMENTATION_SPEC.md and references non-existent packages). |
fast.tar.gz |
Adds an unreferenced binary tarball artifact. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
pingsutw
force-pushed
the
docs/devbox-local-setup
branch
from
ddf8b5f to
5a8c796
Compare
Document how to run a full Flyte stack locally using `make devbox-build`, `make devbox-run FLYTE_DEV=true`, and `make -C manager run`. Update manager/README.md to reflect the current service set (no Queue/State service), the PostgreSQL backend, and the actual API surface, and add a matching "Running Flyte Locally" section to CONTRIBUTING.md. Signed-off-by: Kevin Su <pingsutw@apache.org>
pingsutw
force-pushed
the
docs/devbox-local-setup
branch
from
5a8c796 to
b4ecf96
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Kevin Su <pingsutw@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Kevin Su <pingsutw@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Kevin Su <pingsutw@gmail.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
AdilFayyaz
approved these changes
Apr 29, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why are the changes needed?
New contributors had no documented path for running a full Flyte stack locally. The existing
manager/README.mdwas 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?
CONTRIBUTING.mdcoveringmake devbox-build,make devbox-run FLYTE_DEV=true,make devbox-stop, andmake -C manager run, plus amanager/config.yamlsnippet and a pointer tomanager/README.md.manager/README.mdto match the current code:make build/ "bring your own cluster" instructions with the devbox flow.psqlusage, Docker example, architecture diagram).WatchForUpdates.API Endpointssection to list the Connect handlers actually mounted inruns/setup.goandactions/setup.go.How was this patch tested?
Documentation-only change. Verified by running the documented flow locally:
make devbox-buildmake devbox-run FLYTE_DEV=truemake -C manager runLabels
Check all the applicable boxes