Add README.md #127

Merged
benjaoming merged 13 commits from readme into main 2022-11-29 13:58:39 +00:00
Showing only changes of commit 6a29cdc84d - Show all commits

View file

@ -7,11 +7,15 @@ the association's administrators have access to deploy the services.
## Deploying
To deploy the services, the included `deploy.sh` script can be used. The
Ansible playbook uses two custom-made roles (in the `roles/` directory).
The script has options to deploy only one of the roles, which are namely
`ubuntu_base` and `docker`, the latter of which is for deploying the
services themselves using Docker containers. Select services only can
also be specified. By default, the script deploys everything.
Ansible playbook uses two custom-made roles (in the `roles/` directory):
- `ubuntu_base` - used for configuring the OS itself and installing the
necessary packages
samsapti marked this conversation as resolved Outdated

This is really good! Suggesting this:

Ansible playbook uses two custom-made roles (in the roles/ directory):

  • ubuntu_base: ...
  • docker: deploying the services themselves using Docker containers

Select services only can also be specified. By default, the script deploys everything.

This is really good! Suggesting this: > Ansible playbook uses two custom-made roles (in the `roles/` directory): > > * `ubuntu_base`: ... > * `docker`: deploying the services themselves using Docker containers > > Select services only can also be specified. By default, the script deploys everything.

I agree, your suggestion looks a bit cleaner 👍

I agree, your suggestion looks a bit cleaner 👍
- `docker` - used to deploy our services and websites with Docker
containers
The script has options to deploy only one of the roles. Select services only
can also be specified. By default, the script deploys everything.
Here is a summary of the options that can be used with the script: