Skip to content

Commit c588a13

Browse files
committed
chore(influxdb3-cli): Describe required params, mode can be a list, troubleshooting
1 parent 480ae67 commit c588a13

File tree

3 files changed

+57
-9
lines changed

3 files changed

+57
-9
lines changed

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

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ The `influxdb3 serve` command starts the {{< product-name >}} server.
2020
```bash
2121
influxdb3 serve [OPTIONS] --node-id <HOST_IDENTIFIER_PREFIX>
2222
```
23+
`--node-id` is a unique string that identifies your InfluxDB server instance
2324

2425
## Options
2526

@@ -101,7 +102,13 @@ influxdb3 serve [OPTIONS] --node-id <HOST_IDENTIFIER_PREFIX>
101102

102103
You can use environment variables to define most `influxdb3 serve` options.
103104
For more information, see
104-
[Configuration options](/influxdb3/core/reference/config-options/).
105+
[Configuration options](/influxdb3/enterprise/reference/config-options/).
106+
107+
## Key Requirements
108+
109+
- **node-id**: Must be unique for any hosts sharing the same object store configuration
110+
- **object-store**: Determines where time series data is stored
111+
- **data-dir**: Specifies the path for local file storage, required with `--object-store file`
105112

106113
## Examples
107114

@@ -150,3 +157,14 @@ LOG_FILTER=debug influxdb3 serve \
150157
```
151158

152159
{{% /code-placeholders %}}
160+
161+
162+
## Troubleshooting
163+
164+
### Common Issues
165+
166+
- **Error: "Failed to connect to object store"**
167+
Verify your `--object-store` setting and ensure all required parameters for that storage type are provided.
168+
169+
- **Permission errors when using S3, Google Cloud, or Azure storage**
170+
Check that your authentication credentials are correct and have sufficient permissions.

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

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ menu:
77
parent: influxdb3
88
name: influxdb3 serve
99
weight: 300
10+
related:
11+
- /influxdb3/enterprise/reference/config-options/
1012
---
1113

1214
The `influxdb3 serve` command starts the {{< product-name >}} server.
@@ -21,6 +23,14 @@ influxdb3 serve [OPTIONS] \
2123
--cluster-id <CLUSTER_IDENTIFIER_PREFIX>
2224
```
2325

26+
Required parameters:
27+
28+
- `--node-id`: a unique string that identifies your InfluxDB server instance
29+
- `--cluster-id`: a unique string that identifies your InfluxDB cluster
30+
- The `--cluster-id` value must be different from any `--node-id` values in your cluster
31+
- Example format: `--node-id influx-server-1 --cluster-id sensors-cluster`
32+
- Both identifiers should be alphanumeric strings with optional hyphens
33+
2434
## Options
2535

2636
| Option | | Description |
@@ -113,6 +123,13 @@ You can use environment variables to define most `influxdb3 serve` options.
113123
For more information, see
114124
[Configuration options](/influxdb3/enterprise/reference/config-options/).
115125

126+
## Key Requirements
127+
128+
- **node-id**: Must be unique for any hosts sharing the same object store configuration
129+
- **cluster-id**: Must be unique and different from any node-id in your cluster
130+
- **object-store**: Determines where time series data is stored
131+
- **data-dir**: Specifies the path for local file storage, required with `--object-store file`
132+
116133
## Examples
117134

118135
- [Run the InfluxDB 3 server](#run-the-influxdb-3-server)
@@ -193,3 +210,17 @@ LOG_FILTER=debug influxdb3 serve \
193210
```
194211

195212
{{% /code-placeholders %}}
213+
214+
215+
## Troubleshooting
216+
217+
### Common Issues
218+
219+
- **Error: "cluster-id cannot match any node-id in the cluster"**
220+
Ensure your `--cluster-id` value is different from all `--node-id` values in your cluster.
221+
222+
- **Error: "Failed to connect to object store"**
223+
Verify your `--object-store` setting and ensure all required parameters for that storage type are provided.
224+
225+
- **Permission errors when using S3, Google Cloud, or Azure storage**
226+
Check that your authentication credentials are correct and have sufficient permissions.

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

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -213,11 +213,13 @@ Sets the mode to start the server in.
213213

214214
This option supports the following values:
215215

216-
- `all` _(default)_
217-
- `ingest`
218-
- `query`
219-
- `compact`
220-
- `process`
216+
- `all` _(default)_: Enables all server modes
217+
- `ingest`: Enables only data ingest capabilities
218+
- `query`: Enables only query capabilities
219+
- `compact`: Enables only compaction processes
220+
- `process`: Enables only data processing capabilities
221+
222+
You can specify multiple modes using a comma-delimited list (for example, `ingest,query`).
221223

222224
**Default:** `all`
223225

@@ -980,9 +982,6 @@ Defines the interval at which each replica specified in the
980982
- [compaction-cleanup-wait](#compaction-cleanup-wait)
981983
- [gen1-duration](#gen1-duration)
982984

983-
984-
985-
986985
#### compaction-row-limit
987986

988987
Specifies the soft limit for the number of rows per file that the compactor

0 commit comments

Comments
 (0)