Skip to content

Commit e06641b

Browse files
committed
refine doc
1 parent 8a88a91 commit e06641b

2 files changed

Lines changed: 18 additions & 21 deletions

File tree

website/docs/maintenance/operations/updating-configs.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -32,16 +32,10 @@ admin.alterClusterConfigs(
3232
new AlterConfig(DATALAKE_ENABLED.key(), "true", AlterConfigOpType.SET),
3333
new AlterConfig(DATALAKE_FORMAT.key(), "paimon", AlterConfigOpType.SET)));
3434

35-
// Pre-bind the lakehouse format without enabling lakehouse tables
36-
admin.alterClusterConfigs(
37-
Arrays.asList(
38-
new AlterConfig(DATALAKE_ENABLED.key(), "false", AlterConfigOpType.SET),
39-
new AlterConfig(DATALAKE_FORMAT.key(), "paimon", AlterConfigOpType.SET)));
40-
41-
// Return to legacy behavior where configuring datalake.format alone also enables lakehouse tables
35+
// Disable lakehouse storage
4236
admin.alterClusterConfigs(
4337
Collections.singletonList(
44-
new AlterConfig(DATALAKE_ENABLED.key(), null, AlterConfigOpType.DELETE)));
38+
new AlterConfig(DATALAKE_ENABLED.key(), "false", AlterConfigOpType.SET)));
4539

4640
// Set RocksDB shared rate limiter to 200MB/sec
4741
admin.alterClusterConfigs(
@@ -54,8 +48,6 @@ The `AlterConfig` class contains three properties:
5448
* `value`: The configuration value to be set (e.g., `paimon`)
5549
* `opType`: The operation type, either `AlterConfigOpType.SET` or `AlterConfigOpType.DELETE`
5650

57-
If `datalake.enabled` is explicitly configured, `datalake.format` must also be configured in the cluster.
58-
5951
### Using Flink Stored Procedures
6052

6153
For certain configurations, Fluss provides convenient Flink stored procedures that can be called directly from Flink SQL. See [Procedures](engine-flink/procedures.md#cluster-configuration-procedures) for detailed documentation on using `get_cluster_config` and `set_cluster_config` procedures.

website/docs/maintenance/operations/upgrade-notes-0.10.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,35 +5,40 @@ sidebar_position: 4
55

66
# Upgrade Notes from v0.9 to v0.10
77

8-
## New `datalake.enabled` Cluster Configuration
8+
## Cluster Configuration Changes
99

10-
Starting from v0.10, Fluss introduces the cluster-level configuration `datalake.enabled` to control whether the cluster is ready to create and manage lakehouse tables.
10+
### New `datalake.enabled` Cluster Configuration
1111

12-
### Behavior Changes
12+
Starting in v0.10, Fluss introduces the cluster-level configuration `datalake.enabled` to control whether the cluster is ready to create and manage lakehouse tables.
1313

14-
- If `datalake.enabled` is unset, Fluss keeps the legacy behavior: configuring `datalake.format` alone also enables lakehouse tables.
15-
- If `datalake.enabled = false`, Fluss only pre-binds the lake format for newly created tables and does not allow lakehouse tables yet.
14+
#### Behavior Changes
15+
16+
- If `datalake.enabled` is unset, Fluss preserves the legacy behavior: configuring `datalake.format` alone also enables lakehouse tables.
17+
- If `datalake.enabled = false`, Fluss pre-binds the lake format for newly created tables but does not allow lakehouse tables yet.
1618
- If `datalake.enabled = true`, Fluss fully enables lakehouse tables.
1719
- If `datalake.enabled` is explicitly configured, `datalake.format` must also be configured.
1820

19-
### Recommended Configuration
21+
#### Recommended Configuration
2022

21-
If you want to enable lakehouse tables on the cluster, configure both options together:
23+
To enable lakehouse tables for the cluster, configure both options together:
2224

2325
```yaml
2426
datalake.enabled: true
2527
datalake.format: paimon
2628
```
2729
28-
If you only want to pre-bind the lake format without enabling lakehouse tables yet, configure:
30+
To pre-bind the lake format without enabling lakehouse tables yet, configure:
2931
3032
```yaml
3133
datalake.enabled: false
3234
datalake.format: paimon
3335
```
3436
35-
### Documentation Updates for Existing Deployments
37+
This mode is useful when you want newly created tables to carry the lake format in advance, while postponing lakehouse enablement at the cluster level.
38+
After `datalake.enabled` is later set to `true`, tables created under this configuration can still turn on `table.datalake.enabled` without being recreated.
39+
40+
#### Notes for Existing Deployments
3641

37-
If your existing deployment or internal scripts only set `datalake.format`, they will continue to work with the legacy behavior as long as `datalake.enabled` is left unset.
42+
If your existing deployment or internal scripts only set `datalake.format`, they will continue to work with the legacy behavior as long as `datalake.enabled` remains unset.
3843

39-
However, for new configuration examples and operational guidance, prefer configuring `datalake.enabled` explicitly together with `datalake.format`.
44+
For new configuration examples and operational guidance, we recommend explicitly configuring `datalake.enabled` together with `datalake.format`.

0 commit comments

Comments
 (0)