Skip to content

Commit 821dcd4

Browse files
committed
Merge branch 'master' into monolith-gs-restructure
2 parents 231944e + 27a276a commit 821dcd4

File tree

5 files changed

+3776
-72
lines changed

5 files changed

+3776
-72
lines changed

content/influxdb3/clustered/reference/release-notes/clustered.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,52 @@ directory. This new directory contains artifacts associated with the specified r
6161

6262
---
6363

64+
## 20250613-1754010 {date="2025-06-11"}
65+
66+
### Quickstart
67+
68+
```yaml
69+
spec:
70+
package:
71+
image: us-docker.pkg.dev/influxdb2-artifacts/clustered/influxdb:20250613-1754010
72+
```
73+
74+
#### Release artifacts
75+
76+
- [app-instance-schema.json](/downloads/clustered-release-artifacts/20250613-1754010/app-instance-schema.json)
77+
- [example-customer.yml](/downloads/clustered-release-artifacts/20250613-1754010/example-customer.yml)
78+
- [InfluxDB Clustered README EULA July 2024.txt](/downloads/clustered-release-artifacts/InfluxDB%20Clustered%20README%20EULA%20July%202024.txt)
79+
80+
### Bug Fixes
81+
82+
- Remove default CPU and memory limits for the Catalog service and Prometheus.
83+
- Add time formatting checks to reject invalid custom partitioning requests.
84+
- Ensure that an incorrect backup is not created when `pg_dump` errs during data snapshot backups.
85+
86+
### Changes
87+
88+
#### Deployment
89+
90+
- Add support for Prometheus v3 when using the observability feature.
91+
- Refresh dependencies to address security vulnerabilities and improve stability.
92+
93+
#### Configuration
94+
95+
- Change the default of `INFLUXDB_IOX_CREATE_CATALOG_BACKUP_INTERVAL` from `1h`
96+
to `4h`.
97+
- Introduce the following environment variables to help in cases where the
98+
object store is large enough that the the garbage collector cannot keep up
99+
when cleaning obsolete objects:
100+
101+
- `INFLUXDB_IOX_GC_PRIMARY_OBJECTSTORE_PARTITIONS`
102+
- `INFLUXDB_IOX_GC_SECONDARY_OBJECTSTORE_PARTITIONS`
103+
104+
> [!Note]
105+
> Increasing these settings will add load to the object store and should not
106+
> be modified unnecessarily.
107+
108+
---
109+
64110
## 20250508-1719206 {date="2025-05-08"}
65111

66112
### Quickstart

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

Lines changed: 126 additions & 71 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 \
33-
--log-filter info \
34-
--max-http-request-size 20971520 \
35-
--aws-allow-http
33+
--log-filter info
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,25 @@ 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+
Takes the name of an environment variable as an argument and uses the value of that environment variable as the node identifier.
243+
This option cannot be used with the `--node-id` option.
244+
245+
| influxdb3 serve option | Environment variable |
246+
| :--------------------- | :----------------------------------- |
247+
| `--node-id-from-env` | `INFLUXDB3_NODE_IDENTIFIER_FROM_ENV` |
248+
249+
##### Example using --node-id-from-env
250+
251+
```bash
252+
export DATABASE_NODE=node0 && influxdb3 serve \
253+
--node-id-from-env DATABASE_NODE \
254+
--cluster-id cluster0 \
255+
--object-store file \
256+
--data-dir ~/.influxdb3/data
238257
---
239258

240259
#### object-store
@@ -255,26 +274,50 @@ This option supports the following values:
255274

256275
---
257276

258-
#### query-file-limit
277+
#### tls-key
259278

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.
279+
The path to a key file for TLS to be enabled.
262280

263-
**Default:** `432`
281+
| influxdb3 serve option | Environment variable |
282+
| :--------------------- | :--------------------- |
283+
| `--tls-key` | `INFLUXDB3_TLS_KEY` |
264284

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

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)
287+
#### tls-cert
288+
289+
The path to a cert file for TLS to be enabled.
290+
291+
| influxdb3 serve option | Environment variable |
292+
| :--------------------- | :--------------------- |
293+
| `--tls-cert` | `INFLUXDB3_TLS_CERT` |
294+
295+
---
296+
297+
#### tls-minimum-version
298+
299+
The minimum version for TLS.
300+
Valid values are `tls-1.2` or `tls-1.3`.
301+
Default is `tls-1.2`.
302+
303+
| influxdb3 serve option | Environment variable |
304+
| :---------------------- | :----------------------- |
305+
| `--tls-minimum-version` | `INFLUXDB3_TLS_MINIMUM_VERSION` |
306+
307+
---
308+
309+
#### without-auth
310+
311+
Disables authentication for all server actions (CLI commands and API requests).
312+
The server processes all requests without requiring tokens or authentication.
313+
314+
---
315+
316+
#### disable-authz
317+
318+
Optionally disable authz by passing in a comma separated list of resources.
319+
Valid values are `health`, `ping`, and `metrics`.
274320

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

279322
---
280323

@@ -935,35 +978,6 @@ they are deleted when the number of snapshotted WAL files exceeds this number.
935978
936979
---
937980
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-
967981
### Compaction
968982
969983
- [compaction-row-limit](#compaction-row-limit)
@@ -1114,26 +1128,35 @@ Sets the interval to check if the in-memory Parquet cache needs to be pruned.
11141128
11151129
---
11161130
1117-
#### disable-parquet-mem-cache
1131+
#### parquet-mem-cache-query-path-duration
11181132
1119-
Disables the in-memory Parquet cache. By default, the cache is enabled.
1133+
A [duration](/influxdb3/enterprise/reference/glossary/#duration) that specifies
1134+
the time window for caching recent Parquet files in memory. Default is `5h`.
1135+
1136+
Only files containing data with a timestamp between `now` and `now - duration`
1137+
are cached when accessed during queries--for example, with the default `5h` setting:
1138+
1139+
- Current time: `2024-06-10 15:00:00`
1140+
- Cache window: Last 5 hours (`2024-06-10 10:00:00` to now)
1141+
1142+
If a query requests data from `2024-06-09` (old) and `2024-06-10 14:00` (recent):
1143+
1144+
- **Cached**: Parquet files with data from `2024-06-10 14:00` (within 5-hour window)
1145+
- **Not cached**: Parquet files with data from `2024-06-09` (outside 5-hour window)
11201146
11211147
| influxdb3 serve option | Environment variable |
11221148
| :---------------------------- | :------------------------------------ |
1123-
| `--disable-parquet-mem-cache` | `INFLUXDB3_DISABLE_PARQUET_MEM_CACHE` |
1149+
| `--parquet-mem-cache-query-path-duration` | `INFLUXDB3_PARQUET_MEM_CACHE_QUERY_PATH_DURATION` |
11241150
11251151
---
11261152
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`.
1153+
#### disable-parquet-mem-cache
11311154
1132-
**Default:** `5h`
1155+
Disables the in-memory Parquet cache. By default, the cache is enabled.
11331156
11341157
| influxdb3 serve option | Environment variable |
11351158
| :---------------------------- | :------------------------------------ |
1136-
| `--parquet-mem-cache-query-path-duration` | `INFLUXDB3_PARQUET_MEM_CACHE_QUERY_PATH_DURATION` |
1159+
| `--disable-parquet-mem-cache` | `INFLUXDB3_DISABLE_PARQUET_MEM_CACHE` |
11371160
11381161
---
11391162
@@ -1150,6 +1173,17 @@ expressed as a human-readable duration--for example: `20s`, `1m`, `1h`.
11501173
11511174
---
11521175
1176+
#### last-value-cache-disable-from-history
1177+
1178+
Disables populating the last-N-value cache from historical data.
1179+
If disabled, the cache is still populated with data from the write-ahead log (WAL).
1180+
1181+
| influxdb3 serve option | Environment variable |
1182+
| :---------------------------------------- | :------------------------------------------------ |
1183+
| `--last-value-cache-disable-from-history` | `INFLUXDB3_LAST_VALUE_CACHE_DISABLE_FROM_HISTORY` |
1184+
1185+
---
1186+
11531187
#### distinct-cache-eviction-interval
11541188
11551189
Specifies the interval to evict expired entries from the distinct value cache,
@@ -1163,7 +1197,28 @@ expressed as a human-readable duration--for example: `20s`, `1m`, `1h`.
11631197
11641198
---
11651199
1166-
### Processing engine
1200+
#### distinct-value-cache-disable-from-history
1201+
1202+
Disables populating the distinct value cache from historical data.
1203+
If disabled, the cache is still populated with data from the write-ahead log (WAL).
1204+
1205+
| influxdb3 serve option | Environment variable |
1206+
| :-------------------------------------------- | :---------------------------------------------------- |
1207+
| `--distinct-value-cache-disable-from-history` | `INFLUXDB3_DISTINCT_VALUE_CACHE_DISABLE_FROM_HISTORY` |
1208+
---
1209+
1210+
#### query-file-limit
1211+
1212+
Limits the number of Parquet files a query can access.
1213+
If a query attempts to read more than this limit, {{% product-name %}} returns an error.
1214+
1215+
| influxdb3 serve option | Environment variable |
1216+
| :--------------------- | :--------------------------- |
1217+
| `--query-file-limit` | `INFLUXDB3_QUERY_FILE_LIMIT` |
1218+
1219+
---
1220+
1221+
### Processing Engine
11671222
11681223
- [plugin-dir](#plugin-dir)
11691224
- [virtual-env-location](#virtual-env-location)
@@ -1186,7 +1241,7 @@ engine uses.
11861241
11871242
| influxdb3 serve option | Environment variable |
11881243
| :----------------------- | :--------------------- |
1189-
| `--virtual-env-location` | `VIRTUAL_ENV_LOCATION` |
1244+
| `--virtual-env-location` | `VIRTUAL_ENV` |
11901245
11911246
---
11921247

layouts/partials/article/feedback.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,9 @@ <h4 id="bug-reports-and-feedback">Support and feedback</h4>
6262
<li><a class="reddit" href="https://reddit.com/r/influxdb" target="_blank">InfluxDB Subreddit</a></li>
6363
</ul>
6464
{{ if not (in $supportBlacklist $product) }}
65-
<p><strong>Customers with an annual or support contract</strong> can <a href="https://support.influxdata.com/">contact InfluxData Support</a>.</p>
65+
<p><strong>Customers with an annual or support contract</strong> can <a href="https://support.influxdata.com/">contact InfluxData Support</a>.
66+
<strong>Customers using a trial license</strong> can email trial@influxdata.com for assistance.</p>
67+
6668
{{ end }}
6769
</div>
6870
<div class="actions">

0 commit comments

Comments
 (0)