[docs] Introduce $FLUSS_DOCKER_VERSION$ expression to reference docker image version (#1094)

Author: wuchong

website/community/how-to-contribute/contribute-docs.md

@@ -116,6 +116,7 @@ git checkout release-0.5
 Fluss documentation uses placeholder variables that are automatically replaced during the build process. Note that these variables are only available for documentation under `website/docs/*`.
 - `$FLUSS_VERSION$`: Expands to the full version (e.g., "0.6.0")
 - `$FLUSS_VERSION_SHORT$`: Expands to the short version (e.g., "0.6")
+- `$FLUSS_DOCKER_VERSION$`: Expands to the docker version (e.g., "0.6.0-rc1"), it is suggested to use this variable when referring to the docker image version that we can link to a RC version during release testing.
 
 For example, to link to a specific version of Fluss binary:
 

website/docs/install-deploy/deploying-with-docker.md

@@ -82,7 +82,7 @@ advertised.listeners: CLIENT://localhost:9123
 internal.listener.name: INTERNAL
 " \
     -p 9123:9123 \
-    -d fluss/fluss:$FLUSS_VERSION$ coordinatorServer
+    -d fluss/fluss:$FLUSS_DOCKER_VERSION$ coordinatorServer
 ```
 
 ### Start Fluss TabletServer
@@ -108,7 +108,7 @@ data.dir: /tmp/fluss/data
 remote.data.dir: /tmp/fluss/remote-data" \
     -p 9124:9123 \
     --volume shared-tmpfs:/tmp/fluss \
-    -d fluss/fluss:$FLUSS_VERSION$ tabletServer
+    -d fluss/fluss:$FLUSS_DOCKER_VERSION$ tabletServer
 ```
 
 #### Start with Multiple TabletServer
@@ -131,7 +131,7 @@ data.dir: /tmp/fluss/data/tablet-server-0
 remote.data.dir: /tmp/fluss/remote-data" \
     -p 9124:9123 \
     --volume shared-tmpfs:/tmp/fluss \
-    -d fluss/fluss:$FLUSS_VERSION$ tabletServer
+    -d fluss/fluss:$FLUSS_DOCKER_VERSION$ tabletServer
 ```
 
 2. Start tablet-server-1
@@ -149,7 +149,7 @@ data.dir: /tmp/fluss/data/tablet-server-1
 remote.data.dir: /tmp/fluss/remote-data" \
     -p 9125:9123 \
     --volume shared-tmpfs:/tmp/fluss \
-    -d fluss/fluss:$FLUSS_VERSION$ tabletServer
+    -d fluss/fluss:$FLUSS_DOCKER_VERSION$ tabletServer
 ```
 
 3. Start tablet-server-2
@@ -167,7 +167,7 @@ data.dir: /tmp/fluss/data/tablet-server-2
 remote.data.dir: /tmp/fluss/remote-data" \
     -p 9126:9123 \
     --volume shared-tmpfs:/tmp/fluss \
-    -d fluss/fluss:$FLUSS_VERSION$ tabletServer
+    -d fluss/fluss:$FLUSS_DOCKER_VERSION$ tabletServer
 ```
 
 Now all the Fluss related components are running.
@@ -191,7 +191,7 @@ You can use the following `docker-compose.yml` file to start a Fluss cluster wit
 ```yaml
 services:
   coordinator-server:
-    image: fluss/fluss:$FLUSS_VERSION$
+    image: fluss/fluss:$FLUSS_DOCKER_VERSION$
     command: coordinatorServer
     depends_on:
       - zookeeper
@@ -206,7 +206,7 @@ services:
     ports:
       - "9123:9123"
   tablet-server:
-    image: fluss/fluss:$FLUSS_VERSION$
+    image: fluss/fluss:$FLUSS_DOCKER_VERSION$
     command: tabletServer
     depends_on:
       - coordinator-server
@@ -244,7 +244,7 @@ You can use the following `docker-compose.yml` file to start a Fluss cluster wit
 ```yaml
 services:
   coordinator-server:
-    image: fluss/fluss:$FLUSS_VERSION$
+    image: fluss/fluss:$FLUSS_DOCKER_VERSION$
     command: coordinatorServer
     depends_on:
       - zookeeper
@@ -259,7 +259,7 @@ services:
     ports:
       - "9123:9123"
   tablet-server-0:
-    image: fluss/fluss:$FLUSS_VERSION$
+    image: fluss/fluss:$FLUSS_DOCKER_VERSION$
     command: tabletServer
     depends_on:
       - coordinator-server
@@ -279,7 +279,7 @@ services:
     volumes:
       - shared-tmpfs:/tmp/fluss
   tablet-server-1:
-    image: fluss/fluss:$FLUSS_VERSION$
+    image: fluss/fluss:$FLUSS_DOCKER_VERSION$
     command: tabletServer
     depends_on:
       - coordinator-server
@@ -299,7 +299,7 @@ services:
     volumes:
       - shared-tmpfs:/tmp/fluss
   tablet-server-2:
-    image: fluss/fluss:$FLUSS_VERSION$
+    image: fluss/fluss:$FLUSS_DOCKER_VERSION$
     command: tabletServer
     depends_on:
       - coordinator-server

website/docs/maintenance/observability/quickstart.md

@@ -64,7 +64,7 @@ The container manifest below configures Fluss to use Logback and Loki4j. Save it
 ```dockerfile
 ARG FLUSS_VERSION
 
-FROM fluss/fluss:$FLUSS_VERSION$
+FROM fluss/fluss:$FLUSS_DOCKER_VERSION$
 
 # remove default logging backend from classpath and add logback to classpath
 RUN rm -rf ${FLUSS_HOME}/lib/log4j-slf4j-impl-*.jar && \
@@ -96,7 +96,7 @@ To do this, you can simply copy the manifest below into your `docker-compose.yml
 services:
   #begin Fluss cluster
   coordinator-server:
-    image: fluss-slf4j-logback:$FLUSS_VERSION$
+    image: fluss-slf4j-logback:$FLUSS_DOCKER_VERSION$
     build:
       args:
         FLUSS_VERSION: $FLUSS_VERSION$
@@ -118,7 +118,7 @@ services:
         logback.configurationFile: logback-loki-console.xml
       - APP_NAME=coordinator-server
   tablet-server:
-    image: fluss-slf4j-logback:$FLUSS_VERSION$
+    image: fluss-slf4j-logback:$FLUSS_DOCKER_VERSION$
     build:
       args:
         FLUSS_VERSION: $FLUSS_VERSION$
@@ -147,7 +147,7 @@ services:
   #end
   #begin Flink cluster
   jobmanager:
-    image: fluss/quickstart-flink:1.20-$FLUSS_VERSION_SHORT$
+    image: fluss/quickstart-flink:1.20-$FLUSS_DOCKER_VERSION$
     ports:
       - "8083:8081"
     command: jobmanager
@@ -160,7 +160,7 @@ services:
     volumes:
       - shared-tmpfs:/tmp/paimon
   taskmanager:
-    image: fluss/quickstart-flink:1.20-$FLUSS_VERSION_SHORT$
+    image: fluss/quickstart-flink:1.20-$FLUSS_DOCKER_VERSION$
     depends_on:
       - jobmanager
     command: taskmanager

website/docs/quickstart/flink.md

@@ -55,7 +55,7 @@ cd fluss-quickstart-flink
 services:
   #begin Fluss cluster
   coordinator-server:
-    image: fluss/fluss:$FLUSS_VERSION$
+    image: fluss/fluss:$FLUSS_DOCKER_VERSION$
     command: coordinatorServer
     depends_on:
       - zookeeper
@@ -71,7 +71,7 @@ services:
     volumes:
       - shared-tmpfs:/tmp/paimon
   tablet-server:
-    image: fluss/fluss:$FLUSS_VERSION$
+    image: fluss/fluss:$FLUSS_DOCKER_VERSION$
     command: tabletServer
     depends_on:
       - coordinator-server
@@ -94,7 +94,7 @@ services:
   #end
   #begin Flink cluster
   jobmanager:
-    image: fluss/quickstart-flink:1.20-$FLUSS_VERSION_SHORT$
+    image: fluss/quickstart-flink:1.20-$FLUSS_DOCKER_VERSION$
     ports:
       - "8083:8081"
     command: jobmanager
@@ -105,7 +105,7 @@ services:
     volumes:
       - shared-tmpfs:/tmp/paimon
   taskmanager:
-    image: fluss/quickstart-flink:1.20-$FLUSS_VERSION_SHORT$
+    image: fluss/quickstart-flink:1.20-$FLUSS_DOCKER_VERSION$
     depends_on:
       - jobmanager
     command: taskmanager

website/fluss-versions.json

@@ -2,21 +2,25 @@
   {
     "versionName": "next",
     "fullVersion": "0.8-SNAPSHOT",
-    "shortVersion": "0.8-SNAPSHOT"
+    "shortVersion": "0.8-SNAPSHOT",
+    "dockerVersion": "0.8-SNAPSHOT"
   },
   {
     "versionName": "version-0.7",
     "fullVersion": "0.7.0",
-    "shortVersion": "0.7"
+    "shortVersion": "0.7",
+    "dockerVersion": "v0.7.0-rc2"
   },
   {
     "versionName": "version-0.6",
     "fullVersion": "0.6.0",
-    "shortVersion": "0.6"
+    "shortVersion": "0.6",
+    "dockerVersion": "0.6.0"
   },
   {
     "versionName": "version-0.5",
     "fullVersion": "0.5.0",
-    "shortVersion": "0.5"
+    "shortVersion": "0.5",
+    "dockerVersion": "0.5.0"
   }
 ]

website/src/plugins/remark-version-replace/index.js

@@ -52,6 +52,7 @@ const plugin = (options) => {
         const replacements = {
             "$FLUSS_VERSION$": version.fullVersion,
             "$FLUSS_VERSION_SHORT$": version.shortVersion,
+            "$FLUSS_DOCKER_VERSION$": version.dockerVersion
         };
 
         // RegExp to find any replacement keys.