Модуль community.proxysql.proxysql_pgsql_replication_hostgroups – Управление группами хостов репликации с помощью интерфейса администратора proxysql

Примечание

Этот модуль входит в коллекцию community.proxysql (версия 1.8.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.proxysql. Для использования этого модуля требуются дополнительные зависимости; подробную информацию см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.proxysql.proxysql_pgsql_replication_hostgroups.

Добавлено в community.proxysql 1.8.0

Краткое описание
Требования
Параметры
Атрибуты
Примеры
Возвращаемые значения

Краткое описание

Каждая строка в pgsql_replication_hostgroups представляет пару writer_hostgroup и reader_hostgroup. ProxySQL отслеживает значение read_only для всех серверов в указанных группах хостов и на основании значения read_only назначает сервер в группу хостов для записи или чтения.

Требования

Следующие требования необходимы на узле, выполняющем этот модуль.

PyMySQL
mysqlclient

Параметры

Параметр	Комментарии
check_type string	Тип выполняемой проверки. На данный момент поддерживается только `read_only`, поэтому это поле не используется. Допустимые значения: `"read_only"` ← (по умолчанию)
comment string	Текстовое поле, которое пользователь может использовать для любых целей. По умолчанию: `""`
config_file path	Укажите файл конфигурации, из которого будут считываться login_user и login_password. По умолчанию: `""`
load_to_runtime boolean	Динамически загружать конфигурацию в память среды выполнения. Допустимые значения: `false` `true` ← (по умолчанию)
login_host string	Хост, используемый для подключения к интерфейсу администратора ProxySQL. По умолчанию: `"127.0.0.1"`
login_password string	Пароль для аутентификации в интерфейсе администратора ProxySQL.
login_port integer	Порт, используемый для подключения к интерфейсу администратора ProxySQL. По умолчанию: `6032`
login_unix_socket string	Сокет, используемый для подключения к интерфейсу администратора ProxySQL.
login_user string	Имя пользователя для аутентификации в интерфейсе администратора ProxySQL.
reader_hostgroup integer / обязательный	Идентификатор группы хостов для чтения.
save_to_disk boolean	Сохранять конфигурацию в базе данных SQLite на диске, чтобы она сохранялась между запусками. Допустимые значения: `false` `true` ← (по умолчанию)
state string	Если указано `present` — добавляет группу хостов репликации; если указано `absent` — удаляет группу хостов репликации. Допустимые значения: `"present"` ← (по умолчанию) `"absent"`
writer_hostgroup integer / обязательный	Идентификатор группы хостов для записи.

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Не вносить изменения в память, на диск или в среду выполнения.

Примеры

---
# This example adds a replication hostgroup, it saves the pgsql server config
# to disk, but avoids loading the pgsql server config to runtime (this might be
# because several replication hostgroup are being added and the user wants to
# push the config to runtime in a single batch using the
# community.general.proxysql_manage_config module).  It uses supplied credentials
# to connect to the proxysql admin interface.

- name: Add a replication hostgroup
  community.proxysql.proxysql_pgsql_replication_hostgroups:
    login_user: 'admin'
    login_password: 'admin'
    writer_hostgroup: 1
    reader_hostgroup: 2
    state: present
    load_to_runtime: false

# This example removes a replication hostgroup, saves the pgsql server config
# to disk, and dynamically loads the pgsql server config to runtime.  It uses
# credentials in a supplied config file to connect to the proxysql admin
# interface.

- name: Remove a replication hostgroup
  community.proxysql.proxysql_pgsql_replication_hostgroups:
    config_file: '~/proxysql.cnf'
    writer_hostgroup: 3
    reader_hostgroup: 4
    state: absent

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
stdout dictionary	Группа хостов репликации, изменённая или удалённая из proxysql. Возвращается: При создании или обновлении возвращает только что изменённую группу, при удалении — удалённую запись. Пример: `{"changed": true, "msg": "Added repl group configuration to pgsql_replication_hostgroups", "repl_group": {"check_type": "read_only", "comment": "", "reader_hostgroup": "1", "writer_hostgroup": "2"}, "state": "present"}`

Ключ

Описание

stdout

dictionary

Группа хостов репликации, изменённая или удалённая из proxysql.

Возвращается: При создании или обновлении возвращает только что изменённую группу, при удалении — удалённую запись.

Пример: {"changed": true, "msg": "Added repl group configuration to pgsql_replication_hostgroups", "repl_group": {"check_type": "read_only", "comment": "", "reader_hostgroup": "1", "writer_hostgroup": "2"}, "state": "present"}

Авторы

Janos Ruszo (@jruszo)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/proxysql/proxysql_pgsql_replication_hostgroups_module.html