Skip to content

Add local development setup guide for whole system#6900

Open
andreahlert wants to merge 1 commit intoflyteorg:v2from
andreahlert:dev-setup-docs
Open

Add local development setup guide for whole system#6900
andreahlert wants to merge 1 commit intoflyteorg:v2from
andreahlert:dev-setup-docs

Conversation

@andreahlert
Copy link

@andreahlert andreahlert commented Feb 8, 2026

Tracking issue

Closes #6839

Why are the changes needed?

The v2 branch has setup docs scattered across individual services (executor/DEVELOPMENT.md, dataproxy/DEVELOPMENT.md, manager/README.md) but there is no single, unified guide for getting the whole system running locally. Contributors need to piece together instructions from multiple files and the PR #6840 comment thread.

What changes were proposed in this pull request?

Add a root-level DEVELOPMENT.md with step-by-step instructions covering the full local development workflow using the unified manager binary:

  • Prerequisites - Go 1.24+, Docker, kind, kubectl
  • Quick Start - 7 numbered steps from cluster creation to health check verification
  • Teardown - Clean shutdown and cluster deletion
  • Individual Services - How to run each service standalone for focused development
  • Configuration - Key config settings with reference to full config file
  • SDK Testing - How to connect flyte-sdk and run workflows
  • Useful Commands - Common kubectl, sqlite3, and make commands
  • Troubleshooting - Solutions for common issues (kubeconfig, ports, MinIO, migrations)
  • Architecture diagram - Visual overview of the system

How was this patch tested?

  • Verified all referenced file paths exist in the v2 branch
  • Verified all referenced Make targets exist
  • Cross-referenced with the setup steps from PR [Feat] add data proxy service #6840 comment and existing service-level docs

Labels

  • added

Add DEVELOPMENT.md with step-by-step instructions for setting up the
full Flyte v2 system locally using the unified manager binary (single
process). Covers prerequisites, kind cluster setup, MinIO deployment,
manager startup, teardown, individual service development, SDK testing,
and troubleshooting.

Closes flyteorg#6839

Signed-off-by: André Ahlert <andre@aex.partners>
@welcome
Copy link

welcome bot commented Feb 8, 2026

Thank you for opening this pull request! 🙌

These tips will help get your PR across the finish line:

  • Most of the repos have a PR template; if not, fill it out to the best of your knowledge.
  • Sign off your commits (Reference: DCO Guide).

@andreahlert
Copy link
Author

Hi @pingsutw @machichima, could you take a look when you have a chance?

I put together a root-level DEVELOPMENT.md covering the full local setup for the unified manager binary, based on the steps from the #6840 comment. It consolidates the scattered docs from executor/, dataproxy/, and manager/ into a single guide with prerequisites, quick start, teardown, troubleshooting, etc.

Happy to adjust anything based on your feedback.

@github-actions github-actions bot mentioned this pull request Feb 8, 2026
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant