Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/robertdebock/ansible-role-keepalived

Install and configure keepalived
https://github.com/robertdebock/ansible-role-keepalived

ansible keepalived molecule networking playbook tox

Last synced: about 1 month ago
JSON representation

Install and configure keepalived

Awesome Lists containing this project

README

        

# [Ansible role keepalived](#keepalived)

Install and configure keepalived

|GitHub|GitLab|Downloads|Version|
|------|------|---------|-------|
|[![github](https://github.com/robertdebock/ansible-role-keepalived/workflows/Ansible%20Molecule/badge.svg)](https://github.com/robertdebock/ansible-role-keepalived/actions)|[![gitlab](https://gitlab.com/robertdebock-iac/ansible-role-keepalived/badges/master/pipeline.svg)](https://gitlab.com/robertdebock-iac/ansible-role-keepalived)|[![downloads](https://img.shields.io/ansible/role/d/robertdebock/keepalived)](https://galaxy.ansible.com/robertdebock/keepalived)|[![Version](https://img.shields.io/github/release/robertdebock/ansible-role-keepalived.svg)](https://github.com/robertdebock/ansible-role-keepalived/releases/)|

## [Example Playbook](#example-playbook)

This example is taken from [`molecule/default/converge.yml`](https://github.com/robertdebock/ansible-role-keepalived/blob/master/molecule/default/converge.yml) and is tested on each push, pull request and release.

```yaml
---
- name: Converge
hosts: all
become: true
gather_facts: true

roles:
- role: robertdebock.keepalived
keepalived_vrrp_instances:
- name: VI_1
state: MASTER
interface: eth0
unicast_src_ip: "172.17.0.6"
secondary_private_ip: "172.17.0.7"
virtual_router_id: 51
priority: 255
authentication:
auth_type: PASS
auth_pass: "12345"
virtual_ipaddresses:
- name: "172.17.0.8"
cidr: 16
```

The machine needs to be prepared. In CI this is done using [`molecule/default/prepare.yml`](https://github.com/robertdebock/ansible-role-keepalived/blob/master/molecule/default/prepare.yml):

```yaml
---
- name: Prepare
hosts: all
become: true
gather_facts: false

roles:
- role: robertdebock.bootstrap
```

Also see a [full explanation and example](https://robertdebock.nl/how-to-use-these-roles.html) on how to use these roles.

## [Role Variables](#role-variables)

The default values for the variables are set in [`defaults/main.yml`](https://github.com/robertdebock/ansible-role-keepalived/blob/master/defaults/main.yml):

```yaml
---
# defaults file for keepalived

# By default, there is not configuration, because there is no "sane default" to
# set. You'll have to set it yourself. Here are a few hints.
#
# Have a look in `molecule/default/converge.yml` for an example.
# You do not need to set the state to `MASTER`, all nodes can also be set to
# `BACKUP`, in which case a random host will be selected to configure the
# virtual IP. Setting `state` to `MASTER` only initially sets that host to be
# the master. Over time, other nodes will likely become master.
#
# You can see the configure virtual IP using `ip addr list eth0`.

# keepalived_vrrp_instances:
# # `name` defines an individual instance of the VRRP protocol running on an interface.
# - name: VI_1
# # `state` defines the initial state that the instance should start in.
# state: MASTER
# # `interface` defines the interface that VRRP runs on.
# interface: eth0
# # `unicast_src_ip` contains the primary address for unicasts.
# unicast_src_ip: "192.168.1.1"
# # `secondary_private_ip` refers the the peer's unicast address.
# secondary_private_ip: "192.168.1.2"
# # `virtual_router_id` is the unique identifier.
# virtual_router_id: 51
# # `priority` is the advertised priority.
# priority: 255
# # `check_status_command` will make +3 to priority if command return is 0 (optional). example:
# check_status_command: /sbin/postfix status
# # `authentication` specifies the information necessary for servers participating in VRRP to authenticate with each other.
# authentication:
# auth_type: PASS
# auth_pass: 12345
# # `virtual_ipaddress` defines the IP addresses (there can be multiple) that VRRP is responsible for.
# virtual_ipaddresses:
# - name: "192.168.122.200"
# cidr: 24
keepalived_vrrp_instances: []
```

## [Requirements](#requirements)

- pip packages listed in [requirements.txt](https://github.com/robertdebock/ansible-role-keepalived/blob/master/requirements.txt).

## [State of used roles](#state-of-used-roles)

The following roles are used to prepare a system. You can prepare your system in another way.

| Requirement | GitHub | GitLab |
|-------------|--------|--------|
|[robertdebock.bootstrap](https://galaxy.ansible.com/robertdebock/bootstrap)|[![Build Status GitHub](https://github.com/robertdebock/ansible-role-bootstrap/workflows/Ansible%20Molecule/badge.svg)](https://github.com/robertdebock/ansible-role-bootstrap/actions)|[![Build Status GitLab](https://gitlab.com/robertdebock-iac/ansible-role-bootstrap/badges/master/pipeline.svg)](https://gitlab.com/robertdebock-iac/ansible-role-bootstrap)|

## [Context](#context)

This role is a part of many compatible roles. Have a look at [the documentation of these roles](https://robertdebock.nl/) for further information.

Here is an overview of related roles:
![dependencies](https://raw.githubusercontent.com/robertdebock/ansible-role-keepalived/png/requirements.png "Dependencies")

## [Compatibility](#compatibility)

This role has been tested on these [container images](https://hub.docker.com/u/robertdebock):

|container|tags|
|---------|----|
|[Alpine](https://hub.docker.com/r/robertdebock/alpine)|all|
|[EL](https://hub.docker.com/r/robertdebock/enterpriselinux)|9|
|[Debian](https://hub.docker.com/r/robertdebock/debian)|all|
|[Fedora](https://hub.docker.com/r/robertdebock/fedora)|all|
|[Ubuntu](https://hub.docker.com/r/robertdebock/ubuntu)|all|

The minimum version of Ansible required is 2.12, tests have been done to:

- The previous version.
- The current version.
- The development version.

If you find issues, please register them in [GitHub](https://github.com/robertdebock/ansible-role-keepalived/issues).

## [License](#license)

[Apache-2.0](https://github.com/robertdebock/ansible-role-keepalived/blob/master/LICENSE).

## [Author Information](#author-information)

[robertdebock](https://robertdebock.nl/)

Please consider [sponsoring me](https://github.com/sponsors/robertdebock).