Skip to content

Commit db093f6

Browse files
committed
fix(influxdb3): Enterprise: update options in CLI reference:
Add options new in Beta Remove old options, add see references, add anchors for backward compat. Fix link checker test to not fail when no links exist in the article
1 parent 1ac88a6 commit db093f6

File tree

2 files changed

+184
-132
lines changed

2 files changed

+184
-132
lines changed

content/influxdb3/enterprise/reference/config-options.md

+67-66
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ influxdb3 serve
5454
- [object-store](#object-store)
5555
- [data-dir](#data-dir)
5656
- [node-id](#node-id)
57+
- [cluster-id](#cluster-id)
5758
- [mode](#mode)
5859
- [license-email](#license-email)
5960
- [query-file-limit](#query-file-limit)
@@ -112,7 +113,6 @@ influxdb3 serve
112113
- [Memory](#memory)
113114
- [ram-pool-data-bytes](#ram-pool-data-bytes)
114115
- [exec-mem-pool-bytes](#exec-mem-pool-bytes)
115-
- [buffer-mem-limit-mb](#buffer-mem-limit-mb)
116116
- [force-snapshot-mem-threshold](#force-snapshot-mem-threshold)
117117
- [Write-Ahead Log (WAL)](#write-ahead-log-wal)
118118
- [wal-flush-interval](#wal-flush-interval)
@@ -123,17 +123,14 @@ influxdb3 serve
123123
- [read-from-node-ids](#read-from-node-ids)
124124
- [replication-interval](#replication-interval)
125125
- [Compaction](#compaction)
126-
- [compactor-id](#compactor-id)
127-
- [compact-from-node-ids](#compact-from-node-ids)
128-
- [run-compactions](#run-compactions)
129126
- [compaction-row-limit](#compaction-row-limit)
130127
- [compaction-max-num-files-per-plan](#compaction-max-num-files-per-plan)
131128
- [compaction-gen2-duration](#compaction-gen2-duration)
132129
- [compaction-multipliers](#compaction-multipliers)
133130
- [gen1-duration](#gen1-duration)
134131
- [Caching](#caching)
135132
- [preemptive-cache-age](#preemptive-cache-age)
136-
- [parquet-mem-cache-size-mb](#parquet-mem-cache-size-mb)
133+
- [parquet-mem-cache-size](#parquet-mem-cache-size)
137134
- [parquet-mem-cache-prune-percentage](#parquet-mem-cache-prune-percentage)
138135
- [parquet-mem-cache-prune-interval](#parquet-mem-cache-prune-interval)
139136
- [disable-parquet-mem-cache](#disable-parquet-mem-cache)
@@ -153,6 +150,7 @@ influxdb3 serve
153150
- [bucket](#bucket)
154151
- [data-dir](#data-dir)
155152
- [node-id](#node-id)
153+
- [cluster-id](#cluster-id)
156154
- [mode](#mode)
157155
- [license-email](#license-email)
158156
- [query-file-limit](#query-file-limit)
@@ -162,12 +160,12 @@ influxdb3 serve
162160
Specifies which object storage to use to store Parquet files.
163161
This option supports the following values:
164162

165-
- `memory` _(default)_
166-
- `memory-throttled`
167-
- `file`
168-
- `s3`
169-
- `google`
170-
- `azure`
163+
- `memory` _(default)_: Effectively no object persistence
164+
- `memory-throttled`: Like `memory` but with latency and throughput that somewhat resembles a cloud object store
165+
- `file`: Stores objects in the local filesystem (must also set `--data-dir`)
166+
- `s3`: Amazon S3 (must also set `--bucket`, `--aws-access-key-id`, `--aws-secret-access-key`, and possibly `--aws-default-region`)
167+
- `google`: Google Cloud Storage (must also set `--bucket` and `--google-service-account`)
168+
- `azure`: Microsoft Azure blob storage (must also set `--bucket`, `--azure-storage-account`, and `--azure-storage-access-key`)
171169

172170
| influxdb3 serve option | Environment variable |
173171
| :--------------------- | :----------------------- |
@@ -197,17 +195,30 @@ configuration--for example, the same bucket.
197195

198196
---
199197

198+
#### cluster-id
199+
200+
Specifies the cluster identifier that prefixes the object store path for the Enterprise Catalog.
201+
This value must be different than the [`--node-id`](#node-id) value.
202+
203+
| influxdb3 serve option | Environment variable |
204+
| :--------------------- | :--------------------------------- |
205+
| `--cluster-id` | `INFLUXDB3_ENTERPRISE_CLUSTER_ID` |
206+
207+
---
208+
200209
#### mode
201210

202211
Sets the mode to start the server in.
203212

204213
This option supports the following values:
205214

206-
- `read`
207-
- `read_write` _(default)_
208-
- `compactor`
215+
- `all` _(default)_
216+
- `ingest`
217+
- `query`
218+
- `compact`
219+
- `process`
209220

210-
**Default:** `read_write`
221+
**Default:** `all`
211222

212223
| influxdb3 serve option | Environment variable |
213224
| :--------------------- | :-------------------------- |
@@ -844,36 +855,25 @@ Specifies the size of the RAM cache used to store data, in bytes.
844855

845856
#### exec-mem-pool-bytes
846857

847-
Specifies the size of the memory pool used during query execution, in bytes.
858+
Specifies the size of memory pool used during query execution.
859+
Can be given as absolute value in bytes or as a percentage of the total available memory (for example: `10%`).
848860

849-
**Default:** `8589934592`
861+
**Default:** `20%`
850862

851863
| influxdb3 serve option | Environment variable |
852864
| :---------------------- | :------------------------------ |
853865
| `--exec-mem-pool-bytes` | `INFLUXDB3_EXEC_MEM_POOL_BYTES` |
854866

855867
---
856868

857-
#### buffer-mem-limit-mb
858-
859-
Specifies the size limit of the buffered data in MB. If this limit is exceeded,
860-
the server forces a snapshot.
861-
862-
**Default:** `5000`
863-
864-
| influxdb3 serve option | Environment variable |
865-
| :---------------------- | :------------------------------ |
866-
| `--buffer-mem-limit-mb` | `INFLUXDB3_BUFFER_MEM_LIMIT_MB` |
867-
868-
---
869-
870869
#### force-snapshot-mem-threshold
870+
<span id="buffer-mem-limit-mb" />
871871

872872
Specifies the threshold for the internal memory buffer. Supports either a
873-
percentage (portion of available memory)of or absolute value
874-
(total bytes)--for example: `70%` or `100000`.
873+
percentage (portion of available memory) or absolute value in MB
874+
(total bytes)--for example: `70%` or `1000 MB`.
875875

876-
**Default:** `70%`
876+
**Default:** `50%`
877877

878878
| influxdb3 serve option | Environment variable |
879879
| :------------------------------- | :--------------------------------------- |
@@ -972,47 +972,31 @@ Defines the interval at which each replica specified in the
972972

973973
### Compaction
974974

975-
- [compactor-id](#compactor-id)
976-
- [compact-from-node-ids](#compact-from-node-ids)
977-
- [run-compactions](#run-compactions)
978975
- [compaction-row-limit](#compaction-row-limit)
979976
- [compaction-max-num-files-per-plan](#compaction-max-num-files-per-plan)
980977
- [compaction-gen2-duration](#compaction-gen2-duration)
981978
- [compaction-multipliers](#compaction-multipliers)
979+
- [compaction-cleanup-wait](#compaction-cleanup-wait)
982980
- [gen1-duration](#gen1-duration)
983981

984982
#### compactor-id
985983

986-
Specifies the prefix in the object store where all compacted data is written.
987-
Provide this option only if this server should handle compaction for its own
988-
write buffer and any replicas it manages.
989-
990-
| influxdb3 serve option | Environment variable |
991-
| :--------------------- | :---------------------------------- |
992-
| `--compactor-id` | `INFLUXDB3_ENTERPRISE_COMPACTOR_ID` |
984+
> [!Important]
985+
> This option has been superseded by using `--mode compact`. See the [mode](#mode) section for details.
993986
994987
---
995988

996989
#### compact-from-node-ids
997990

998-
Defines a comma-separated list of writer identifier prefixes from which data is
999-
compacted.
1000-
1001-
| influxdb3 serve option | Environment variable |
1002-
| :-------------------------- | :--------------------------------------------- |
1003-
| `--compact-from-node-ids` | `INFLUXDB3_ENTERPRISE_COMPACT_FROM_WRITER_IDS` |
991+
> [!Important]
992+
> This option has been superseded by using `--mode compact`. See the [mode](#mode) section for details.
1004993
1005994
---
1006995

1007996
#### run-compactions
1008997

1009-
Indicates that the server should run compactions. Only a single server should
1010-
run compactions for a given `compactor-id`. This option is only applicable if a
1011-
`compactor-id` is set.
1012-
1013-
| influxdb3 serve option | Environment variable |
1014-
| :--------------------- | :------------------------------------- |
1015-
| `--run-compactions` | `INFLUXDB3_ENTERPRISE_RUN_COMPACTIONS` |
998+
> [!Important]
999+
> This option has been superseded by using `--mode compact`. See the [mode](#mode) section for details.
10161000
10171001
---
10181002

@@ -1070,6 +1054,19 @@ compaction levels. The first element specifies the duration of the first level
10701054

10711055
---
10721056

1057+
#### compaction-cleanup-wait
1058+
1059+
Specifies the amount of time that the compactor waits after finishing a compaction run
1060+
to delete files marked as needing deletion during that compaction run.
1061+
1062+
**Default:** `10m`
1063+
1064+
| influxdb3 serve option | Environment variable |
1065+
| :-------------------------- | :--------------------------------------------- |
1066+
| `--compaction-cleanup-wait` | `INFLUXDB3_ENTERPRISE_COMPACTION_CLEANUP_WAIT` |
1067+
1068+
---
1069+
10731070
#### gen1-duration
10741071

10751072
Specifies the duration that Parquet files are arranged into. Data timestamps
@@ -1088,7 +1085,7 @@ compactor can merge into larger generations.
10881085
### Caching
10891086

10901087
- [preemptive-cache-age](#preemptive-cache-age)
1091-
- [parquet-mem-cache-size-mb](#parquet-mem-cache-size-mb)
1088+
- [parquet-mem-cache-size](#parquet-mem-cache-size)
10921089
- [parquet-mem-cache-prune-percentage](#parquet-mem-cache-prune-percentage)
10931090
- [parquet-mem-cache-prune-interval](#parquet-mem-cache-prune-interval)
10941091
- [disable-parquet-mem-cache](#disable-parquet-mem-cache)
@@ -1108,17 +1105,16 @@ Specifies the interval to prefetch into the Parquet cache during compaction.
11081105

11091106
---
11101107

1111-
#### parquet-mem-cache-size-mb
1108+
#### parquet-mem-cache-size
1109+
<span id="parquet-mem-cache-size-mb" />
11121110

1113-
Defines the size of the in-memory Parquet cache in megabytes (MB).
1111+
Specifies the size of the in-memory Parquet cache in megabytes or percentage of total available memory.
11141112

1115-
**Default:** `1000`
1113+
**Default:** `20%`
11161114

1117-
| influxdb3 serve option | Environment variable |
1118-
| :---------------------------- | :------------------------------------ |
1119-
| `--parquet-mem-cache-size-mb` | `INFLUXDB3_PARQUET_MEM_CACHE_SIZE_MB` |
1120-
1121-
---
1115+
| influxdb3 serve option | Environment variable |
1116+
| :-------------------------- | :---------------------------------- |
1117+
| `--parquet-mem-cache-size` | `INFLUXDB3_PARQUET_MEM_CACHE_SIZE` |
11221118

11231119
#### parquet-mem-cache-prune-percentage
11241120

@@ -1225,7 +1221,12 @@ engine uses.
12251221

12261222
Specifies the Python package manager that the processing engine uses.
12271223

1228-
**Default:** `10s`
1224+
This option supports the following values:
1225+
- `discover` _(default)_: Automatically discover available package manager
1226+
- `pip`: Use pip package manager
1227+
- `uv`: Use uv package manager
1228+
1229+
**Default:** `discover`
12291230

12301231
| influxdb3 serve option | Environment variable |
12311232
| :--------------------- | :------------------- |

0 commit comments

Comments
 (0)