From 536f50ec972c0dae7a881c8eb64b3c7e0d13fab3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sen=C3=A9n=20Rodero=20Rodr=C3=ADguez?= <15726+Senen@users.noreply.github.com> Date: Wed, 15 Nov 2023 11:44:49 +0100 Subject: [PATCH 1/2] Mention configuration variables before the playbook Deployers should scan group_vars/all and the documented variables first so they do not provision with placeholder credentials or unrelated defaults. --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 7b5cb16..f132dc6 100644 --- a/README.md +++ b/README.md @@ -71,6 +71,8 @@ Update your local `hosts` file with the remote server's ip address remote-server-ip-address (maintain other default options) ``` +Before running the playbook, review the defaults in `group_vars/all` and the [configuration variables](#configuration-variables) in this README. + Run the ansible playbook ``` From 1fe60fc699e632a5391e40d501190c8dfc4f6766 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sen=C3=A9n=20Rodero=20Rodr=C3=ADguez?= <15726+Senen@users.noreply.github.com> Date: Wed, 15 Nov 2023 12:51:02 +0100 Subject: [PATCH 2/2] Clarify Installer vs Capistrano responsibilities and re-running Ansible Explain that the playbook can be re-run for supported infrastructure changes (SSL or Ansible variables), while application deploys remain handled by Capistrano. Clarify that re-running the installer is not a safe migration path across installer versions. --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f132dc6..e836f1b 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,12 @@ [CONSUL DEMOCRACY](https://github.com/consuldemocracy/consuldemocracy) installer for production environments +The Consul Democracy installer's objective is to help the community provision a brand-new server with all the libraries and tools needed to run Consul Democracy on production. We do not recommend using the installer on servers already running other services. + +You can re-run the playbook for infrastructure changes the installer supports (such as HTTPS with Let's Encrypt or adjustments in `group_vars/all`) as in the SSL section below. + +Once you've got a working Consul Democracy installation, you should *not* use this installer to upgrade to a new version of Consul Democracy. That's not supported, and you might end up losing data. To upgrade to a new version of Consul Democracy, follow the instructions in the release notes for that version, and deploy the new version to the server with Capistrano. Check the [keep your fork updated documentation](https://docs.consuldemocracy.org/tech_docs/getting_started/update#pulling-changes-from-consul-democracy) for more information. + Using [Ansible](http://docs.ansible.com/), it will install and configure the following: - Ruby @@ -21,7 +27,7 @@ It will also create a `deploy` user to install these libraries [How to setup CONSUL DEMOCRACY for a production environment](https://youtu.be/1lvnjDuRFzw) -## Prerequisities +## Prerequisites A remote server with one of the supported distributions: