Reintroduce Quickstart Image#3150
Merged
Merged
Conversation
Contributor
Author
|
@luoyuxia PTAL |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR reintroduces and operationalizes a pre-bundled Flink quickstart Docker image (apache/fluss-quickstart-flink) and updates the website/docs to reference it via a version placeholder, with CI support to publish images for main and release tags.
Changes:
- Add a new
quickstartFlinkDockerVersionfield to website version metadata and expose it via the remark version-replacement plugin. - Update quickstart/observability/security docs to reference the new quickstart image tag placeholder.
- Introduce a
docker/quickstart-flinkDockerfile and a GitHub Actions workflow to build/pushapache/flussandapache/fluss-quickstart-flink.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| website/src/plugins/remark-version-replace/index.js | Adds $FLUSS_QUICKSTART_FLINK_DOCKER_VERSION$ replacement for docs. |
| website/fluss-versions.json | Updates docker versioning for next and adds quickstart image version metadata. |
| website/docs/quickstart/security.md | Switches Flink image references to the quickstart image placeholder and adjusts SQL client invocation. |
| website/docs/quickstart/flink.md | Simplifies the Flink quickstart by using the pre-bundled quickstart image. |
| website/docs/maintenance/observability/quickstart.md | Switches Flink image references to the quickstart image placeholder. |
| website/community/how-to-release/creating-a-fluss-release.mdx | Updates release steps to reflect CI-built apache/fluss and manual RC quickstart image build. |
| docker/quickstart-flink/Dockerfile | New Dockerfile to build the pre-bundled Flink quickstart image. |
| .github/workflows/docker.yaml | New workflow to build/push Docker images on main and v* tags (skipping RC quickstart builds). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
luoyuxia
reviewed
Apr 21, 2026
luoyuxia
reviewed
Apr 21, 2026
Contributor
|
@polyzos Hi, I append a commit improve the quickstart build process, and as #2683 (comment), use separate directories to handle different lake format. |
polyzos
commented
Apr 22, 2026
luoyuxia
added a commit
to luoyuxia/fluss
that referenced
this pull request
Apr 22, 2026
* reintroduce quickstart * address copilot comments * address yuxias comments * [docs] align quickstart image with Flink 1.20 * [build] remove docker workflow from PR * [docs] restore quickstart docker helpers * [docs] revert quickstart docker flow * [docs] restore quickstart release steps * [docs] remove quickstart docker version field * [docs] trim outdated release notes * [docs] remove snapshot repo override * [docs] restore docker staging steps * [docs] switch quickstart image to Flink 2.2 * [docs] update quickstart dependency versions * Revert "[docs] update quickstart dependency versions" This reverts commit 0cf1e05. * Revert "[docs] switch quickstart image to Flink 2.2" This reverts commit ad73101. * refine quickstart image build --------- Co-authored-by: luoyuxia <luoyuxia@alumni.sjtu.edu.cn>
This was referenced Apr 22, 2026
Ugbot
pushed a commit
to Ugbot/fluss
that referenced
this pull request
Apr 26, 2026
* reintroduce quickstart * address copilot comments * address yuxias comments * [docs] align quickstart image with Flink 1.20 * [build] remove docker workflow from PR * [docs] restore quickstart docker helpers * [docs] revert quickstart docker flow * [docs] restore quickstart release steps * [docs] remove quickstart docker version field * [docs] trim outdated release notes * [docs] remove snapshot repo override * [docs] restore docker staging steps * [docs] switch quickstart image to Flink 2.2 * [docs] update quickstart dependency versions * Revert "[docs] update quickstart dependency versions" This reverts commit 0cf1e05. * Revert "[docs] switch quickstart image to Flink 2.2" This reverts commit ad73101. * refine quickstart image build --------- Co-authored-by: luoyuxia <luoyuxia@alumni.sjtu.edu.cn>
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
Linked issue: close #3161
Reintroduce the prebuilt
apache/fluss-quickstart-flinkimage into the quickstart flow so the main Flink quickstart works out of the box again, while keeping the lakehouse guides usable with the same image.Brief change log
docker/quickstart-flinkhelper assets, including the Dockerfile, prepare script, SQL client bootstrap script, and READMEFLINK_HOME/lib, and package Paimon/Iceberg-specific Flink dependencies in separate image directories that are activated by init scripts when neededapache/fluss-quickstart-flink:$FLUSS_QUICKSTART_FLINK_DOCKER_VERSION$fakersource tables through the quickstart SQL client bootstrap file so users do not need to create them manually in the docspaimon-s3,iceberg-aws,iceberg-aws-bundle,postgresql, andhadoop-apacheGenerative AI disclosure: Yes (OpenAI Codex GPT-5)
Tests
API and Format
No API or storage format changes intended.
Documentation
Yes. This PR updates the quickstart image assets and the related documentation pages.