Skip to content

Commit ba1e7f8

Browse files
authored
Merge pull request #6168 from influxdata/jts-6166-object-store-required
6166 object store required
2 parents 29da031 + cf8fab9 commit ba1e7f8

File tree

5 files changed

+12
-9
lines changed

5 files changed

+12
-9
lines changed

content/influxdb3/core/reference/cli/influxdb3/serve.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ influxdb3 serve [OPTIONS] --node-id <HOST_IDENTIFIER_PREFIX>
2424
## Required parameters
2525

2626
- **node-id**: A unique identifier for your server instance. Must be unique for any hosts sharing the same object store.
27-
- **object-store**: Determines where time series data is stored. _Default is `memory`_.
28-
- **data-dir**: Path for local file storage (required when using `--object-store file`).
27+
- **object-store**: Determines where time series data is stored.
28+
- Other object store parameters depending on the selected `object-store` type.
2929

3030
> [!NOTE]
3131
> `--node-id` supports alphanumeric strings with optional hyphens.

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ influxdb3 serve
144144
Specifies which object storage to use to store Parquet files.
145145
This option supports the following values:
146146

147-
- `memory` _(default)_
147+
- `memory`
148148
- `memory-throttled`
149149
- `file`
150150
- `s3`
@@ -171,7 +171,7 @@ Required when using the `file` [object store](#object-store).
171171
#### node-id
172172

173173
Specifies the node identifier used as a prefix in all object store file paths.
174-
This should be unique for any hosts sharing the same object store
174+
Use a unique node identifier for each host sharing the same object store
175175
configuration--for example, the same bucket.
176176

177177
| influxdb3 serve option | Environment variable |
@@ -186,7 +186,7 @@ Limits the number of Parquet files a query can access.
186186

187187
**Default:** `432`
188188

189-
With the default `432` setting and the default [`gen1-duration`](#`gen1-duration`)
189+
With the default `432` setting and the default [`gen1-duration`](#gen1-duration)
190190
setting of 10 minutes, queries can access up to a 72 hours of data, but
191191
potentially less depending on whether all data for a given 10 minute block of
192192
time was ingested during the same period.

content/influxdb3/enterprise/reference/cli/influxdb3/serve.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ influxdb3 serve [OPTIONS] \
2727

2828
- **node-id**: A unique identifier for your server instance. Must be unique for any hosts sharing the same object store.
2929
- **cluster-id**: A unique identifier for your cluster. Must be different from any node-id in your cluster.
30-
- **object-store**: Determines where time series data is stored. _Default is `memory`_.
31-
- **data-dir**: Path for local file storage (required when using `--object-store file`).
30+
- **object-store**: Determines where time series data is stored.
31+
- Other object store parameters depending on the selected `object-store` type.
3232

3333
> [!NOTE]
3434
> `--node-id` and `--cluster-id` support alphanumeric strings with optional hyphens.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,7 @@ export DATABASE_NODE=node0 && influxdb3 serve \
263263
Specifies which object storage to use to store Parquet files.
264264
This option supports the following values:
265265

266-
- `memory` _(default)_: Effectively no object persistence
266+
- `memory`: Effectively no object persistence
267267
- `memory-throttled`: Like `memory` but with latency and throughput that somewhat resembles a cloud object store
268268
- `file`: Stores objects in the local filesystem (must also set `--data-dir`)
269269
- `s3`: Amazon S3 (must also set `--bucket`, `--aws-access-key-id`, `--aws-secret-access-key`, and possibly `--aws-default-region`)

content/shared/influxdb3-get-started/setup.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,14 +44,17 @@ Provide the following:
4444
- `--object-store`: Specifies the type of object store to use.
4545
InfluxDB supports the following:
4646

47-
- `file` _(default)_: local file system
47+
- `file`: local file system
4848
- `memory`: in memory _(no object persistence)_
4949
- `memory-throttled`: like `memory` but with latency and throughput that
5050
somewhat resembles a cloud-based object store
5151
- `s3`: AWS S3 and S3-compatible services like Ceph or Minio
5252
- `google`: Google Cloud Storage
5353
- `azure`: Azure Blob Storage
5454

55+
- Other object store parameters depending on the selected `object-store` type.
56+
For example, if you use `s3`, you must provide the bucket name and credentials.
57+
5558
> [!Note]
5659
> #### Diskless architecture
5760
>

0 commit comments

Comments
 (0)