coaxial.healthchecks

Healthchecks Role

Build Status

This role sets up a Dockerized version of healthchecks. It can also create a backup to a borg repository every hour and optionally restore the latest backup after installation.

Requirements

  • An Ubuntu host
  • Optional: A borg backup repository
  • Docker and Docker Compose (along with the pip modules docker, docker-py, docker-compose)

Role Variables

Name Default Value Possible Values Purpose Notes
hc__db_name hc Any valid database name Database name in the RDBMS
hc__db_user postgres Any valid RDBMS username Username for accessing the database
hc__db_password None, must be set Any string Database password Required for MySQL or Postgres
hc__email_host None, must be set Any valid hostname, FQDN, or IP Mail server used to send notifications
hc__email_port 587 Any valid port number Port to connect to the mail server
hc__email_user healthchecks Any username supported by the mail server Username for email notifications
hc__email_password None, must be set Any string Password for the email user
hc__email_from None, must be set Any valid email address Default "from" address for emails
hc__site_name Healthchecks monitoring Any string Name used throughout the app
hc__hostname None, must be set Sets the root URL for the application This role enables HTTP only. For HTTPS setup, check my docker-reverse-proxy role.
hc__su_email None, must be set Any valid email address Used to create the first admin user
hc__su_password None, must be set Any string Password for the first admin user
hc__su_username None, must be set Any string of [a-zA-Z0-9] characters Username for the first admin user
hc__enable_backups true true or false Enable or disable hourly backups to the borg repo
hc__backup_passphrase None, must be set Any string Password for the borg repository (if backups are enabled)
hc__borg_repo_url None, must be set Any valid borg repo string URL for the borg repository More info
hc__restore_backup false true or false Whether to restore the latest borg backup after installation

Notes

To use HTTPS, set it up on the host (for example, using nginx as a reverse proxy and Let's Encrypt). Refer to my docker-proxy role for guidance.

Example Playbook

- hosts: servers
  roles:
     - coaxial.healthchecks

License

BSD

Author Information

Coaxial, https://64b.it

Informazioni sul progetto

deploy your own healthchecks.io

Installa
ansible-galaxy install coaxial.healthchecks
Licenza
Unknown
Download
168
Proprietario