Skip to content

Latest commit

 

History

History
54 lines (36 loc) · 2.97 KB

README.md

File metadata and controls

54 lines (36 loc) · 2.97 KB

Ansible Collection - nephelaiio.consul

Build Status Ansible Galaxy

An ansible collection to install and manage Consul clusters

Collection hostgroups

Hostgroup Default Description
consul_group_name 'consul' Consul cluster members
consul_update_skip_group 'consul_update_skip' Consul cluster update skip hosts

Collection variables

The following is the list of parameters intended for end-user manipulation:

Cluster wide parameters

Parameter Default Description Required
consul_release 1.18.1-1 Consul release target false
consul_datacenter_name 'consul' Consul Datacenter name false
consul_backup_path '/backups/consul' Consul snapshot backup path false
consul_backup_bin '/usr/local/bin/consul-snapshot Consul snapshot backup script location false
consul_backup_retention 1440 Consul snapshot retention in minutes false
consul_backup_minutes '*/5' Consul snapshot cronjob component false
consul_backup_hours '*' Consul snapshot cronjob component false
consul_backup_days '*' Consul snapshot cronjob component false
consul_group 'consul Consul OS group false
consul_role 'server' Consul node role, one of ['server', client] false

Collection playbooks

  • nephelaiio.consul.install: Install and bootstrap cluster
  • nephelaiio.consul.update: Install and bootstrap cluster

Testing

Please make sure your environment has docker installed in order to run role validation tests.

Role is tested against the following distributions (docker images):

  • Ubuntu Jammy
  • Debian 12
  • Rocky Linux 9

You can test the collection directly from sources using command make test

License

This project is licensed under the terms of the MIT License