Skip to content

Commit 7b8f1a4

Browse files
committed
fix(monolith): Core and Enterprise get-started: influxdb3 serve options
- Add --cluster-id and optional without_auth in startup options. - Explain cluster-id and node-id
1 parent 2a4781a commit 7b8f1a4

File tree

2 files changed

+17
-7
lines changed

2 files changed

+17
-7
lines changed

content/shared/v3-core-get-started/_index.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -132,8 +132,14 @@ and provide the following:
132132
InfluxDB supports the following: local file system (`file`), `memory`,
133133
S3 (and compatible services like Ceph or Minio) (`s3`),
134134
Google Cloud Storage (`google`), and Azure Blob Storage (`azure`).
135-
- `--node-id`: A string identifier that determines the server's storage path
136-
within the configured storage location, and, in a multi-node setup, is used to reference the node.
135+
The default is `file`.
136+
Depending on the object store type, you may need to provide additional options
137+
for your object store configuration.
138+
- `--node-id`: A string identifier that distinguishes individual server instances within the cluster.
139+
This forms the final part of the storage path: `<CONFIGURED_PATH>/<NODE_ID>`.
140+
In a multi-node setup, this ID is used to reference specific nodes.
141+
- _Optional_ `--without-auth`: Disables authentication and authorization (admin token) for the server.
142+
If not specified, authentication is enabled by default.
137143

138144
> [!Note]
139145
> #### Diskless architecture
@@ -176,7 +182,6 @@ To run the [Docker image](/influxdb3/core/install/#docker-image) and persist dat
176182
# Filesystem object store with Docker
177183
# Create a mount
178184
# Provide the mount path
179-
180185
docker run -it \
181186
-v /path/on/host:/path/in/container \
182187
quay.io/influxdb/influxdb3-core:latest serve \

content/shared/v3-enterprise-get-started/_index.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -131,8 +131,15 @@ and provide the following:
131131
InfluxDB supports the following: local file system (`file`), `memory`,
132132
S3 (and compatible services like Ceph or Minio) (`s3`),
133133
Google Cloud Storage (`google`), and Azure Blob Storage (`azure`).
134-
- `--node-id`: A string identifier that determines the server's storage path
135-
within the configured storage location, and, in a multi-node setup, is used to reference the node.
134+
The default is `file`.
135+
Depending on the object store type, you may need to provide additional options
136+
for your object store configuration.
137+
- `--cluster-id`: A string identifier that determines part of the storage path hierarchy. All nodes within the same cluster share this identifier. The storage path follows the pattern `<CONFIGURED_PATH>/<CLUSTER_ID>/<NODE_ID>`. In a multi-node setup, this ID is used to reference the entire cluster.
138+
- `--node-id`: A string identifier that distinguishes individual server instances within the cluster. This forms the final part of the storage path: `<CONFIGURED_PATH>/<CLUSTER_ID>/<NODE_ID>`. In a multi-node setup, this ID is used to reference specific nodes.
139+
- _Optional_ `--without-auth`: Disables authentication and authorization (admin token and database tokens) for the server. If not specified, authentication is enabled by default.
140+
141+
> [!Note]
142+
> The combined path structure `<CONFIGURED_PATH>/<CLUSTER_ID>/<NODE_ID>` ensures proper organization of data in your object store, allowing for clean separation between clusters and individual nodes.
136143
137144
> [!Note]
138145
> #### Diskless architecture
@@ -189,7 +196,6 @@ docker run -it \
189196
```bash
190197
# S3 object store (default is the us-east-1 region)
191198
# Specify the Object store type and associated options
192-
193199
influxdb3 serve \
194200
--node-id host01 \
195201
--cluster-id cluster01 \
@@ -203,7 +209,6 @@ influxdb3 serve \
203209
# Minio or other open source object store
204210
# (using the AWS S3 API with additional parameters)
205211
# Specify the object store type and associated options
206-
207212
influxdb3 serve \
208213
--node-id host01 \
209214
--cluster-id cluster01 \

0 commit comments

Comments
 (0)