barman
Ansible Роль: Barman
Устанавливает и настраивает Barman на Linux с возможностью:
- регулярного резервного копирования (запускается по расписанию cron)
- загрузки WAL и снимков в S3 (запускается по расписанию cron)
- сбора метрик (с помощью telegraf)
Эта роль предназначена для минимального вмешательства, т.е. все параметры конфигурации передаются напрямую в конфигурации barman.
Требования
- Ubuntu
Установка
Установите через Ansible Galaxy:
ansible-galaxy collection install giner.barman
Или добавьте эту роль в ваш файл requirements.yml
:
roles:
- name: giner.barman
Переменные роли
Доступные переменные перечислены ниже с их значениями по умолчанию (см. defaults/main.yml
):
Состояние Barman. Перезапишите на absent
, чтобы удалить Barman. Данные не будут удалены.
barman_state: started
Состояние запрашиваемого пакета Barman. Перезапишите на latest
, чтобы обновить Barman.
barman_package_state: present
Глобальная конфигурация Barman (ключ/значение).
barman_config: {}
Серверы PostgreSQL для резервного копирования.
barman_pg_servers: [] # Ключи: name, params, pgpass и cron. См. пример ниже.
Настройка telegraf для сбора метрик Barman.
barman_telegraf_enabled: false
Интервал сбора метрик.
barman_telegraf_interval: 1m
Зависимости
Отсутствуют.
Пример playbook
# Настройка пользователей и их привилегий на сервере базы данных PostgreSQL
# http://docs.pgbarman.org/release/2.12/#postgresql-connection
- hosts: postgresqls
vars:
barman_user: barman
barman_pass: BARMANPASS_CHANGEME
barman_streaming_user: streaming_barman
barman_streaming_pass: STREAMINGPASS_CHANGEME
tasks:
- name: Добавить пользователя PostgreSQL barman_user
community.postgresql.postgresql_user:
user: "{{ barman_user }}"
password: "{{ barman_pass }}"
role_attr_flags: replication
groups: [pg_read_all_settings, pg_read_all_stats]
- name: Добавить пользователя PostgreSQL barman_streaming_user
community.postgresql.postgresql_user:
user: "{{ barman_streaming_user }}"
password: "{{ barman_streaming_pass }}"
role_attr_flags: replication
- name: Предоставить привилегии EXECUTE на функцию pg_XXX пользователю barman_user
community.postgresql.postgresql_privs:
db: postgres
privs: EXECUTE
type: function
obj: pg_start_backup(text:boolean:boolean),pg_stop_backup(),pg_stop_backup(boolean:boolean),pg_switch_wal(),pg_create_restore_point(text)
schema: pg_catalog
roles: "{{ barman_user }}"
# Настройка и конфигурация Barman
- hosts: barmans
vars:
barman_name: mypgserver
barman_pg_hosts: 10.10.10.10
barman_pg_ports: 5432
barman_user: barman
barman_pass: BARMANPASS_CHANGEME
barman_streaming_user: streaming_barman
barman_streaming_pass: STREAMINGPASS_CHANGEME
barman_pg_servers:
- name: "{{ barman_name }}"
params:
- description: "PostgreSQL База Данных (Только для стриминга)"
- conninfo: 'host={{ barman_pg_hosts }} port={{ barman_pg_ports }} user={{ barman_user }} dbname=postgres'
- streaming_conninfo: 'host={{ barman_pg_hosts }} port={{ barman_pg_ports }} user={{ barman_streaming_user }}'
- backup_method: "postgres"
- streaming_archiver: "on"
- slot_name: "barman"
- create_slot: "auto"
- retention_policy: "окно восстановления 31 день"
pgpass:
- "*:*:postgres:{{ barman_user }}:{{ barman_pass }}"
- "*:*:replication:{{ barman_streaming_user }}:{{ barman_streaming_pass }}"
backup_schedule:
cron:
hour: 21
minute: 5
s3_sync:
src: "{{ barman_config['barman_home'] | default('/var/lib/barman') }}/{{ barman_name }}"
dst: "s3://db-backup"
base_cron:
hour: 22
minute: 5
wals_cron:
minute: 10
custom:
job: "barman delete '{{ barman_name }}' oldest"
cron:
hour: 23
minute: 15
roles:
- giner.barman
Разработка
Установите зависимости для тестирования:
python3 -m pip install ansible -Ur requirements-molecule.txt
Запустите все тесты (необходима установка docker):
molecule test --all
Лицензия
Apache 2.0
Авторы
Эта роль была создана в 2021 году Станиславом Германом-Евтушенко
Install and configure Barman on Linux with optional: metrics collection (telegraf), regular snapshots (cron) and uploading to S3 (cron)
ansible-galaxy install giner/ansible-role-barman