Skip to content

Commit 5a5a291

Browse files
committed
fix(influxdb3): serve required arguments
1 parent 601d60f commit 5a5a291

File tree

2 files changed

+14
-26
lines changed
  • content/influxdb3

2 files changed

+14
-26
lines changed

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

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,14 @@ The `influxdb3 serve` command starts the {{< product-name >}} server.
2121
influxdb3 serve [OPTIONS] --node-id <HOST_IDENTIFIER_PREFIX>
2222
```
2323

24-
`--node-id` is a unique string that identifies your InfluxDB server instance
24+
## Required parameters
25+
26+
- **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`).
29+
30+
> [!NOTE]
31+
> `--node-id` supports alphanumeric strings with optional hyphens.
2532
2633
## Options
2734

@@ -105,12 +112,6 @@ You can use environment variables to define most `influxdb3 serve` options.
105112
For more information, see
106113
[Configuration options](/influxdb3/enterprise/reference/config-options/).
107114

108-
## Key Requirements
109-
110-
- **node-id**: Must be unique for any hosts sharing the same object store configuration
111-
- **object-store**: Determines where time series data is stored
112-
- **data-dir**: Specifies the path for local file storage, required with `--object-store file`
113-
114115
## Examples
115116

116117
- [Run the InfluxDB 3 server](#run-the-influxdb-3-server)

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

Lines changed: 6 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -23,20 +23,14 @@ influxdb3 serve [OPTIONS] \
2323
--cluster-id <CLUSTER_IDENTIFIER_PREFIX>
2424
```
2525

26-
#### Required parameters
26+
## Required parameters
2727

28-
- `--node-id`: a unique string that identifies your {{< product-name >}} server instance.
29-
- `--cluster-id`: a unique string that identifies your {{< product-name >}} cluster.
30-
The `--cluster-id` value must be different from any `--node-id` values in your
31-
cluster--for example:
28+
- **node-id**: A unique identifier for your server instance. Must be unique for any hosts sharing the same object store.
29+
- **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`).
3232

33-
<!--pytest.mark.skip-->
34-
35-
```bash
36-
influxdb3 serve --node-id influxdb-server-1 --cluster-id sensors-cluster
37-
```
38-
39-
> [!Note]
33+
> [!NOTE]
4034
> `--node-id` and `--cluster-id` support alphanumeric strings with optional hyphens.
4135
4236
## Options
@@ -131,13 +125,6 @@ You can use environment variables to define most `influxdb3 serve` options.
131125
For more information, see
132126
[Configuration options](/influxdb3/enterprise/reference/config-options/).
133127

134-
## Key Requirements
135-
136-
- **node-id**: Must be unique for any hosts sharing the same object store configuration
137-
- **cluster-id**: Must be unique and different from any node-id in your cluster
138-
- **object-store**: Determines where time series data is stored
139-
- **data-dir**: Specifies the path for local file storage, required with `--object-store file`
140-
141128
## Examples
142129

143130
- [Run the InfluxDB 3 server](#run-the-influxdb-3-server)

0 commit comments

Comments
 (0)