Skip to content

Commit be2724c

Browse files
jstirnamanjstirnaman
authored
Merge branch 'master' into chore/fix-typo-in-clustered-bypass-identity-provider-section
2 parents 98d0587 + e6d13f2 commit be2724c

File tree

7 files changed

+77
-77
lines changed

7 files changed

+77
-77
lines changed

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The `influxdb3 serve` command starts the {{< product-name >}} server.
1818
<!--pytest.mark.skip-->
1919

2020
```bash
21-
influxdb3 serve [OPTIONS] --writer-id <HOST_IDENTIFIER_PREFIX>
21+
influxdb3 serve [OPTIONS] --node-id <HOST_IDENTIFIER_PREFIX>
2222
```
2323

2424
## Options
@@ -81,7 +81,7 @@ influxdb3 serve [OPTIONS] --writer-id <HOST_IDENTIFIER_PREFIX>
8181
| | `--snapshotted-wal-files-to-keep` | _See [configuration options](/influxdb3/core/reference/config-options/#snapshotted-wal-files-to-keep)_ |
8282
| | `--query-log-size` | _See [configuration options](/influxdb3/core/reference/config-options/#query-log-size)_ |
8383
| | `--buffer-mem-limit-mb` | _See [configuration options](/influxdb3/core/reference/config-options/#buffer-mem-limit-mb)_ |
84-
| {{< req "\*" >}} | `--writer-id` | _See [configuration options](/influxdb3/core/reference/config-options/#writer-id)_ |
84+
| {{< req "\*" >}} | `--node-id` | _See [configuration options](/influxdb3/core/reference/config-options/#node-id)_ |
8585
| | `--parquet-mem-cache-size-mb` | _See [configuration options](/influxdb3/core/reference/config-options/#parquet-mem-cache-size-mb)_ |
8686
| | `--parquet-mem-cache-prune-percentage` | _See [configuration options](/influxdb3/core/reference/config-options/#parquet-mem-cache-prune-percentage)_ |
8787
| | `--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.
121121
influxdb3 serve \
122122
--object-store file \
123123
--data-dir ~/.influxdb3 \
124-
--writer-id MY_HOST_ID
124+
--node-id MY_HOST_ID
125125
```
126126

127127
### Run the InfluxDB 3 server with extra verbose logging
@@ -133,7 +133,7 @@ influxdb3 serve \
133133
--verbose \
134134
--object-store file \
135135
--data-dir ~/.influxdb3 \
136-
--writer-id MY_HOST_ID
136+
--node-id MY_HOST_ID
137137
```
138138

139139
### Run InfluxDB 3 with debug logging using LOG_FILTER
@@ -144,7 +144,7 @@ influxdb3 serve \
144144
LOG_FILTER=debug influxdb3 serve \
145145
--object-store file \
146146
--data-dir ~/.influxdb3 \
147-
--writer-id MY_HOST_ID
147+
--node-id MY_HOST_ID
148148
```
149149

150150
{{% /code-placeholders %}}

‎content/influxdb3/core/reference/config-options.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ environment variables.
2727
influxdb3 serve \
2828
--object-store file \
2929
--data-dir ~/.influxdb3 \
30-
--writer-id my-host \
30+
--node-id my-host \
3131
--log-filter info \
3232
--max-http-request-size 20971520 \
3333
--aws-allow-http
@@ -53,7 +53,7 @@ influxdb3 serve
5353
- [General](#general)
5454
- [object-store](#object-store)
5555
- [data-dir](#data-dir)
56-
- [writer-id](#writer-id)
56+
- [node-id](#node-id)
5757
- [AWS](#aws)
5858
- [aws-access-key-id](#aws-access-key-id)
5959
- [aws-secret-access-key](#aws-secret-access-key)
@@ -136,7 +136,7 @@ influxdb3 serve
136136
- [object-store](#object-store)
137137
- [bucket](#bucket)
138138
- [data-dir](#data-dir)
139-
- [writer-id](#writer-id)
139+
- [node-id](#node-id)
140140

141141
#### object-store
142142

@@ -166,15 +166,15 @@ Defines the location {{< product-name >}} uses to store files locally.
166166

167167
---
168168

169-
#### writer-id
169+
#### node-id
170170

171-
Specifies the writer identifier used as a prefix in all object store file paths.
171+
Specifies the node identifier used as a prefix in all object store file paths.
172172
This should be unique for any hosts sharing the same object store
173173
configuration--for example, the same bucket.
174174

175-
| influxdb3 serve option | Environment variable |
176-
| :--------------------- | :----------------------------------- |
177-
| `--writer-id` | `INFLUXDB3_WRITER_IDENTIFIER_PREFIX` |
175+
| influxdb3 serve option | Environment variable |
176+
| :--------------------- | :--------------------------------- |
177+
| `--node-id` | `INFLUXDB3_NODE_IDENTIFIER_PREFIX` |
178178

179179
---
180180

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The `influxdb3 serve` command starts the {{< product-name >}} server.
1616
<!--pytest.mark.skip-->
1717

1818
```bash
19-
influxdb3 serve [OPTIONS] --writer-id <HOST_IDENTIFIER_PREFIX>
19+
influxdb3 serve [OPTIONS] --node-id <HOST_IDENTIFIER_PREFIX>
2020
```
2121

2222
## Options
@@ -78,12 +78,12 @@ influxdb3 serve [OPTIONS] --writer-id <HOST_IDENTIFIER_PREFIX>
7878
| | `--wal-max-write-buffer-size` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#wal-max-write-buffer-size)_ |
7979
| | `--query-log-size` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#query-log-size)_ |
8080
| | `--buffer-mem-limit-mb` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#buffer-mem-limit-mb)_ |
81-
| {{< req "\*" >}} | `--writer-id` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#writer-id)_ |
81+
| {{< req "\*" >}} | `--node-id` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#node-id)_ |
8282
| | `--mode` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#mode)_ |
83-
| | `--read-from-writer-ids` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#read-from-writer-ids)_ |
83+
| | `--read-from-node-ids` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#read-from-node-ids)_ |
8484
| | `--replication-interval` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#replication-interval)_ |
8585
| | `--compactor-id` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#compactor-id)_ |
86-
| | `--compact-from-writer-ids` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#compact-from-writer-ids)_ |
86+
| | `--compact-from-node-ids` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#compact-from-node-ids)_ |
8787
| | `--run-compactions` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#run-compactions)_ |
8888
| | `--compaction-row-limit` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#compaction-row-limit)_ |
8989
| | `--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.
128128
influxdb3 serve \
129129
--object-store file \
130130
--data-dir ~/.influxdb3 \
131-
--writer-id MY_HOST_NAME
131+
--node-id MY_HOST_NAME
132132
```
133133

134134
### Run the InfluxDB 3 server with extra verbose logging
@@ -140,7 +140,7 @@ influxdb3 serve \
140140
--verbose \
141141
--object-store file \
142142
--data-dir ~/.influxdb3 \
143-
--writer-id MY_HOST_NAME
143+
--node-id MY_HOST_NAME
144144
```
145145

146146
### Run InfluxDB 3 with debug logging using LOG_FILTER
@@ -151,7 +151,7 @@ influxdb3 serve \
151151
LOG_FILTER=debug influxdb3 serve \
152152
--object-store file \
153153
--data-dir ~/.influxdb3 \
154-
--writer-id MY_HOST_NAME
154+
--node-id MY_HOST_NAME
155155
```
156156

157157
{{% /code-placeholders %}}

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

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ environment variables.
2727
influxdb3 serve \
2828
--object-store file \
2929
--data-dir ~/.influxdb3 \
30-
--writer-id my-host \
30+
--node-id my-host \
3131
--log-filter info \
3232
--max-http-request-size 20971520 \
3333
--aws-allow-http
@@ -53,7 +53,7 @@ influxdb3 serve
5353
- [General](#general)
5454
- [object-store](#object-store)
5555
- [data-dir](#data-dir)
56-
- [writer-id](#writer-id)
56+
- [node-id](#node-id)
5757
- [mode](#mode)
5858
- [AWS](#aws)
5959
- [aws-access-key-id](#aws-access-key-id)
@@ -118,11 +118,11 @@ influxdb3 serve
118118
- [wal-max-write-buffer-size](#wal-max-write-buffer-size)
119119
- [snapshotted-wal-files-to-keep](#snapshotted-wal-files-to-keep)
120120
- [Replication](#replication)
121-
- [read-from-writer-ids](#read-from-writer-ids)
121+
- [read-from-node-ids](#read-from-node-ids)
122122
- [replication-interval](#replication-interval)
123123
- [Compaction](#compaction)
124124
- [compactor-id](#compactor-id)
125-
- [compact-from-writer-ids](#compact-from-writer-ids)
125+
- [compact-from-node-ids](#compact-from-node-ids)
126126
- [run-compactions](#run-compactions)
127127
- [compaction-row-limit](#compaction-row-limit)
128128
- [compaction-max-num-files-per-plan](#compaction-max-num-files-per-plan)
@@ -147,7 +147,7 @@ influxdb3 serve
147147
- [object-store](#object-store)
148148
- [bucket](#bucket)
149149
- [data-dir](#data-dir)
150-
- [writer-id](#writer-id)
150+
- [node-id](#node-id)
151151
- [mode](#mode)
152152

153153
#### object-store
@@ -178,15 +178,15 @@ Defines the location {{< product-name >}} uses to store files locally.
178178

179179
---
180180

181-
#### writer-id
181+
#### node-id
182182

183-
Specifies the writer identifier used as a prefix in all object store file paths.
183+
Specifies the node identifier used as a prefix in all object store file paths.
184184
This should be unique for any hosts sharing the same object store
185185
configuration--for example, the same bucket.
186186

187-
| influxdb3 serve option | Environment variable |
188-
| :--------------------- | :----------------------------------- |
189-
| `--writer-id` | `INFLUXDB3_WRITER_IDENTIFIER_PREFIX` |
187+
| influxdb3 serve option | Environment variable |
188+
| :--------------------- | :--------------------------------- |
189+
| `--node-id` | `INFLUXDB3_NODE_IDENTIFIER_PREFIX` |
190190

191191
---
192192

@@ -902,24 +902,24 @@ they are deleted when the number of snapshotted WAL files exceeds this number.
902902

903903
### Replication
904904

905-
- [read-from-writer-ids](#read-from-writer-ids)
905+
- [read-from-node-ids](#read-from-node-ids)
906906
- [replication-interval](#replication-interval)
907907

908-
#### read-from-writer-ids
908+
#### read-from-node-ids
909909

910-
Specifies a comma-separated list of writer identifier prefixes (`writer-id`s) to
910+
Specifies a comma-separated list of writer identifier prefixes (`node-id`s) to
911911
read WAL files from. [env: =]
912912

913913
| influxdb3 serve option | Environment variable |
914914
| :--------------------- | :------------------------------ |
915-
| `--read-from-writer-ids` | `INFLUXDB3_ENTERPRISE_READ_FROM_WRITER_IDS` |
915+
| `--read-from-node-ids` | `INFLUXDB3_ENTERPRISE_READ_FROM_WRITER_IDS` |
916916

917917
---
918918

919919
#### replication-interval
920920

921921
Defines the interval at which each replica specified in the
922-
`read-from-writer-ids` option is replicated.
922+
`read-from-node-ids` option is replicated.
923923

924924
**Default:** `250ms`
925925

@@ -932,7 +932,7 @@ Defines the interval at which each replica specified in the
932932
### Compaction
933933

934934
- [compactor-id](#compactor-id)
935-
- [compact-from-writer-ids](#compact-from-writer-ids)
935+
- [compact-from-node-ids](#compact-from-node-ids)
936936
- [run-compactions](#run-compactions)
937937
- [compaction-row-limit](#compaction-row-limit)
938938
- [compaction-max-num-files-per-plan](#compaction-max-num-files-per-plan)
@@ -952,14 +952,14 @@ write buffer and any replicas it manages.
952952

953953
---
954954

955-
#### compact-from-writer-ids
955+
#### compact-from-node-ids
956956

957957
Defines a comma-separated list of writer identifier prefixes from which data is
958958
compacted.
959959

960960
| influxdb3 serve option | Environment variable |
961961
| :-------------------------- | :--------------------------------------------- |
962-
| `--compact-from-writer-ids` | `INFLUXDB3_ENTERPRISE_COMPACT_FROM_WRITER_IDS` |
962+
| `--compact-from-node-ids` | `INFLUXDB3_ENTERPRISE_COMPACT_FROM_WRITER_IDS` |
963963

964964
---
965965

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -139,21 +139,21 @@ To start your InfluxDB instance, use the `influxdb3 serve` command
139139
and provide the following:
140140

141141
- `--object-store`: Specifies the type of Object store to use. InfluxDB supports the following: local file system (`file`), `memory`, S3 (and compatible services like Ceph or Minio) (`s3`), Google Cloud Storage (`google`), and Azure Blob Storage (`azure`).
142-
- `--writer-id`: A string identifier that determines the server's storage path within the configured storage location
142+
- `--node-id`: A string identifier that determines the server's storage path within the configured storage location
143143

144144
The following examples show how to start InfluxDB 3 with different object store configurations:
145145

146146
```bash
147147
# MEMORY
148148
# Stores data in RAM; doesn't persist data
149-
influxdb3 serve --writer-id=local01 --object-store=memory
149+
influxdb3 serve --node-id=local01 --object-store=memory
150150
```
151151

152152
```bash
153153
# FILESYSTEM
154154
# Provide the filesystem directory
155155
influxdb3 serve \
156-
--writer-id=local01 \
156+
--node-id=local01 \
157157
--object-store=file \
158158
--data-dir ~/.influxdb3
159159
```
@@ -170,21 +170,21 @@ To run the [Docker image](/influxdb3/core/install/#docker-image) and persist dat
170170
docker run -it \
171171
-v /path/on/host:/path/in/container \
172172
quay.io/influxdb/influxdb3-core:latest serve \
173-
--writer-id my_host \
173+
--node-id my_host \
174174
--object-store file \
175175
--data-dir /path/in/container
176176
```
177177

178178
```bash
179179
# S3 (defaults to us-east-1 for region)
180180
# Specify the Object store type and associated options
181-
influxdb3 serve --writer-id=local01 --object-store=s3 --bucket=[BUCKET] --aws-access-key=[AWS ACCESS KEY] --aws-secret-access-key=[AWS SECRET ACCESS KEY]
181+
influxdb3 serve --node-id=local01 --object-store=s3 --bucket=[BUCKET] --aws-access-key=[AWS ACCESS KEY] --aws-secret-access-key=[AWS SECRET ACCESS KEY]
182182
```
183183

184184
```bash
185185
# Minio/Open Source Object Store (Uses the AWS S3 API, with additional parameters)
186186
# Specify the Object store type and associated options
187-
influxdb3 serve --writer-id=local01 --object-store=s3 --bucket=[BUCKET] --aws-access-key=[AWS ACCESS KEY] --aws-secret-access-key=[AWS SECRET ACCESS KEY] --aws-endpoint=[ENDPOINT] --aws-allow-http
187+
influxdb3 serve --node-id=local01 --object-store=s3 --bucket=[BUCKET] --aws-access-key=[AWS ACCESS KEY] --aws-secret-access-key=[AWS SECRET ACCESS KEY] --aws-endpoint=[ENDPOINT] --aws-allow-http
188188
```
189189

190190
_For more information about server options, run `influxdb3 serve --help`._

0 commit comments

Comments
 (0)