hosting/cloudserve-infrastructure
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Update README

Browse source 
Added simple deployment information.
This commit is contained in:
Marty Oehme 2021-10-26 18:12:33 +02:00
parent 3f944df048
commit 6c2fc110b7
Signed by: Marty
GPG key ID: B7538B8F50A1C800
1 changed files with 17 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -4,7 +4,8 @@
This repository comes with a test-ready setup to try out the complete site setup locally.
It uses vagrant to accomplish this and create a pretend target host.
So, install [vagrant](https://www.vagrantup.com/) on your system and to make tests repeatable also install the vagrant plugins `vagrant-hosts` and `vagrant-hostsupdater`.
Install [vagrant](https://www.vagrantup.com/) on your system and to make tests repeatable also install the vagrant plugins `vagrant-hosts` and `vagrant-hostsupdater`,
which will set a static IP for the vagrant host to be reachable under.
```bash
vagrant plugin install vagrant-hosts vagrant-hostsupdater
@ -14,3 +15,18 @@ Then you are ready to run the complete infrastructure setup locally,
simply by executing `ansible-playbook site.yml`.
You can of course pick and choose what should be executed with host limits, tags, group variables, and so on,
but this should provide an easy way to see if a) the playbook is working as intended and b) what it does is useful.
## Deployment
Most variables to be changed should be set either through `group_variables` or `host_variables`.
For my deployment I have a `production` group under `group_variables` which houses both a `vars.yml` containing basic variables
(like `server_domain`, `caddy_email`, etc.)
and a `vault.yml` which houses everything that should ideally not be lying around in plain-text
(individual container and database passwords for the various roles etc).
To create such a file you can do `ansible-vault create group_vars/<group-name>/vault.yml` or
do `ansible-vault edit group_vars/<group-name>/vault.yml` to edit it.
Look into the `default/main.yml` files of the various roles to see which variables should be set or can be overridden.
The `README.md` files of the roles should also carry enough information about the individual variables to make sense.