Skip to content

Commit 920c5b8

Browse files
committed
Refer to templated docker image in cluster guide and remove explicit roles
Removing explicitly configured roles in our documentation will prepare users for the upcoming split of the worker and http-ingress role. Otherwise, if users configure the roles explicitly, they risk that the ingress is not started when upgrading their restate-server.
1 parent e296a37 commit 920c5b8

File tree

4 files changed

+6
-11
lines changed

4 files changed

+6
-11
lines changed

docs/deploy/server/cluster.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,6 @@ This page describes how you can deploy a distributed Restate cluster.
3131
To deploy a distributed Restate cluster without external dependencies, you need to configure the following settings in your [server configuration](/operate/configuration/server):
3232

3333
```toml restate.toml
34-
# Let every node run all roles
35-
roles = ["metadata-server", "admin", "worker", "log-server"]
3634
# Every node needs to have a unique node name
3735
node-name = "UNIQUE_NODE_NAME"
3836
# All nodes need to have the same cluster name

docs/guides/cluster.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,6 @@ To deploy a 3 node distributed Restate cluster, create a file `docker-compose.ym
2424
```yaml docker-compose.yml
2525
x-environment: &common-env
2626
RESTATE_CLUSTER_NAME: "restate-cluster"
27-
# Every node runs every role
28-
RESTATE_ROLES: '["admin", "worker", "log-server", "metadata-server"]'
2927
# For more on logging, see: https://docs.restate.dev/operate/monitoring/logging
3028
RESTATE_LOG_FILTER: "restate=info"
3129
RESTATE_BIFROST__DEFAULT_PROVIDER: "replicated"
@@ -43,7 +41,7 @@ x-environment: &common-env
4341
RESTATE_WORKER__SNAPSHOTS__AWS_SECRET_ACCESS_KEY: "minioadmin"
4442

4543
x-defaults: &defaults
46-
image: docker.restate.dev/restatedev/restate:1.2
44+
image: docker.restate.dev/restatedev/restate:VAR::RESTATE_VERSION
4745
extra_hosts:
4846
- "host.docker.internal:host-gateway"
4947

docs/guides/local-to-replicated.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ destination = "s3://snapshots-bucket/cluster-prefix"
3939

4040
<Step stepLabel="2" title="Enable the replicated loglet">
4141

42-
To be able to use the replicated loglet, make sure the node includes the `log-server` role as following.
42+
To be able to use the replicated loglet, make sure the node includes the `log-server` role if you configure the roles explicitly.
4343

4444
```toml restate.toml
4545
roles = [
@@ -89,7 +89,6 @@ To add more nodes to your cluster, you need to start new Restate servers with th
8989
If you want the new nodes to participate in the replicated metadata cluster, then they should run the `metadata-server` role and use the `replicated` metadata server.
9090

9191
```toml restate.toml
92-
roles = ["metadata-server", "admin", "worker", "log-server"]
9392
cluster-name = "my-cluster"
9493

9594
[metadata-client]

docs/operate/configuration/server.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The Restate Server accepts a [TOML](https://toml.io/en/) configuration file that
2323
Restate server accepts a sub-set of the configuration through command-line arguments, you can see all available options by adding `--help` to `restate-server`.
2424

2525
The order of applying configuration layers follows the following order:
26-
1. Built-in defaults
26+
1. Built-in defaults
2727
2. Configuration file (`--config-file` or via `RESTATE_CONFIG`)
2828
3. Environment variables
2929
4. Command line arguments (`--cluster-name=<VALUE>`)
@@ -35,7 +35,7 @@ Every layer overrides the previous. For instance, command-line arguments will ov
3535
### Environment variables
3636
You can override any configuration entry with an environment variable, this overrides values loaded from the configuration file. To do that, the following rule applies:
3737

38-
* Prefix the configuration entry key with `RESTATE_`
38+
* Prefix the configuration entry key with `RESTATE_`
3939
* Separate every nested struct with `__` (double underscore) and all hyphens `-` with a `_` (single underscore).
4040

4141
For example, to override the `admin.bind-address`, the corresponding environment variable is `RESTATE_ADMIN__BIND_ADDRESS`.
@@ -51,7 +51,8 @@ Example output:
5151
roles = [
5252
"worker",
5353
"admin",
54-
"metadata-store",
54+
"metadata-server",
55+
"log-server",
5556
]
5657
cluster-name = "mycluster"
5758
...
@@ -69,4 +70,3 @@ Then send the signal to the process ID returned from `pgrep`'s output:
6970
kill -USR1 994921
7071
```
7172
Observe the output of the server for a dump of the configuration file contents.
72-

0 commit comments

Comments
 (0)