diff --git a/README.md b/README.md index 4dcb3ede78920be4fb2232bd88171aac543073cf..d00cc5ccd86c0347a3758f300fa0b6b960ca4caf 100644 --- a/README.md +++ b/README.md @@ -7,28 +7,27 @@ a Docker image) which contains utilities to manage your cluster. ## Prerequisites -We assume a single-node setup for now. - -You need to have ssh access to the root account of the machine that will run +* You need to have ssh access to the root account of the machines that will run your cluster. +* You need ansible installed on your workstation to run the bootstrap scripts. ## Bootstrapping a new cluster -To run the bootstrap process: +### Configure your cluster -``` -./bootstrap $SERVER_IP -``` +Copy `ansible/inventory.example` to `ansible/inventory` and edit it to reflect +your cluster. -where `$SERVER_IP` is the ip address of the machine. (This address will also be -stored in the cluster configuration and is used by the Traefik ingress -controller, so even though using a domain name instead of an ip address may -work at first, that is not recommended.) +Also copy `ansible/group_vars/cluster/settings.yml.example` to +`ansible/group_vars/cluster/settings.yml` and edit as you see fit. -The bootstrap script will fire up your text editor to let you specify some -basic configuration parameters that are needed to set up your cluster. When -you're done editing, save and exit your editor, and the bootstrap process will -continue. +### Install + +To run the bootstrap process, move into the `ansible` directory, then run + +``` +./ansible-playbook -i inventory.yml bootstrap.yml +``` ## Managing an existing cluster @@ -49,7 +48,7 @@ Some programs that you can run from this shell: To start the control shell, run ``` -./manage $SERVER_IP +./manage $SERVER ``` -where `$SERVER_IP` is the address of the machine running your cluster. +where `$SERVER` is the address of the master machine of your cluster.