You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@fluss.apache.org by ja...@apache.org on 2026/09/21 02:28:23 UTC
(fluss) branch release-1.0 updated: [docs] Make Quickstart container checks explicit (#4435)
This is an automated email from the ASF dual-hosted git repository.
wuchong pushed a commit to branch release-1.0
in repository https://gitbox.apache.org/repos/asf/fluss.git
The following commit(s) were added to refs/heads/release-1.0 by this push:
new 75e6248f8 [docs] Make Quickstart container checks explicit (#4435)
75e6248f8 is described below
commit 75e6248f86af790d95f58f3943a51e832b5b1f08
Author: Jark Wu <ja...@apache.org>
AuthorDate: Mon Sep 21 10:28:18 2026 +0800
[docs] Make Quickstart container checks explicit (#4435)
Count the expected long-running containers in each Quickstart stack and point users to the full Compose status when the count is lower.
Co-Authored-By: Codex <no...@openai.com>
AI-Model: gpt-5
AI-Contributed/Feature: 71/71
AI-Contributed/UT: 0/0
(cherry picked from commit 58813cadb928237cd357ccec913d90d1b45426cf)
---
website/docs/quickstart/flink.md | 13 ++++++++++---
website/docs/quickstart/gateway-lakehouse.md | 13 +++++++++----
website/docs/quickstart/lakehouse.md | 26 ++++++++++++++++++++------
website/docs/quickstart/page_user_profile.mdx | 7 ++++---
website/docs/quickstart/security.md | 10 +++++++---
5 files changed, 50 insertions(+), 19 deletions(-)
diff --git a/website/docs/quickstart/flink.md b/website/docs/quickstart/flink.md
index 253e396d1..73241439d 100644
--- a/website/docs/quickstart/flink.md
+++ b/website/docs/quickstart/flink.md
@@ -160,11 +160,18 @@ docker compose up -d
```
This command automatically starts all the containers defined in the Docker Compose configuration in detached mode.
-Run
+Count the long-running containers (excluding the one-shot `rustfs-init` service and the
+interactive `sql-client` service):
+
```shell
-docker compose ps
+docker compose ps --status running --quiet \
+ rustfs coordinator-server tablet-server zookeeper jobmanager taskmanager | wc -l
```
-to check whether all containers are running properly.
+
+The expected output is `6`. The `rustfs-init` service should exit successfully, and the
+`sql-client` service may exit because no interactive terminal is attached. A lower
+number means that one or more long-running containers failed to start. Run
+`docker compose ps -a` to identify them.
4. Verify the setup. You can visit http://localhost:8083/ to see if Flink is running normally. The S3 bucket for Fluss tiered storage is automatically created by the `rustfs-init` service. You can access the RustFS console at http://localhost:9001 with credentials `rustfsadmin/rustfsadmin` to view the `fluss` bucket.
diff --git a/website/docs/quickstart/gateway-lakehouse.md b/website/docs/quickstart/gateway-lakehouse.md
index 258e7e472..66c405593 100644
--- a/website/docs/quickstart/gateway-lakehouse.md
+++ b/website/docs/quickstart/gateway-lakehouse.md
@@ -235,13 +235,18 @@ for information on how to setup cloud file systems.
```shell
docker compose up -d
-docker compose ps
+docker compose ps --status running --quiet \
+ rustfs coordinator-server tablet-server zookeeper gateway jobmanager taskmanager | wc -l
```
+The second command should output `7`. A lower number means that one or more
+long-running containers failed to start. Run `docker compose ps -a` to identify them.
+
:::note
-The `sql-client` service may exit after `docker compose up -d` because no
-interactive terminal is attached. This is expected. You will start a new SQL
-client container with `docker compose run --rm sql-client` later in this guide.
+The count excludes the one-shot `rustfs-init` service and the interactive
+`sql-client` service. The `sql-client` service may exit after `docker compose up -d`
+because no interactive terminal is attached. This is expected. You will start a new
+SQL client container with `docker compose run --rm sql-client` later in this guide.
:::
5. Wait until the Gateway can reach Fluss:
diff --git a/website/docs/quickstart/lakehouse.md b/website/docs/quickstart/lakehouse.md
index 228e35451..6f3c85bb8 100644
--- a/website/docs/quickstart/lakehouse.md
+++ b/website/docs/quickstart/lakehouse.md
@@ -191,11 +191,18 @@ docker compose up -d
```
This command automatically starts all the containers defined in the Docker Compose configuration in detached mode.
-Run
+Count the long-running containers (excluding the one-shot `rustfs-init` service and the
+interactive `sql-client` service):
+
```shell
-docker compose ps
+docker compose ps --status running --quiet \
+ rustfs coordinator-server tablet-server zookeeper jobmanager taskmanager | wc -l
```
-to check whether all containers are running properly.
+
+The expected output is `6`. The `rustfs-init` service should exit successfully, and the
+`sql-client` service may exit because no interactive terminal is attached. A lower
+number means that one or more long-running containers failed to start. Run
+`docker compose ps -a` to identify them.
You can also visit http://localhost:8083/ to see if Flink is running normally.
@@ -405,11 +412,18 @@ docker compose up -d
```
This command automatically starts all the containers defined in the Docker Compose configuration in detached mode.
-Run
+Count the long-running containers (excluding the one-shot `rustfs-init` service and the
+interactive `sql-client` service):
+
```shell
-docker compose ps
+docker compose ps --status running --quiet \
+ rustfs postgres coordinator-server tablet-server zookeeper jobmanager taskmanager | wc -l
```
-to check whether all containers are running properly.
+
+The expected output is `7`. The `rustfs-init` service should exit successfully, and the
+`sql-client` service may exit because no interactive terminal is attached. A lower
+number means that one or more long-running containers failed to start. Run
+`docker compose ps -a` to identify them.
You can also visit http://localhost:8083/ to see if Flink is running normally.
diff --git a/website/docs/quickstart/page_user_profile.mdx b/website/docs/quickstart/page_user_profile.mdx
index 2478a0b18..d9eb769cb 100644
--- a/website/docs/quickstart/page_user_profile.mdx
+++ b/website/docs/quickstart/page_user_profile.mdx
@@ -123,11 +123,12 @@ Before proceeding, ensure that [Docker](https://docs.docker.com/engine/install/)
docker compose up -d
```
-4. Confirm all containers are running.
+4. Count the long-running containers (the interactive `sql-client` service is excluded).
```shell
- docker compose ps
+ docker compose ps --status running --quiet \
+ coordinator-server tablet-server zookeeper jobmanager taskmanager | wc -l
```
- You should see `coordinator-server`, `tablet-server`, `zookeeper`, `jobmanager`, `taskmanager`, and `sql-client` all in the `running` state.
+ The expected output is `5`. A lower number means that one or more containers failed to start. Run `docker compose ps -a` to identify them. The `sql-client` service may exit because no interactive terminal is attached; this is expected because a new SQL client container is started later with `docker compose run sql-client`.
:::note
All the following commands involving `docker compose` should be executed in the working directory that contains the `docker-compose.yml` file.
diff --git a/website/docs/quickstart/security.md b/website/docs/quickstart/security.md
index 603dad8b7..eff39ad4b 100644
--- a/website/docs/quickstart/security.md
+++ b/website/docs/quickstart/security.md
@@ -151,11 +151,15 @@ docker compose up -d
```
This command automatically starts all the containers defined in the Docker Compose configuration in detached mode.
-Run
+Count the long-running containers:
+
```shell
-docker container ls -a
+docker compose ps --status running --quiet \
+ coordinator-server tablet-server zookeeper jobmanager taskmanager | wc -l
```
-to check whether all containers are running properly.
+
+The expected output is `5`. A lower number means that one or more containers failed
+to start. Run `docker compose ps -a` to identify them.
You can also visit http://localhost:8083/ to see if Flink is running normally.