diff --git a/README.md b/README.md index 0e3b824672e3d91957f659aff3432d2ce82fe81c..d1857c79a95affcfb0b74d765a0a98fe601a9409 100644 --- a/README.md +++ b/README.md @@ -52,9 +52,9 @@ number of machines. Having said that, follow these steps to bootstrap a new streaming cluster: -1. Make sure that, on each of your servers, the output of `hostname - -f` is the fully-qualified hostname of the machine, and that it - resolves to its public IP (possibly using `/etc/hosts`). +1. Make sure that, on each of your servers, the output of + `hostname -f` is the fully-qualified hostname of the machine, + and that it resolves to its public IP (possibly using `/etc/hosts`). 2. On every server, run the above-mentioned steps to set up the APT repository and install (do not configure) the `etcd` and @@ -71,12 +71,12 @@ cluster: START=1 BOOTSTRAP=1 - Once you save the file, the `etcd` daemon will start and + Once you save the file, the *etcd* daemon will start and initialize an empty database. 5. On *machine1*, edit `/etc/default/autoradio` and set - `DOMAIN=radio.example.com`. This will start the `radiod` and - `redirectord` daemons, and you will be able to serve DNS records + `DOMAIN=radio.example.com`. This will start the *radiod* and + *redirectord* daemons, and you will be able to serve DNS records for the *radio.example.com* zone. Check with: $ ping -c1 radio.example.com @@ -99,7 +99,7 @@ cluster: `/etc/default/autoradio`, and the daemons will start automatically. - Note that you will need to wait for `etcd` on the new machine to + Note that you will need to wait for etcd on the new machine to start successfully before you can run `etcdctl member add` for the next one. For further instructions on how to change the etcd cluster configuration at runtime, see @@ -116,7 +116,7 @@ then be as simple as running, from the top-level source directory: $ godep go install ./... -This should install the `radiod`, `redirectord` and `radioctl` +This should install the *radiod*, *redirectord* and *radioctl* executables in `$GOPATH/bin`. @@ -196,10 +196,10 @@ X509-based authentication to etcd. ## Securing etcd -In a production cluster, you will want to limit access to the *etcd* +In a production cluster, you will want to limit access to the etcd daemons so that only the other nodes can connect to it. While it is possible to do this with firewall rules, the dynamic membership of the -cluster may make this difficult. We suggest using instead *etcd*'s +cluster may make this difficult. We suggest using instead etcd's support for X509 client authentication, together with a tool to manage an online CA (such as [autoca](https://git.autistici.org/ai/autoca). This way, enrolling a new machine in the cluster only requires @@ -208,7 +208,7 @@ generating a new client certificate, and no other configuration. Install the CA certificate in `/etc/autoradio/etcd_ca.pem`, the client certificate in `/etc/autoradio/etcd_client.pem` and its private key in `/etc/autoradio/etcd_client.key`, and the clients will connect to -*etcd* using SSL authentication. +etcd using SSL authentication. ## Instrumentation