Skip to content

Commit d3625a5

Browse files
fix: updating writer-id to node-id
1 parent 92ebd7f commit d3625a5

File tree

2 files changed

+38
-38
lines changed

2 files changed

+38
-38
lines changed

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`._

content/shared/v3-enterprise-get-started/_index.md

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -130,21 +130,21 @@ To start your InfluxDB instance, use the `influxdb3 serve` command
130130
and provide the following:
131131

132132
- `--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`).
133-
- `--writer-id`: A string identifier that determines the server's storage path within the configured storage location, and, in a multi-node setup, is used to reference the node
133+
- `--node-id`: A string identifier that determines the server's storage path within the configured storage location, and, in a multi-node setup, is used to reference the node
134134

135135
The following examples show how to start InfluxDB 3 with different object store configurations:
136136

137137
```bash
138138
# MEMORY
139139
# Stores data in RAM; doesn't persist data
140-
influxdb3 serve --writer-id=local01 --object-store=memory
140+
influxdb3 serve --node-id=local01 --object-store=memory
141141
```
142142

143143
```bash
144144
# FILESYSTEM
145145
# Provide the filesystem directory
146146
influxdb3 serve \
147-
--writer-id=local01 \
147+
--node-id=local01 \
148148
--object-store=file \
149149
--data-dir ~/.influxdb3
150150
```
@@ -161,21 +161,21 @@ To run the [Docker image](/influxdb3/enterprise/install/#docker-image) and persi
161161
docker run -it \
162162
-v /path/on/host:/path/in/container \
163163
quay.io/influxdb/influxdb3-enterprise:latest serve \
164-
--writer-id my_host \
164+
--node-id my_host \
165165
--object-store file \
166166
--data-dir /path/in/container
167167
```
168168

169169
```bash
170170
# S3 (defaults to us-east-1 for region)
171171
# Specify the Object store type and associated options
172-
influxdb3 serve --writer-id=local01 --object-store=s3 --bucket=[BUCKET] --aws-access-key=[AWS ACCESS KEY] --aws-secret-access-key=[AWS SECRET ACCESS KEY]
172+
influxdb3 serve --node-id=local01 --object-store=s3 --bucket=[BUCKET] --aws-access-key=[AWS ACCESS KEY] --aws-secret-access-key=[AWS SECRET ACCESS KEY]
173173
```
174174

175175
```bash
176176
# Minio/Open Source Object Store (Uses the AWS S3 API, with additional parameters)
177177
# Specify the Object store type and associated options
178-
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
178+
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
179179
```
180180

181181
_For more information about server options, run `influxdb3 serve --help`._
@@ -783,51 +783,51 @@ The following examples show how to configure and start two nodes
783783
for a basic HA setup.
784784
The example commands pass the following options:
785785
786-
- `--read-from-writer-ids`: makes the node a _read replica_, which checks the Object store for data arriving from other nodes
786+
- `--read-from-node-ids`: makes the node a _read replica_, which checks the Object store for data arriving from other nodes
787787
- `--compactor-id`: activates the Compactor for a node. Only one node can run compaction
788788
- `--run-compactions`: ensures the Compactor runs the compaction process
789789
790790
```bash
791791
## NODE 1
792792
793793
# Example variables
794-
# writer-id: 'host01'
794+
# node-id: 'host01'
795795
# bucket: 'influxdb-3-enterprise-storage'
796796
# compactor-id: 'c01'
797797
798798
799-
influxdb3 serve --writer-id=host01 --read-from-writer-ids=host02 --compactor-id=c01 --run-compactions --object-store=s3 --bucket=influxdb-3-enterprise-storage --http-bind=0.0.0.0:8181 --aws-access-key-id=<AWS_ACCESS_KEY_ID> --aws-secret-access-key=<AWS_SECRET_ACCESS_KEY>
799+
influxdb3 serve --node-id=host01 --read-from-node-ids=host02 --compactor-id=c01 --run-compactions --object-store=s3 --bucket=influxdb-3-enterprise-storage --http-bind=0.0.0.0:8181 --aws-access-key-id=<AWS_ACCESS_KEY_ID> --aws-secret-access-key=<AWS_SECRET_ACCESS_KEY>
800800
```
801801
802802
```
803803
## NODE 2
804804
805805
# Example variables
806-
# writer-id: 'host02'
806+
# node-id: 'host02'
807807
# bucket: 'influxdb-3-enterprise-storage'
808808
809-
influxdb3 serve --writer-id=host02 --read-from-writer-ids=host01 --object-store=s3 --bucket=influxdb-3-enterprise-storage --http-bind=0.0.0.0:8282
809+
influxdb3 serve --node-id=host02 --read-from-node-ids=host01 --object-store=s3 --bucket=influxdb-3-enterprise-storage --http-bind=0.0.0.0:8282
810810
--aws-access-key-id=<AWS_ACCESS_KEY_ID> --aws-secret-access-key=<AWS_SECRET_ACCESS_KEY>
811811
```
812812
813813
After the nodes have started, querying either node returns data for both nodes, and `NODE 1` runs compaction.
814814
To add nodes to this setup, start more read replicas:
815815
816816
```bash
817-
influxdb3 serve --read-from-writer-ids=host01,host02 [...OPTIONS]
817+
influxdb3 serve --read-from-node-ids=host01,host02 [...OPTIONS]
818818
```
819819
820820
> [!Note]
821821
> To run this setup for testing, you can start nodes in separate terminals and pass a different `--http-bind` value for each--for example:
822822
>
823823
> ```bash
824824
> # In terminal 1
825-
> influxdb3 serve --writer-id=host01 --http-bind=http://127.0.0.1:8181 [...OPTIONS]
825+
> influxdb3 serve --node-id=host01 --http-bind=http://127.0.0.1:8181 [...OPTIONS]
826826
> ```
827827
>
828828
> ```bash
829829
> # In terminal 2
830-
> influxdb3 serve --writer-id=host01 --http-bind=http://127.0.0.1:8181 [...OPTIONS]
830+
> influxdb3 serve --node-id=host01 --http-bind=http://127.0.0.1:8181 [...OPTIONS]
831831
832832
### High availability with a dedicated Compactor
833833
@@ -845,39 +845,39 @@ The following examples show how to set up HA with a dedicated Compactor node:
845845
## NODE 1 — Writer/Reader Node #1
846846
847847
# Example variables
848-
# writer-id: 'host01'
848+
# node-id: 'host01'
849849
# bucket: 'influxdb-3-enterprise-storage'
850850
851-
influxdb3 serve --writer-id=host01 --compactor-id=c01 --read-from-writer-ids=host02 --object-store=s3 --bucket=influxdb-3-enterprise-storage --http-bind=0.0.0.0:8181 --aws-access-key-id=<AWS_ACCESS_KEY_ID> --aws-secret-access-key=<AWS_SECRET_ACCESS_KEY>
851+
influxdb3 serve --node-id=host01 --compactor-id=c01 --read-from-node-ids=host02 --object-store=s3 --bucket=influxdb-3-enterprise-storage --http-bind=0.0.0.0:8181 --aws-access-key-id=<AWS_ACCESS_KEY_ID> --aws-secret-access-key=<AWS_SECRET_ACCESS_KEY>
852852
```
853853
854854
```bash
855855
## NODE 2 — Writer/Reader Node #2
856856
857857
# Example variables
858-
# writer-id: 'host02'
858+
# node-id: 'host02'
859859
# bucket: 'influxdb-3-enterprise-storage'
860860
861-
influxdb3 serve --writer-id=host02 --compactor-id=c01 --read-from-writer-ids=host01 --object-store=s3 --bucket=influxdb-3-enterprise-storage --http-bind=0.0.0.0:8282 --aws-access-key-id=<AWS_ACCESS_KEY_ID> --aws-secret-access-key=<AWS_SECRET_ACCESS_KEY>
861+
influxdb3 serve --node-id=host02 --compactor-id=c01 --read-from-node-ids=host01 --object-store=s3 --bucket=influxdb-3-enterprise-storage --http-bind=0.0.0.0:8282 --aws-access-key-id=<AWS_ACCESS_KEY_ID> --aws-secret-access-key=<AWS_SECRET_ACCESS_KEY>
862862
```
863863
864864
2. Start the dedicated compactor node, which uses the following options:
865865
866866
- `--mode=compactor`: Ensures the node **only** runs compaction.
867867
- `--compaction-hosts`: Specifies a comma-delimited list of hosts to run compaction for.
868868
869-
_**Don't include the replicas (`--read-from-writer-ids`) parameter because this node doesn't replicate data._
869+
_**Don't include the replicas (`--read-from-node-ids`) parameter because this node doesn't replicate data._
870870
871871
```bash
872872
873873
## NODE 3 — Compactor Node
874874
875875
# Example variables
876-
# writer-id: 'host03'
876+
# node-id: 'host03'
877877
# bucket: 'influxdb-3-enterprise-storage'
878878
# compactor-id: 'c01'
879879
880-
influxdb3 serve --writer-id=host03 --mode=compactor --compactor-id=c01 --compaction-hosts=host01,host02 --run-compactions --object-store=s3 --bucket=influxdb-3-enterprise-storage --aws-access-key-id=<AWS_ACCESS_KEY_ID> --aws-secret-access-key=<AWS_SECRET_ACCESS_KEY>
880+
influxdb3 serve --node-id=host03 --mode=compactor --compactor-id=c01 --compaction-hosts=host01,host02 --run-compactions --object-store=s3 --bucket=influxdb-3-enterprise-storage --aws-access-key-id=<AWS_ACCESS_KEY_ID> --aws-secret-access-key=<AWS_SECRET_ACCESS_KEY>
881881
```
882882
883883
### High availability with read replicas and a dedicated Compactor
@@ -893,21 +893,21 @@ For a very robust and effective setup for managing time-series data, you can run
893893
## NODE 1 — Writer Node #1
894894
895895
# Example variables
896-
# writer-id: 'host01'
896+
# node-id: 'host01'
897897
# bucket: 'influxdb-3-enterprise-storage'
898898
899-
influxdb3 serve --writer-id=host01 --mode=read_write --object-store=s3 --bucket=influxdb-3-enterprise-storage --http-bind=0.0.0.0:8181 --aws-access-key-id=<AWS_ACCESS_KEY_ID> --aws-secret-access-key=<AWS_SECRET_ACCESS_KEY>
899+
influxdb3 serve --node-id=host01 --mode=read_write --object-store=s3 --bucket=influxdb-3-enterprise-storage --http-bind=0.0.0.0:8181 --aws-access-key-id=<AWS_ACCESS_KEY_ID> --aws-secret-access-key=<AWS_SECRET_ACCESS_KEY>
900900
901901
```
902902
903903
```
904904
## NODE 2 — Writer Node #2
905905
906906
# Example variables
907-
# writer-id: 'host02'
907+
# node-id: 'host02'
908908
# bucket: 'influxdb-3-enterprise-storage'
909909
910-
Usage: $ influxdb3 serve --writer-id=host02 --mode=read_write --object-store=s3 --bucket=influxdb-3-enterprise-storage --http-bind=0.0.0.0:8282 --aws-access-key-id=<AWS_ACCESS_KEY_ID> --aws-secret-access-key=<AWS_SECRET_ACCESS_KEY>
910+
Usage: $ influxdb3 serve --node-id=host02 --mode=read_write --object-store=s3 --bucket=influxdb-3-enterprise-storage --http-bind=0.0.0.0:8282 --aws-access-key-id=<AWS_ACCESS_KEY_ID> --aws-secret-access-key=<AWS_SECRET_ACCESS_KEY>
911911
```
912912
913913
2. Start the dedicated Compactor node (`--mode=compactor`) and ensure it runs compactions on the specified `compaction-hosts`.
@@ -916,36 +916,36 @@ For a very robust and effective setup for managing time-series data, you can run
916916
## NODE 3 — Compactor Node
917917
918918
# Example variables
919-
# writer-id: 'host03'
919+
# node-id: 'host03'
920920
# bucket: 'influxdb-3-enterprise-storage'
921921
922-
influxdb3 serve --writer-id=host03 --mode=compactor --compaction-hosts=host01,host02 --run-compactions --object-store=s3 --bucket=influxdb-3-enterprise-storage --aws-access-key-id=<AWS_ACCESS_KEY_ID> --aws-secret-access-key=<AWS_SECRET_ACCESS_KEY>
922+
influxdb3 serve --node-id=host03 --mode=compactor --compaction-hosts=host01,host02 --run-compactions --object-store=s3 --bucket=influxdb-3-enterprise-storage --aws-access-key-id=<AWS_ACCESS_KEY_ID> --aws-secret-access-key=<AWS_SECRET_ACCESS_KEY>
923923
```
924924
925925
3. Finally, start the query nodes as _read-only_.
926926
Include the following options:
927927
928928
- `--mode=read`: Sets the node to _read-only_
929-
- `--read-from-writer-ids=host01,host02`: A comma-demlimited list of host IDs to read data from
929+
- `--read-from-node-ids=host01,host02`: A comma-demlimited list of host IDs to read data from
930930
931931
```bash
932932
## NODE 4 — Read Node #1
933933
934934
# Example variables
935-
# writer-id: 'host04'
935+
# node-id: 'host04'
936936
# bucket: 'influxdb-3-enterprise-storage'
937937
938-
influxdb3 serve --writer-id=host04 --mode=read --object-store=s3 --read-from-writer-ids=host01,host02 --bucket=influxdb-3-enterprise-storage --http-bind=0.0.0.0:8383 --aws-access-key-id=<AWS_ACCESS_KEY_ID> --aws-secret-access-key=<AWS_SECRET_ACCESS_KEY>
938+
influxdb3 serve --node-id=host04 --mode=read --object-store=s3 --read-from-node-ids=host01,host02 --bucket=influxdb-3-enterprise-storage --http-bind=0.0.0.0:8383 --aws-access-key-id=<AWS_ACCESS_KEY_ID> --aws-secret-access-key=<AWS_SECRET_ACCESS_KEY>
939939
```
940940
941941
```
942942
## NODE 5 — Read Node #2
943943
944944
# Example variables
945-
# writer-id: 'host05'
945+
# node-id: 'host05'
946946
# bucket: 'influxdb-3-enterprise-storage'
947947
948-
influxdb3 serve --writer-id=host05 --mode=read --object-store=s3 --read-from-writer-ids=host01,host02 --bucket=influxdb-3-enterprise-storage --http-bind=0.0.0.0:8484 --aws-access-key-id=<AWS_ACCESS_KEY_ID> --aws-secret-access-key=<AWS_SECRET_ACCESS_KEY>
948+
influxdb3 serve --node-id=host05 --mode=read --object-store=s3 --read-from-node-ids=host01,host02 --bucket=influxdb-3-enterprise-storage --http-bind=0.0.0.0:8484 --aws-access-key-id=<AWS_ACCESS_KEY_ID> --aws-secret-access-key=<AWS_SECRET_ACCESS_KEY>
949949
```
950950
951951
Congratulations, you have a robust setup to workload isolation using {{% product-name %}}.

0 commit comments

Comments
 (0)