Skip to content

Commit 601d60f

Browse files
Apply suggestions from code review
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
1 parent c588a13 commit 601d60f

File tree

2 files changed

+17
-8
lines changed
  • content/influxdb3

2 files changed

+17
-8
lines changed

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

Lines changed: 1 addition & 0 deletions
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+
2324
`--node-id` is a unique string that identifies your InfluxDB server instance
2425

2526
## Options

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

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,17 +19,25 @@ The `influxdb3 serve` command starts the {{< product-name >}} server.
1919

2020
```bash
2121
influxdb3 serve [OPTIONS] \
22-
--node-id <NODE_IDENTIFIER_PREFIX> \
23-
--cluster-id <CLUSTER_IDENTIFIER_PREFIX>
22+
--node-id <NODE_IDENTIFIER_PREFIX> \
23+
--cluster-id <CLUSTER_IDENTIFIER_PREFIX>
2424
```
2525

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

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
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:
32+
33+
<!--pytest.mark.skip-->
34+
35+
```bash
36+
influxdb3 serve --node-id influxdb-server-1 --cluster-id sensors-cluster
37+
```
38+
39+
> [!Note]
40+
> `--node-id` and `--cluster-id` support alphanumeric strings with optional hyphens.
3341
3442
## Options
3543

0 commit comments

Comments
 (0)