Skip to content

Commit f5beb87

Browse files
committed
[docs] Use $FLUSS_VERSION$ expr in docs and fix broken links
1 parent 50d25a0 commit f5beb87

File tree

23 files changed

+98
-113
lines changed

23 files changed

+98
-113
lines changed

website/docs/engine-flink/ddl.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ CREATE TABLE my_part_log_table (
118118
) PARTITIONED BY (dt);
119119
```
120120
:::note
121-
After the Partitioned (PrimaryKey/Log) Table is created, you need first manually create the corresponding partition using the [Add Partition](/docs/engine-flink/ddl.md#add-partition) statement
121+
After the Partitioned (PrimaryKey/Log) Table is created, you need first manually create the corresponding partition using the [Add Partition](engine-flink/ddl.md#add-partition) statement
122122
before you write/read data into this partition.
123123
:::
124124

@@ -157,7 +157,7 @@ CREATE TABLE my_auto_part_log_table (
157157
);
158158
```
159159

160-
For more details about Auto Partitioned (PrimaryKey/Log) Table, refer to [Auto Partitioning Options](/docs/table-design/data-distribution/partitioning/#auto-partitioning-options).
160+
For more details about Auto Partitioned (PrimaryKey/Log) Table, refer to [Auto Partitioning Options](table-design/data-distribution/partitioning.md#auto-partitioning-options).
161161

162162
### Options
163163

@@ -167,8 +167,8 @@ The supported option in "with" parameters when creating a table are as follows:
167167
|------------------------------------|----------|----------|-------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
168168
| bucket.num | int | optional | The bucket number of Fluss cluster. | The number of buckets of a Fluss table. |
169169
| bucket.key | String | optional | (none) | Specific the distribution policy of the Fluss table. Data will be distributed to each bucket according to the hash value of bucket-key. If you specify multiple fields, delimiter is ','. If the table is with primary key, you can't specific bucket key currently. The bucket keys will always be the primary key(excluding partition key). If the table is not with primary key, you can specific bucket key, and when the bucket key is not specified, the data will be distributed to each bucket randomly. |
170-
| table.* | | | | All the [`table.` prefix configuration](/docs/maintenance/configuration.md) are supported to be defined in "with" options. |
171-
| client.* | | | | All the [`client.` prefix configuration](/docs/maintenance/configuration.md) are supported to be defined in "with" options. |
170+
| table.* | | | | All the [`table.` prefix configuration](maintenance/configuration.md) are supported to be defined in "with" options. |
171+
| client.* | | | | All the [`client.` prefix configuration](maintenance/configuration.md) are supported to be defined in "with" options. |
172172

173173
## Create Table Like
174174

website/docs/engine-flink/getting-started.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ sidebar_position: 1
55

66
# Getting Started with Flink Engine
77
## Quick Start
8-
For a quick introduction to running Flink, refer to the [Quick Start](/docs/quickstart/flink.md) guide.
8+
For a quick introduction to running Flink, refer to the [Quick Start](quickstart/flink.md) guide.
99

1010

1111
## Support Flink Versions
1212
| Fluss Connector Versions | Supported Flink Versions |
1313
|--------------------------|--------------------------|
14-
| 0.5 | 1.18, 1.19, 1.20 |
14+
| $FLUSS_VERSION_SHORT$ | 1.18, 1.19, 1.20 |
1515

1616

1717
## Feature Support
@@ -43,10 +43,10 @@ tar -xzf flink-1.20.1-bin-scala_2.12.tgz
4343
Download [Fluss connector jar](/downloads#fluss-connector) and copy to the lib directory of your Flink home.
4444

4545
```shell
46-
cp fluss-connector-flink-<fluss-version>.jar <FLINK_HOME>/lib/
46+
cp fluss-connector-flink-$FLUSS_VERSION$.jar <FLINK_HOME>/lib/
4747
```
4848
:::note
49-
If you use [Amazon S3](http://aws.amazon.com/s3/), [Aliyun OSS](https://www.aliyun.com/product/oss) or [HDFS(Hadoop Distributed File System)](https://hadoop.apache.org/docs/stable/) as Fluss's [remote storage](/docs/maintenance/tiered-storage/remote-storage),
49+
If you use [Amazon S3](http://aws.amazon.com/s3/), [Aliyun OSS](https://www.aliyun.com/product/oss) or [HDFS(Hadoop Distributed File System)](https://hadoop.apache.org/docs/stable/) as Fluss's [remote storage](maintenance/tiered-storage/remote-storage.md),
5050
you should download the corresponding [Fluss filesystem jar](/downloads#filesystem-jars) and also copy it to the lib directory of your Flink home.
5151
:::
5252

@@ -79,7 +79,7 @@ CREATE CATALOG fluss_catalog WITH (
7979

8080
:::note
8181
1. The `bootstrap.servers` means the Fluss server address. Before you config the `bootstrap.servers`,
82-
you should start the Fluss server first. See [Deploying Fluss](/docs/install-deploy/overview/#how-to-deploy-fluss)
82+
you should start the Fluss server first. See [Deploying Fluss](install-deploy/overview.md#how-to-deploy-fluss)
8383
for how to build a Fluss cluster.
8484
Here, it is assumed that there is a Fluss cluster running on your local machine and the CoordinatorServer port is 9123.
8585
2. The` bootstrap.servers` configuration is used to discover all nodes within the Fluss cluster. It can be set with one or more (up to three) Fluss server addresses (either CoordinatorServer or TabletServer) separated by commas.

website/docs/engine-flink/lookups.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ FOR SYSTEM_TIME AS OF `o`.`ptime` AS `c`
122122
ON `o`.`o_custkey` = `c`.`c_custkey` AND `o`.`o_dt` = `c`.`dt`;
123123
```
124124

125-
For more details about Fluss partitioned table, see [Partitioned Tables](/docs/table-design/data-distribution/partitioning.md).
125+
For more details about Fluss partitioned table, see [Partitioned Tables](table-design/data-distribution/partitioning.md).
126126

127127
### Lookup Options
128128

@@ -266,4 +266,4 @@ ON `o`.`o_custkey` = `c`.`c_custkey` AND `o`.`o_dt` = `c`.`dt`;
266266
-- join key is a prefix set of dimension table primary keys (excluding partition key) + partition key.
267267
```
268268

269-
For more details about Fluss partitioned table, see [Partitioned Tables](/docs/table-design/data-distribution/partitioning.md).
269+
For more details about Fluss partitioned table, see [Partitioned Tables](table-design/data-distribution/partitioning.md).

website/docs/install-deploy/deploying-distributed-cluster.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@ Node1 will deploy the CoordinatorServer and one TabletServer, Node2 and Node3 wi
4747
Go to the [downloads page](/downloads) and download the latest Fluss release. After downloading the latest release, copy the archive to all the nodes and extract it:
4848

4949
```shell
50-
tar -xzf fluss-<fluss-version>-bin.tgz
51-
cd fluss-<fluss-version>/
50+
tar -xzf fluss-$FLUSS_VERSION$-bin.tgz
51+
cd fluss-$FLUSS_VERSION$/
5252
```
5353

5454
### Configuring Fluss
@@ -86,7 +86,7 @@ tablet-server.id: 3
8686
8787
:::note
8888
- `tablet-server.id` is the unique id of the TabletServer, if you have multiple TabletServers, you should set different id for each TabletServer.
89-
- In this example, we only set the properties that must be configured, and for some other properties, you can refer to [Configuration](/docs/maintenance/configuration/) for more details.
89+
- In this example, we only set the properties that must be configured, and for some other properties, you can refer to [Configuration](maintenance/configuration.md) for more details.
9090
:::
9191

9292
### Starting Fluss
@@ -121,7 +121,7 @@ Using Flink SQL Client to interact with Fluss.
121121

122122
#### Preparation
123123

124-
You can start a Flink standalone cluster refer to [Flink Environment Preparation](/docs/engine-flink/getting-started#preparation-when-using-flink-sql-client)
124+
You can start a Flink standalone cluster refer to [Flink Environment Preparation](engine-flink/getting-started.md#preparation-when-using-flink-sql-client)
125125

126126
**Note**: Make sure the [Fluss connector jar](/downloads/) already has copied to the `lib` directory of your Flink home.
127127

@@ -138,4 +138,4 @@ CREATE CATALOG fluss_catalog WITH (
138138
#### Do more with Fluss
139139

140140
After the catalog is created, you can use Flink SQL Client to do more with Fluss, for example, create a table, insert data, query data, etc.
141-
More details please refer to [Flink Getting Started](/docs/engine-flink/getting-started/).
141+
More details please refer to [Flink Getting Started](engine-flink/getting-started.md).

website/docs/install-deploy/deploying-local-cluster.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ Go to the [downloads page](/downloads) and download the latest Fluss release. Ma
2525
package **matching your Java version**. After downloading the latest release, extract it:
2626

2727
```shell
28-
tar -xzf fluss-<fluss-version>-bin.tgz
29-
cd fluss-<fluss-version>/
28+
tar -xzf fluss-$FLUSS_VERSION$-bin.tgz
29+
cd fluss-$FLUSS_VERSION$/
3030
```
3131

3232
## Starting Fluss Local Cluster
@@ -49,7 +49,7 @@ Using Flink SQL Client to interact with Fluss.
4949

5050
#### Preparation
5151

52-
You can start a Flink standalone cluster refer to [Flink Environment Preparation](/docs/engine-flink/getting-started#preparation-when-using-flink-sql-client)
52+
You can start a Flink standalone cluster refer to [Flink Environment Preparation](engine-flink/getting-started.md#preparation-when-using-flink-sql-client)
5353

5454
**Note**: Make sure the [Fluss connector jar](/downloads/) already has copied to the `lib` directory of your Flink home.
5555

@@ -66,4 +66,4 @@ CREATE CATALOG fluss_catalog WITH (
6666
#### Do more with Fluss
6767

6868
After the catalog is created, you can use Flink SQL Client to do more with Fluss, for example, create a table, insert data, query data, etc.
69-
More details please refer to [Flink Getting started](/docs/engine-flink/getting-started/)
69+
More details please refer to [Flink Getting started](engine-flink/getting-started.md)

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

Lines changed: 21 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,6 @@ Recommended configuration: 4 cores, 16GB memory.
2222

2323
Docker and the Docker Compose plugin. All commands were tested with Docker version 27.4.0 and Docker Compose version v2.30.3.
2424

25-
**Environment Variables**
26-
27-
Set the following environment variables in the shell where you execute the commands.
28-
29-
```bash
30-
export FLUSS_VERSION=0.5.0
31-
export FLUSS_QUICKSTART_FLINK_VERSION=1.20-0.5
32-
```
33-
3425
## Deploy with Docker
3526

3627
The following is a brief overview of how to quickly create a complete Fluss testing cluster
@@ -75,7 +66,7 @@ docker run \
7566
--env FLUSS_PROPERTIES="zookeeper.address: zookeeper:2181
7667
coordinator.host: coordinator-server" \
7768
-p 9123:9123 \
78-
-d fluss/fluss:${FLUSS_VERSION} coordinatorServer
69+
-d fluss/fluss:$FLUSS_VERSION$ coordinatorServer
7970
```
8071

8172
### Start Fluss TabletServer
@@ -99,7 +90,7 @@ data.dir: /tmp/fluss/data
9990
remote.data.dir: /tmp/fluss/remote-data" \
10091
-p 9124:9124 \
10192
--volume shared-tmpfs:/tmp/fluss \
102-
-d fluss/fluss:${FLUSS_VERSION} tabletServer
93+
-d fluss/fluss:$FLUSS_VERSION$ tabletServer
10394
```
10495

10596
#### Start with Multiple TabletServer
@@ -120,7 +111,7 @@ data.dir: /tmp/fluss/data/tablet-server-0
120111
remote.data.dir: /tmp/fluss/remote-data" \
121112
-p 9124:9124 \
122113
--volume shared-tmpfs:/tmp/fluss \
123-
-d fluss/fluss:${FLUSS_VERSION} tabletServer
114+
-d fluss/fluss:$FLUSS_VERSION$ tabletServer
124115
```
125116

126117
2. start tablet-server-1
@@ -136,7 +127,7 @@ data.dir: /tmp/fluss/data/tablet-server-1
136127
remote.data.dir: /tmp/fluss/remote-data" \
137128
-p 9125:9125 \
138129
--volume shared-tmpfs:/tmp/fluss \
139-
-d fluss/fluss:${FLUSS_VERSION} tabletServer
130+
-d fluss/fluss:$FLUSS_VERSION$ tabletServer
140131
```
141132

142133
3. start tablet-server-2
@@ -152,7 +143,7 @@ data.dir: /tmp/fluss/data/tablet-server-2
152143
remote.data.dir: /tmp/fluss/remote-data" \
153144
-p 9126:9126 \
154145
--volume shared-tmpfs:/tmp/fluss \
155-
-d fluss/fluss:${FLUSS_VERSION} tabletServer
146+
-d fluss/fluss:$FLUSS_VERSION$ tabletServer
156147
```
157148

158149
Now all the Fluss related components are running.
@@ -180,7 +171,7 @@ docker run \
180171
--env FLINK_PROPERTIES=" jobmanager.rpc.address: jobmanager" \
181172
-p 8083:8081 \
182173
--volume shared-tmpfs:/tmp/fluss \
183-
-d fluss/quickstart-flink:${FLUSS_QUICKSTART_FLINK_VERSION} jobmanager
174+
-d fluss/quickstart-flink:1.20-$FLUSS_VERSION_SHORT$ jobmanager
184175
```
185176

186177
2. start taskManager
@@ -191,7 +182,7 @@ docker run \
191182
--network=fluss-demo \
192183
--env FLINK_PROPERTIES=" jobmanager.rpc.address: jobmanager" \
193184
--volume shared-tmpfs:/tmp/fluss \
194-
-d fluss/quickstart-flink:${FLUSS_QUICKSTART_FLINK_VERSION} taskmanager
185+
-d fluss/quickstart-flink:1.20-$FLUSS_VERSION_SHORT$ taskmanager
195186
```
196187

197188
#### Enter into SQL-Client
@@ -222,7 +213,7 @@ USE CATALOG fluss_catalog;
222213
#### Do more with Fluss
223214

224215
After the catalog is created, you can use Flink SQL Client to do more with Fluss, for example, create a table, insert data, query data, etc.
225-
More details please refer to [Flink Getting started](/docs/engine-flink/getting-started/)
216+
More details please refer to [Flink Getting started](engine-flink/getting-started.md)
226217

227218
## Deploy with Docker Compose
228219

@@ -237,7 +228,7 @@ You can use the following `docker-compose.yml` file to start a Fluss cluster wit
237228
```yaml
238229
services:
239230
coordinator-server:
240-
image: fluss/fluss:${FLUSS_VERSION}
231+
image: fluss/fluss:$FLUSS_VERSION$
241232
command: coordinatorServer
242233
depends_on:
243234
- zookeeper
@@ -248,7 +239,7 @@ services:
248239
coordinator.host: coordinator-server
249240
remote.data.dir: /tmp/fluss/remote-data
250241
tablet-server:
251-
image: fluss/fluss:${FLUSS_VERSION}
242+
image: fluss/fluss:$FLUSS_VERSION$
252243
command: tabletServer
253244
depends_on:
254245
- coordinator-server
@@ -282,7 +273,7 @@ You can use the following `docker-compose.yml` file to start a Fluss cluster wit
282273
```yaml
283274
services:
284275
coordinator-server:
285-
image: fluss/fluss:${FLUSS_VERSION}
276+
image: fluss/fluss:$FLUSS_VERSION$
286277
command: coordinatorServer
287278
depends_on:
288279
- zookeeper
@@ -293,7 +284,7 @@ services:
293284
coordinator.host: coordinator-server
294285
remote.data.dir: /tmp/fluss/remote-data
295286
tablet-server-0:
296-
image: fluss/fluss:${FLUSS_VERSION}
287+
image: fluss/fluss:$FLUSS_VERSION$
297288
command: tabletServer
298289
depends_on:
299290
- coordinator-server
@@ -309,7 +300,7 @@ services:
309300
volumes:
310301
- shared-tmpfs:/tmp/fluss
311302
tablet-server-1:
312-
image: fluss/fluss:${FLUSS_VERSION}
303+
image: fluss/fluss:$FLUSS_VERSION$
313304
command: tabletServer
314305
depends_on:
315306
- coordinator-server
@@ -325,7 +316,7 @@ services:
325316
volumes:
326317
- shared-tmpfs:/tmp/fluss
327318
tablet-server-2:
328-
image: fluss/fluss:${FLUSS_VERSION}
319+
image: fluss/fluss:$FLUSS_VERSION$
329320
command: tabletServer
330321
depends_on:
331322
- coordinator-server
@@ -371,7 +362,7 @@ The changed `docker-compose.yml` file is as follows:
371362
```yaml
372363
services:
373364
coordinator-server:
374-
image: fluss/fluss:${FLUSS_VERSION}
365+
image: fluss/fluss:$FLUSS_VERSION$
375366
command: coordinatorServer
376367
depends_on:
377368
- zookeeper
@@ -382,7 +373,7 @@ services:
382373
coordinator.host: coordinator-server
383374
remote.data.dir: /tmp/fluss/remote-data
384375
tablet-server-0:
385-
image: fluss/fluss:${FLUSS_VERSION}
376+
image: fluss/fluss:$FLUSS_VERSION$
386377
command: tabletServer
387378
depends_on:
388379
- coordinator-server
@@ -398,7 +389,7 @@ services:
398389
volumes:
399390
- shared-tmpfs:/tmp/fluss
400391
tablet-server-1:
401-
image: fluss/fluss:${FLUSS_VERSION}
392+
image: fluss/fluss:$FLUSS_VERSION$
402393
command: tabletServer
403394
depends_on:
404395
- coordinator-server
@@ -414,7 +405,7 @@ services:
414405
volumes:
415406
- shared-tmpfs:/tmp/fluss
416407
tablet-server-2:
417-
image: fluss/fluss:${FLUSS_VERSION}
408+
image: fluss/fluss:$FLUSS_VERSION$
418409
command: tabletServer
419410
depends_on:
420411
- coordinator-server
@@ -433,7 +424,7 @@ services:
433424
restart: always
434425
image: zookeeper:3.9.2
435426
jobmanager:
436-
image: fluss/quickstart-flink:${FLUSS_QUICKSTART_FLINK_VERSION}
427+
image: fluss/quickstart-flink:1.20-$FLUSS_VERSION_SHORT$
437428
ports:
438429
- "8083:8081"
439430
command: jobmanager
@@ -444,7 +435,7 @@ services:
444435
volumes:
445436
- shared-tmpfs:/tmp/fluss
446437
taskmanager:
447-
image: fluss/quickstart-flink:${FLUSS_QUICKSTART_FLINK_VERSION}
438+
image: fluss/quickstart-flink:1.20-$FLUSS_VERSION_SHORT$
448439
depends_on:
449440
- jobmanager
450441
command: taskmanager
@@ -486,4 +477,4 @@ USE CATALOG fluss_catalog;
486477
#### Do more with Fluss
487478

488479
After the catalog is created, you can use Flink SQL Client to do more with Fluss, for example, create a table, insert data, query data, etc.
489-
More details please refer to [Flink Getting started](/docs/engine-flink/getting-started/)
480+
More details please refer to [Flink Getting started](engine-flink/getting-started.md)

0 commit comments

Comments
 (0)