Add clustering documentation #11
Conversation
|
|
||
| * `--addr` (`-a`) - The `host:port:name` to be advertised to other clustering nodes. | ||
| * `--seed-addrs` (`-s`) - A space-separated list of the `host:port:name` for other known nodes. | ||
| * `--heartbeat-time` (`-H`) - The number of seconds between heartbeats in the clustering protocol. |
There was a problem hiding this comment.
As part of the roadmap (#1), these clustering setup options are going to change soon. I think they are missing some needed features for flexibility, and I want to generally confirm that everything is as it should be in the 1.0 version. That's why I was a bit hesitant to write documentation about this.
However, I suppose that having some documentation about the current clustering setup options is better than having nothing. These docs can be updated when changes occur.
There was a problem hiding this comment.
However, I suppose that having some documentation about the current clustering setup options is better than having nothing.
That was my thought. It wasn't inherently obvious from the current documentation that clustering was possible or what options I needed to use to do it.
These docs can be updated when changes occur.
👍 I can certainly help with that as well if necessary.
| - "--addr=db2:9999:db2" | ||
| - "--seed-addrs=db1:9999:db1 db3:9999:db3" | ||
| links: | ||
| - db1 |
There was a problem hiding this comment.
Do we also need to link to db3 here, for docker to let us resolve the db3 hostname?
Similarly, do we need to add links for db2 and db3 in the db1 stanza above?
I don't remember whether docker will let us resolve the others by hostname unless the are linked.
There was a problem hiding this comment.
The links are bidirectional and Docker also uses them to build a dependency tree. Adding the extra links results in: ERROR: Circular dependency between db3 and db2.
This PR adds documentation containing a description of Jylis' clustering, as well as a practical example.