Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

update all instances of writer-id to node-id

pull/5803/head
Scott Anderson 2025-01-24 10:49:09 -07:00
parent 888263a6c7
commit cdbdc0409c
4 changed files with 38 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
content/influxdb3/core/reference/cli/influxdb3/serve.md
View File

@ -18,7 +18,7 @@ The `influxdb3 serve` command starts the {{< product-name >}} server.
<!--pytest.mark.skip-->
```bash
influxdb3 serve [OPTIONS] --writer-id <HOST_IDENTIFIER_PREFIX>
influxdb3 serve [OPTIONS] --node-id <HOST_IDENTIFIER_PREFIX>
```
## Options
@ -81,7 +81,7 @@ influxdb3 serve [OPTIONS] --writer-id <HOST_IDENTIFIER_PREFIX>
| | `--snapshotted-wal-files-to-keep` | _See [configuration options](/influxdb3/core/reference/config-options/#snapshotted-wal-files-to-keep)_ |
| | `--query-log-size` | _See [configuration options](/influxdb3/core/reference/config-options/#query-log-size)_ |
| | `--buffer-mem-limit-mb` | _See [configuration options](/influxdb3/core/reference/config-options/#buffer-mem-limit-mb)_ |
| {{< req "\*" >}} | `--writer-id` | _See [configuration options](/influxdb3/core/reference/config-options/#writer-id)_ |
| {{< req "\*" >}} | `--node-id` | _See [configuration options](/influxdb3/core/reference/config-options/#node-id)_ |
| | `--parquet-mem-cache-size-mb` | _See [configuration options](/influxdb3/core/reference/config-options/#parquet-mem-cache-size-mb)_ |
| | `--parquet-mem-cache-prune-percentage` | _See [configuration options](/influxdb3/core/reference/config-options/#parquet-mem-cache-prune-percentage)_ |
| | `--parquet-mem-cache-prune-interval` | _See [configuration options](/influxdb3/core/reference/config-options/#parquet-mem-cache-prune-interval)_ |
@ -121,7 +121,7 @@ with a unique identifier for your {{< product-name >}} server.
influxdb3 serve \
--object-store file \
--data-dir ~/.influxdb3 \
--writer-id MY_HOST_ID
--node-id MY_HOST_ID
```
### Run the InfluxDB 3 server with extra verbose logging
@ -133,7 +133,7 @@ influxdb3 serve \
--verbose \
--object-store file \
--data-dir ~/.influxdb3 \
--writer-id MY_HOST_ID
--node-id MY_HOST_ID
```
### Run InfluxDB 3 with debug logging using LOG_FILTER
@ -144,7 +144,7 @@ influxdb3 serve \
LOG_FILTER=debug influxdb3 serve \
--object-store file \
--data-dir ~/.influxdb3 \
--writer-id MY_HOST_ID
--node-id MY_HOST_ID
```
{{% /code-placeholders %}}

16
content/influxdb3/core/reference/config-options.md
View File

@ -27,7 +27,7 @@ environment variables.
influxdb3 serve \
--object-store file \
--data-dir ~/.influxdb3 \
--writer-id my-host \
--node-id my-host \
--log-filter info \
--max-http-request-size 20971520 \
--aws-allow-http
@ -53,7 +53,7 @@ influxdb3 serve
- [General](#general)
- [object-store](#object-store)
- [data-dir](#data-dir)
- [writer-id](#writer-id)
- [node-id](#node-id)
- [AWS](#aws)
- [aws-access-key-id](#aws-access-key-id)
- [aws-secret-access-key](#aws-secret-access-key)
@ -136,7 +136,7 @@ influxdb3 serve
- [object-store](#object-store)
- [bucket](#bucket)
- [data-dir](#data-dir)
- [writer-id](#writer-id)
- [node-id](#node-id)
#### object-store
@ -166,15 +166,15 @@ Defines the location {{< product-name >}} uses to store files locally.
---
#### writer-id
#### node-id
Specifies the writer identifier used as a prefix in all object store file paths.
Specifies the node identifier used as a prefix in all object store file paths.
This should be unique for any hosts sharing the same object store
configuration--for example, the same bucket.
| influxdb3 serve option | Environment variable |
| :--------------------- | :----------------------------------- |
| `--writer-id` | `INFLUXDB3_WRITER_IDENTIFIER_PREFIX` |
| influxdb3 serve option | Environment variable |
| :--------------------- | :--------------------------------- |
| `--node-id` | `INFLUXDB3_NODE_IDENTIFIER_PREFIX` |
---

14
content/influxdb3/enterprise/reference/cli/influxdb3/serve.md
View File

@ -16,7 +16,7 @@ The `influxdb3 serve` command starts the {{< product-name >}} server.
<!--pytest.mark.skip-->
```bash
influxdb3 serve [OPTIONS] --writer-id <HOST_IDENTIFIER_PREFIX>
influxdb3 serve [OPTIONS] --node-id <HOST_IDENTIFIER_PREFIX>
```
## Options
@ -78,12 +78,12 @@ influxdb3 serve [OPTIONS] --writer-id <HOST_IDENTIFIER_PREFIX>
| | `--wal-max-write-buffer-size` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#wal-max-write-buffer-size)_ |
| | `--query-log-size` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#query-log-size)_ |
| | `--buffer-mem-limit-mb` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#buffer-mem-limit-mb)_ |
| {{< req "\*" >}} | `--writer-id` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#writer-id)_ |
| {{< req "\*" >}} | `--node-id` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#node-id)_ |
| | `--mode` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#mode)_ |
| | `--read-from-writer-ids` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#read-from-writer-ids)_ |
| | `--read-from-node-ids` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#read-from-node-ids)_ |
| | `--replication-interval` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#replication-interval)_ |
| | `--compactor-id` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#compactor-id)_ |
| | `--compact-from-writer-ids` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#compact-from-writer-ids)_ |
| | `--compact-from-node-ids` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#compact-from-node-ids)_ |
| | `--run-compactions` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#run-compactions)_ |
| | `--compaction-row-limit` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#compaction-row-limit)_ |
| | `--compaction-max-num-files-per-plan` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#compaction-max-num-files-per-plan)_ |
@ -128,7 +128,7 @@ with a unique identifier for your {{< product-name >}} server.
influxdb3 serve \
--object-store file \
--data-dir ~/.influxdb3 \
--writer-id MY_HOST_NAME
--node-id MY_HOST_NAME
```
### Run the InfluxDB 3 server with extra verbose logging
@ -140,7 +140,7 @@ influxdb3 serve \
--verbose \
--object-store file \
--data-dir ~/.influxdb3 \
--writer-id MY_HOST_NAME
--node-id MY_HOST_NAME
```
### Run InfluxDB 3 with debug logging using LOG_FILTER
@ -151,7 +151,7 @@ influxdb3 serve \
LOG_FILTER=debug influxdb3 serve \
--object-store file \
--data-dir ~/.influxdb3 \
--writer-id MY_HOST_NAME
--node-id MY_HOST_NAME
```
{{% /code-placeholders %}}

36
content/influxdb3/enterprise/reference/config-options.md
View File

@ -27,7 +27,7 @@ environment variables.
influxdb3 serve \
--object-store file \
--data-dir ~/.influxdb3 \
--writer-id my-host \
--node-id my-host \
--log-filter info \
--max-http-request-size 20971520 \
--aws-allow-http
@ -53,7 +53,7 @@ influxdb3 serve
- [General](#general)
- [object-store](#object-store)
- [data-dir](#data-dir)
- [writer-id](#writer-id)
- [node-id](#node-id)
- [mode](#mode)
- [AWS](#aws)
- [aws-access-key-id](#aws-access-key-id)
@ -118,11 +118,11 @@ influxdb3 serve
- [wal-max-write-buffer-size](#wal-max-write-buffer-size)
- [snapshotted-wal-files-to-keep](#snapshotted-wal-files-to-keep)
- [Replication](#replication)
- [read-from-writer-ids](#read-from-writer-ids)
- [read-from-node-ids](#read-from-node-ids)
- [replication-interval](#replication-interval)
- [Compaction](#compaction)
- [compactor-id](#compactor-id)
- [compact-from-writer-ids](#compact-from-writer-ids)
- [compact-from-node-ids](#compact-from-node-ids)
- [run-compactions](#run-compactions)
- [compaction-row-limit](#compaction-row-limit)
- [compaction-max-num-files-per-plan](#compaction-max-num-files-per-plan)
@ -147,7 +147,7 @@ influxdb3 serve
- [object-store](#object-store)
- [bucket](#bucket)
- [data-dir](#data-dir)
- [writer-id](#writer-id)
- [node-id](#node-id)
- [mode](#mode)
#### object-store
@ -178,15 +178,15 @@ Defines the location {{< product-name >}} uses to store files locally.
---
#### writer-id
#### node-id
Specifies the writer identifier used as a prefix in all object store file paths.
Specifies the node identifier used as a prefix in all object store file paths.
This should be unique for any hosts sharing the same object store
configuration--for example, the same bucket.
| influxdb3 serve option | Environment variable |
| :--------------------- | :----------------------------------- |
| `--writer-id` | `INFLUXDB3_WRITER_IDENTIFIER_PREFIX` |
| influxdb3 serve option | Environment variable |
| :--------------------- | :--------------------------------- |
| `--node-id` | `INFLUXDB3_NODE_IDENTIFIER_PREFIX` |
---
@ -902,24 +902,24 @@ they are deleted when the number of snapshotted WAL files exceeds this number.
### Replication
- [read-from-writer-ids](#read-from-writer-ids)
- [read-from-node-ids](#read-from-node-ids)
- [replication-interval](#replication-interval)
#### read-from-writer-ids
#### read-from-node-ids
Specifies a comma-separated list of writer identifier prefixes (`writer-id`s) to
Specifies a comma-separated list of writer identifier prefixes (`node-id`s) to
read WAL files from. [env: =]
| influxdb3 serve option | Environment variable |
| :--------------------- | :------------------------------ |
| `--read-from-writer-ids` | `INFLUXDB3_ENTERPRISE_READ_FROM_WRITER_IDS` |
| `--read-from-node-ids` | `INFLUXDB3_ENTERPRISE_READ_FROM_WRITER_IDS` |
---
#### replication-interval
Defines the interval at which each replica specified in the
`read-from-writer-ids` option is replicated.
`read-from-node-ids` option is replicated.
**Default:** `250ms`
@ -932,7 +932,7 @@ Defines the interval at which each replica specified in the
### Compaction
- [compactor-id](#compactor-id)
- [compact-from-writer-ids](#compact-from-writer-ids)
- [compact-from-node-ids](#compact-from-node-ids)
- [run-compactions](#run-compactions)
- [compaction-row-limit](#compaction-row-limit)
- [compaction-max-num-files-per-plan](#compaction-max-num-files-per-plan)
@ -952,14 +952,14 @@ write buffer and any replicas it manages.
---
#### compact-from-writer-ids
#### compact-from-node-ids
Defines a comma-separated list of writer identifier prefixes from which data is
compacted.
| influxdb3 serve option | Environment variable |
| :-------------------------- | :--------------------------------------------- |
| `--compact-from-writer-ids` | `INFLUXDB3_ENTERPRISE_COMPACT_FROM_WRITER_IDS` |
| `--compact-from-node-ids` | `INFLUXDB3_ENTERPRISE_COMPACT_FROM_WRITER_IDS` |
---