[build] Add a local development kit for contributors - #3851
Open
Gezi-lzq wants to merge 1 commit into
Open
Conversation
Gezi-lzq
force-pushed
the
build/devkit
branch
2 times, most recently
from
August 5, 2026 03:17
c60d11e to
de731d7
Compare
Add a Docker Compose and just based development kit that runs locally built Fluss artifacts and supports core, Iceberg, Paimon, Lance, and Hudi profiles with manual tiering validation commands. Run Fluss processes under Docker init, enable JDWP and Prometheus metrics, and propagate configured Hadoop settings to the Hudi write client so the S3A-backed Hudi profile retains its endpoint and credentials.
Gezi-lzq
marked this pull request as ready for review
August 5, 2026 10:24
Gezi-lzq
marked this pull request as draft
August 5, 2026 16:03
Gezi-lzq
marked this pull request as ready for review
August 5, 2026 16:03
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.
Purpose
Closes #3850.
This draft provides a concrete implementation of a contributor-oriented DevKit for running and validating locally built Fluss artifacts. It is opened as a draft to collect feedback on its scope, dependencies, and maintenance boundary.
Brief change log
justbased local development environmentbuild-targetwithout building a Fluss imageTests
The DevKit was exercised manually with both single-node and three-node core clusters. All profile Compose configurations rendered successfully,
just --listexposed the expected public commands, and host SQL files were executed throughjust run-sql.After the final dependency and profile simplification, a clean-volume regression started the core Fluss and Flink services to healthy state and confirmed that the core profile does not submit a Tiering Job. A host SQL file connected through the Flink SQL Client and returned the Fluss database. The Paimon profile then completed table creation, a three-row write, a running Tiering Job, and a Lake query returning three rows with ID sum 6 and payload range
alphatogamma.Clean core clusters reached healthy state with JDWP reachable for every Fluss process and each Prometheus endpoint returning
fluss_*metrics. A dedicated runtime probe confirmed that Docker init runs as PID 1 with the Fluss Java process as its direct child, and normal Compose shutdown completed successfully. Iceberg, Paimon, and Hudi each completed the create-table, write, tier, and lake-query workflow. Lance was validated through table creation, writes, and a running tiering job. Maven validation, Checkstyle, Spotless, and RAT checks also passed.Full
mvn verifyhas not yet completed in the current local environment, so this PR remains a draft.API and Format
No public API or storage format changes.
Documentation
Add
devkit/README.mdcovering setup, profiles, operations, validation, debugging, metrics, and profile extension.