Skip to content

Commit f2806da

Browse files
committed
docs: Explain stateless addressing in Cube Store cluster
1 parent f439a18 commit f2806da

File tree

3 files changed

+27
-17
lines changed

3 files changed

+27
-17
lines changed

docs/pages/product/caching/running-in-production.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -132,11 +132,11 @@ reference][ref-config-env].
132132

133133
| Environment Variable | Specify on Router? | Specify on Worker? |
134134
| ----------------------- | ------------------ | ------------------ |
135-
| `CUBESTORE_SERVER_NAME` | Yes | Yes |
136-
| `CUBESTORE_META_PORT` | Yes | - |
137-
| `CUBESTORE_WORKERS` | Yes | Yes |
138-
| `CUBESTORE_WORKER_PORT` | - | Yes |
139-
| `CUBESTORE_META_ADDR` | - | Yes |
135+
| `CUBESTORE_SERVER_NAME` | Yes | ✅ Yes |
136+
| `CUBESTORE_META_PORT` | Yes | — |
137+
| `CUBESTORE_WORKERS` | Yes | ✅ Yes |
138+
| `CUBESTORE_WORKER_PORT` | | ✅ Yes |
139+
| `CUBESTORE_META_ADDR` | | ✅ Yes |
140140

141141
`CUBESTORE_WORKERS` and `CUBESTORE_META_ADDR` variables should be set with
142142
stable addresses, which should not change. You can use stable DNS names and put

docs/pages/product/deployment.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -107,11 +107,11 @@ following environment variables should be used to manage the roles:
107107

108108
| Environment Variable | Specify on Router? | Specify on Worker? |
109109
| ----------------------- | ------------------ | ------------------ |
110-
| `CUBESTORE_SERVER_NAME` | Yes | Yes |
111-
| `CUBESTORE_META_PORT` | Yes | - |
112-
| `CUBESTORE_WORKERS` | Yes | Yes |
113-
| `CUBESTORE_WORKER_PORT` | - | Yes |
114-
| `CUBESTORE_META_ADDR` | - | Yes |
110+
| `CUBESTORE_SERVER_NAME` | Yes | ✅ Yes |
111+
| `CUBESTORE_META_PORT` | Yes | |
112+
| `CUBESTORE_WORKERS` | Yes | ✅ Yes |
113+
| `CUBESTORE_WORKER_PORT` | | ✅ Yes |
114+
| `CUBESTORE_META_ADDR` | | ✅ Yes |
115115

116116
<InfoBox>
117117

docs/pages/reference/configuration/environment-variables.mdx

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1282,16 +1282,16 @@ The logging level for Cube Store.
12821282

12831283
## `CUBESTORE_META_ADDR`
12841284

1285-
The address/port pair for the **router** node in the cluster.
1285+
The address/port pair for the Cube Store **router** node in the cluster.
12861286

12871287
| Possible Values | Default in Development | Default in Production |
12881288
| ------------------------- | ---------------------- | --------------------- |
12891289
| A valid address/port pair | N/A | N/A |
12901290

12911291
## `CUBESTORE_META_PORT`
12921292

1293-
The port for the **router** node to listen for connections on. Ignored when
1294-
`CUBESTORE_META_ADDR` is set.
1293+
The port for the Cube Store **router** node to listen for connections on.
1294+
Ignored when `CUBESTORE_META_ADDR` is set.
12951295

12961296
| Possible Values | Default in Development | Default in Production |
12971297
| ------------------- | ---------------------- | --------------------- |
@@ -1418,8 +1418,10 @@ The number of Cube Store sub-processes that handle `SELECT` queries.
14181418

14191419
## `CUBESTORE_SERVER_NAME`
14201420

1421-
The full name and port number of the Cube Store server. Must be unique for each
1422-
instance in cluster mode.
1421+
The full name and port number of the Cube Store node (either the router
1422+
or a worker). Must be unique for each instance in the Cube Store cluster.
1423+
1424+
Should be passed to the Cube Store router and to each Cube Store worker.
14231425

14241426
| Possible Values | Default in Development | Default in Production |
14251427
| ------------------------- | ---------------------- | --------------------- |
@@ -1445,15 +1447,17 @@ insertion.
14451447
## `CUBESTORE_WORKER_PORT`
14461448

14471449
The port for Cube Store workers to listen to connections on. When set, the node
1448-
will start as a **worker** in the cluster
1450+
will start as a Cube Store **worker** in the cluster
14491451

14501452
| Possible Values | Default in Development | Default in Production |
14511453
| ------------------- | ---------------------- | --------------------- |
14521454
| A valid port number | N/A | N/A |
14531455

14541456
## `CUBESTORE_WORKERS`
14551457

1456-
A comma-separated list of address/port pairs for Cube Store workers.
1458+
A comma-separated list of address/port pairs of Cube Store workers.
1459+
1460+
Should be passed to the Cube Store router and to each Cube Store worker.
14571461

14581462
| Possible Values | Default in Development | Default in Production |
14591463
| -------------------------------------------- | ---------------------- | --------------------- |
@@ -1463,6 +1467,12 @@ A comma-separated list of address/port pairs for Cube Store workers.
14631467
CUBESTORE_WORKERS=worker-1:3123,localhost:3124,123.124.125.128:3123
14641468
```
14651469

1470+
Used to implement stateless addressing within a Cube Store cluster.
1471+
By analyzing `CUBESTORE_WORKERS` and `CUBESTORE_SERVER_NAME`, each node
1472+
is able to determine its position within a Cube Store cluster.
1473+
This allows each worker to know which pre-aggregation partitions it owns
1474+
and how the load is distributed across all workers.
1475+
14661476
## `DEBUG_LOG`
14671477

14681478
If `true`, enables debug logging.

0 commit comments

Comments
 (0)