Skip to content

Commit 27181fd

Browse files
peterbarnett03peterbarnett03
committed
fix: update enterprise config options
1 parent 3b0f77c commit 27181fd

File tree

1 file changed

+107
-70
lines changed

1 file changed

+107
-70
lines changed

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

Lines changed: 107 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -19,20 +19,18 @@ Pass configuration options to the `influxdb serve` server using either command
1919
options or environment variables. Command options take precedence over
2020
environment variables.
2121

22-
##### Example influxdb3 serve command options
22+
##### Example `influxdb3 serve` command options
2323

2424
<!--pytest.mark.skip-->
2525

2626
```sh
2727
influxdb3 serve \
28+
--node-id node0 \
29+
--cluster-id cluster0 \
2830
--license-email example@email.com \
2931
--object-store file \
3032
--data-dir ~/.influxdb3 \
31-
--node-id NODE_ID \
32-
--cluster-id my-cluster-01 \
3333
--log-filter info \
34-
--max-http-request-size 20971520 \
35-
--aws-allow-http
3634
```
3735

3836
##### Example environment variables
@@ -43,10 +41,7 @@ influxdb3 serve \
4341
export INFLUXDB3_ENTERPRISE_LICENSE_EMAIL=example@email.com
4442
export INFLUXDB3_OBJECT_STORE=file
4543
export INFLUXDB3_DB_DIR=~/.influxdb3
46-
export INFLUXDB3_WRITER_IDENTIFIER_PREFIX=my-host
4744
export LOG_FILTER=info
48-
export INFLUXDB3_MAX_HTTP_REQUEST_SIZE=20971520
49-
export AWS_ALLOW_HTTP=true
5045

5146
influxdb3 serve
5247
```
@@ -60,8 +55,13 @@ influxdb3 serve
6055
- [license-file](#license-file)
6156
- [mode](#mode)
6257
- [node-id](#node-id)
58+
- [node-id-from-env](#node-id-from-env)
6359
- [object-store](#object-store)
64-
- [query-file-limit](#query-file-limit)
60+
- [tls-key](#tls-key)
61+
- [tls-cert](#tls-cert)
62+
- [tls-minimum-versions](#tls-minimum-version)
63+
- [without-auth](#without-auth)
64+
- [disable-authz](#disable-authz)
6565
- [AWS](#aws)
6666
- [aws-access-key-id](#aws-access-key-id)
6767
- [aws-secret-access-key](#aws-secret-access-key)
@@ -121,9 +121,6 @@ influxdb3 serve
121121
- [wal-snapshot-size](#wal-snapshot-size)
122122
- [wal-max-write-buffer-size](#wal-max-write-buffer-size)
123123
- [snapshotted-wal-files-to-keep](#snapshotted-wal-files-to-keep)
124-
- [Replication](#replication)
125-
- [read-from-node-ids](#read-from-node-ids)
126-
- [replication-interval](#replication-interval)
127124
- [Compaction](#compaction)
128125
- [compaction-row-limit](#compaction-row-limit)
129126
- [compaction-max-num-files-per-plan](#compaction-max-num-files-per-plan)
@@ -135,11 +132,14 @@ influxdb3 serve
135132
- [parquet-mem-cache-size](#parquet-mem-cache-size)
136133
- [parquet-mem-cache-prune-percentage](#parquet-mem-cache-prune-percentage)
137134
- [parquet-mem-cache-prune-interval](#parquet-mem-cache-prune-interval)
138-
- [disable-parquet-mem-cache](#disable-parquet-mem-cache)
139135
- [parquet-mem-cache-query-path-duration](#parquet-mem-cache-query-path-duration)
136+
- [disable-parquet-mem-cache](#disable-parquet-mem-cache)
140137
- [last-cache-eviction-interval](#last-cache-eviction-interval)
138+
- [last-value-cache-disable-from-history](#last-value-cache-disable-from-history)
141139
- [distinct-cache-eviction-interval](#distinct-cache-eviction-interval)
142-
- [Processing engine](#processing-engine)
140+
- [distinct-value-cache-disable-from-history](#distinct-value-cache-disable-from-history)
141+
- [query-file-limit](#query-file-limit)
142+
- [Processing Engine](#processing-engine)
143143
- [plugin-dir](#plugin-dir)
144144
- [virtual-env-location](#virtual-env-location)
145145
- [package-manager](#package-manager)
@@ -164,7 +164,7 @@ This value must be different than the [`--node-id`](#node-id) value.
164164

165165
| influxdb3 serve option | Environment variable |
166166
| :--------------------- | :--------------------------------- |
167-
| `--cluster-id` | `INFLUXDB3_ENTERPRISE_my-cluster-01` |
167+
| `--cluster-id` | `INFLUXDB3_ENTERPRISE_CLUSTER_ID` |
168168

169169
---
170170

@@ -235,6 +235,17 @@ configuration--for example, the same bucket.
235235
| :--------------------- | :--------------------------------- |
236236
| `--node-id` | `INFLUXDB3_NODE_IDENTIFIER_PREFIX` |
237237

238+
239+
#### node-id-from-env
240+
241+
Specifies the node identifier used as a prefix in all object store file paths.
242+
Defines this node identified from the specificed environment variable;
243+
this cannot be used with the `--node-id` option also specified.
244+
245+
| influxdb3 serve option | Environment variable |
246+
| :--------------------- | :----------------------------------- |
247+
| `--node-id-from-env` | `INFLUXDB3_NODE_IDENTIFIER_FROM_ENV` |
248+
238249
---
239250

240251
#### object-store
@@ -255,26 +266,49 @@ This option supports the following values:
255266

256267
---
257268

258-
#### query-file-limit
269+
#### tls-key
259270

260-
Limits the number of Parquet files a query can access.
261-
If a query attempts to read more than this limit, InfluxDB returns an error.
271+
The path to a key file for TLS to be enabled.
262272

263-
**Default:** `432`
273+
| influxdb3 serve option | Environment variable |
274+
| :--------------------- | :--------------------- |
275+
| `--tls-key` | `INFLUXDB3_TLS_KEY` |
264276

265-
You can increase this limit to allow more files to be queried, but be aware of
266-
the following side-effects:
277+
---
267278

268-
- Degraded query performance for queries that read more Parquet files
269-
- Increased memory usage
270-
- Your system potentially killing the `influxdb3` process due to Out-of-Memory
271-
(OOM) errors
272-
- If using object storage to store data, many GET requests to access the data
273-
(as many as 2 requests per file)
279+
#### tls-cert
280+
281+
To a cert file for TLS to be enabled.
282+
283+
| influxdb3 serve option | Environment variable |
284+
| :--------------------- | :--------------------- |
285+
| `--tls-cert` | `INFLUXDB3_TLS_CERT` |
286+
287+
---
288+
289+
#### tls-minimum-version
290+
291+
The minimum version for TLS.
292+
Valid values are `tls-1.2` or `tls-1.3` default is tls-1.2
293+
294+
| influxdb3 serve option | Environment variable |
295+
| :---------------------- | :----------------------- |
296+
| `--tls-minimum-version` | `INFLUXDB3_TLS_MINIMUM_VERSION` |
297+
298+
---
299+
300+
#### without-auth
301+
302+
Starts the database with authentication disabled. All requests will be served without any
303+
token or authentication required.
304+
305+
---
306+
307+
#### disable-authz
308+
309+
Optionally disable authz by passing in a comma separated list of resources.
310+
Valid values are `health`, `ping`, and `metrics`.
274311

275-
| influxdb3 serve option | Environment variable |
276-
| :--------------------- | :--------------------------- |
277-
| `--query-file-limit` | `INFLUXDB3_QUERY_FILE_LIMIT` |
278312

279313
---
280314

@@ -935,35 +969,6 @@ they are deleted when the number of snapshotted WAL files exceeds this number.
935969

936970
---
937971

938-
### Replication
939-
940-
- [read-from-node-ids](#read-from-node-ids)
941-
- [replication-interval](#replication-interval)
942-
943-
#### read-from-node-ids
944-
945-
Specifies a comma-separated list of writer identifier prefixes (`node-id`s) to
946-
read WAL files from. [env: =]
947-
948-
| influxdb3 serve option | Environment variable |
949-
| :--------------------- | :------------------------------ |
950-
| `--read-from-node-ids` | `INFLUXDB3_ENTERPRISE_READ_FROM_WRITER_IDS` |
951-
952-
---
953-
954-
#### replication-interval
955-
956-
Defines the interval at which each replica specified in the
957-
`read-from-node-ids` option is replicated.
958-
959-
**Default:** `250ms`
960-
961-
| influxdb3 serve option | Environment variable |
962-
| :----------------------- | :------------------------------------------ |
963-
| `--replication-interval` | `INFLUXDB3_ENTERPRISE_REPLICATION_INTERVAL` |
964-
965-
---
966-
967972
### Compaction
968973

969974
- [compaction-row-limit](#compaction-row-limit)
@@ -1114,26 +1119,26 @@ Sets the interval to check if the in-memory Parquet cache needs to be pruned.
11141119

11151120
---
11161121

1117-
#### disable-parquet-mem-cache
1122+
#### parquet-mem-cache-query-path-duration
11181123

1119-
Disables the in-memory Parquet cache. By default, the cache is enabled.
1124+
Specifies the duration to check if Parquet files pulled in query path
1125+
require caching, expressed as a human-readable duration (starting from _now_)--for example: `5h`, `3d`.
1126+
1127+
**Default:** `5h`
11201128

11211129
| influxdb3 serve option | Environment variable |
11221130
| :---------------------------- | :------------------------------------ |
1123-
| `--disable-parquet-mem-cache` | `INFLUXDB3_DISABLE_PARQUET_MEM_CACHE` |
1131+
| `--parquet-mem-cache-query-path-duration` | `INFLUXDB3_PARQUET_MEM_CACHE_QUERY_PATH_DURATION` |
11241132

11251133
---
11261134

1127-
#### parquet-mem-cache-query-path-duration
1128-
1129-
Specifies the duration to check if Parquet files pulled in query path
1130-
require caching, expressed as a human-readable duration (starting from _now_)--for example: `5h`, `3d`.
1135+
#### disable-parquet-mem-cache
11311136

1132-
**Default:** `5h`
1137+
Disables the in-memory Parquet cache. By default, the cache is enabled.
11331138

11341139
| influxdb3 serve option | Environment variable |
11351140
| :---------------------------- | :------------------------------------ |
1136-
| `--parquet-mem-cache-query-path-duration` | `INFLUXDB3_PARQUET_MEM_CACHE_QUERY_PATH_DURATION` |
1141+
| `--disable-parquet-mem-cache` | `INFLUXDB3_DISABLE_PARQUET_MEM_CACHE` |
11371142

11381143
---
11391144

@@ -1150,6 +1155,17 @@ expressed as a human-readable duration--for example: `20s`, `1m`, `1h`.
11501155

11511156
---
11521157

1158+
#### last-value-cache-disable-from-history
1159+
1160+
Disable populating the Last-N-Value cache from historical data.
1161+
When disabled, the cache will still be populated with data from the WAL.
1162+
1163+
| influxdb3 serve option | Environment variable |
1164+
| :---------------------------------------- | :------------------------------------------------ |
1165+
| `--last-value-cache-disable-from-history` | `INFLUXDB3_LAST_VALUE_CACHE_DISABLE_FROM_HISTORY` |
1166+
1167+
---
1168+
11531169
#### distinct-cache-eviction-interval
11541170

11551171
Specifies the interval to evict expired entries from the distinct value cache,
@@ -1163,7 +1179,28 @@ expressed as a human-readable duration--for example: `20s`, `1m`, `1h`.
11631179

11641180
---
11651181

1166-
### Processing engine
1182+
#### distinct-value-cache-disable-from-history
1183+
1184+
Disable populating the Distinct Value cache from historical data.
1185+
When disabled, the cache will still be populated with data from the WAL.
1186+
1187+
| influxdb3 serve option | Environment variable |
1188+
| :-------------------------------------------- | :---------------------------------------------------- |
1189+
| `--distinct-value-cache-disable-from-history` | `INFLUXDB3_DISTINCT_VALUE_CACHE_DISABLE_FROM_HISTORY` |
1190+
---
1191+
1192+
#### query-file-limit
1193+
1194+
Limits the number of Parquet files a query can access.
1195+
If a query attempts to read more than this limit, InfluxDB returns an error.
1196+
1197+
| influxdb3 serve option | Environment variable |
1198+
| :--------------------- | :--------------------------- |
1199+
| `--query-file-limit` | `INFLUXDB3_QUERY_FILE_LIMIT` |
1200+
1201+
---
1202+
1203+
### Processing Engine
11671204

11681205
- [plugin-dir](#plugin-dir)
11691206
- [virtual-env-location](#virtual-env-location)
@@ -1186,7 +1223,7 @@ engine uses.
11861223

11871224
| influxdb3 serve option | Environment variable |
11881225
| :----------------------- | :--------------------- |
1189-
| `--virtual-env-location` | `VIRTUAL_ENV_LOCATION` |
1226+
| `--virtual-env-location` | `VIRTUAL_ENV` |
11901227

11911228
---
11921229

0 commit comments

Comments
 (0)