Skip to content

Reintroduce Quickstart Image#3150

Merged
polyzos merged 17 commits into
apache:mainfrom
polyzos:reintroduce-quickstart-image
Apr 22, 2026
Merged

Reintroduce Quickstart Image#3150
polyzos merged 17 commits into
apache:mainfrom
polyzos:reintroduce-quickstart-image

Conversation

@polyzos
Copy link
Copy Markdown
Contributor

@polyzos polyzos commented Apr 21, 2026

Purpose

Linked issue: close #3161

Reintroduce the prebuilt apache/fluss-quickstart-flink image 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

  • restore the docker/quickstart-flink helper assets, including the Dockerfile, prepare script, SQL client bootstrap script, and README
  • keep the base Fluss quickstart dependencies in FLINK_HOME/lib, and package Paimon/Iceberg-specific Flink dependencies in separate image directories that are activated by init scripts when needed
  • update the Flink, lakehouse, security, and observability quickstart docs to use apache/fluss-quickstart-flink:$FLUSS_QUICKSTART_FLINK_DOCKER_VERSION$
  • preload the demo faker source tables through the quickstart SQL client bootstrap file so users do not need to create them manually in the docs
  • align bundled quickstart dependencies with the current lakehouse runtime expectations, including Paimon 1.3.1, paimon-s3, iceberg-aws, iceberg-aws-bundle, postgresql, and hadoop-apache
  • keep the Fluss server-side plugins documented as explicit downloads/mounts where they are still required outside the quickstart image

Generative AI disclosure: Yes (OpenAI Codex GPT-5)

Tests

  • Not run in CI
  • Local quickstart image and doc flow were iterated manually while fixing missing dependency and SQL client bootstrap issues

API and Format

No API or storage format changes intended.

Documentation

Yes. This PR updates the quickstart image assets and the related documentation pages.

@polyzos
Copy link
Copy Markdown
Contributor Author

polyzos commented Apr 21, 2026

@luoyuxia PTAL

@luoyuxia luoyuxia requested review from Copilot and luoyuxia and removed request for Copilot April 21, 2026 12:04
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 quickstartFlinkDockerVersion field 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-flink Dockerfile and a GitHub Actions workflow to build/push apache/fluss and apache/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.

Comment thread website/fluss-versions.json
Comment thread website/docs/quickstart/flink.md Outdated
Comment thread website/src/plugins/remark-version-replace/index.js
Comment thread .github/workflows/docker.yaml Outdated
Comment thread docker/quickstart-flink/Dockerfile Outdated
Copy link
Copy Markdown
Contributor

@luoyuxia luoyuxia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@polyzos Thanks for the pr. I left minor comments. PTAL

Comment thread .github/workflows/docker.yaml Outdated
Comment thread .github/workflows/docker.yaml Outdated
Comment thread docker/quickstart-flink/Dockerfile Outdated
Comment thread website/community/how-to-release/creating-a-fluss-release.mdx Outdated
Comment thread .github/workflows/docker.yaml Outdated
@luoyuxia
Copy link
Copy Markdown
Contributor

@polyzos Hi, I append a commit improve the quickstart build process, and as #2683 (comment), use separate directories to handle different lake format.
PTAL

Comment thread docker/quickstart-flink/Dockerfile
@polyzos polyzos merged commit ab7a8bd into apache:main Apr 22, 2026
8 checks passed
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>
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>
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.

[docs] Reintroduce a prebuilt fluss-quickstart-flink image for the main quickstart

3 participants