Skip to content

Commit

Permalink
doc: updated experimentation.md to use dash instead of underscore
Browse files Browse the repository at this point in the history
See previous commit for reasoning; makes it easier with docker compose.
  • Loading branch information
meling committed Dec 17, 2024
1 parent a4d1a70 commit 1b5c3ff
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions docs/experimentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -235,19 +235,19 @@ these additional flags are used:
- `--worker` runs a worker locally, in addition to the remote hosts specified. Use this if you want the local machine
to participate in the experiment.

Additionally, it is possible to specify an *internal address* for each host.
Additionally, it is possible to specify an _internal address_ for each host.
The internal address is used by replicas instead of the address used by the controller.
This is useful if the controller is connecting to the remote hosts using a global address,
whereas the hosts can communicate using local addresses.
The internal address is configured through the configuration file (loaded by the `--config` flag):

```toml
[[hosts-config]]
name = "hotstuff_worker_1"
name = "hotstuff-worker-1"
internal-address = "192.168.10.2"

[[hosts-config]]
name = "hotstuff_worker_1"
name = "hotstuff-worker-1"
internal-address = "192.168.10.3"
```

Expand All @@ -262,21 +262,21 @@ The following shows a configuration file that customizes the client and replica
clients = 2
replicas = 8

hosts = [
"hotstuff_worker_1",
"hotstuff_worker_2",
"hotstuff_worker_3",
"hotstuff_worker_4",
hosts = [
"hotstuff-worker-1",
"hotstuff-worker-2",
"hotstuff-worker-3",
"hotstuff-worker-4",
]

# specific assignments for some hosts
[[hosts-config]]
name = "hotstuff_worker_1"
name = "hotstuff-worker-1"
clients = 2
replicas = 0
```

In particular, in this example the host named `hotstuff_worker_1` is configured to run both clients and no replicas.
In particular, in this example the host named `hotstuff-worker-1` is configured to run both clients and no replicas.
The remaining replicas are divided among the remaining hosts. If all hosts are manually configured, the total number of
clients and replicas configured must equal the requested number of clients and replicas.

Expand Down

0 comments on commit 1b5c3ff

Please sign in to comment.