Модуль community.proxysql.proxysql_backend_servers — добавляет или удаляет хосты MySQL через интерфейс администратора ProxySQL
Примечание
Этот модуль входит в коллекцию community.proxysql (версия 1.8.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.proxysql. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: community.proxysql.proxysql_backend_servers.
Краткое описание
- Модуль community.proxysql.proxysql_backend_servers добавляет или удаляет хосты MySQL с помощью интерфейса администратора ProxySQL.
Требования
На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.
- PyMySQL
- mysqlclient
Параметры
Параметр | Комментарии |
|---|---|
comment строка | Текстовое поле, которое можно использовать для любых целей, определяемых пользователем. Например, в нём можно описать хранящиеся на хосте данные, указать, когда хост был добавлен или отключён, либо записать JSON, обрабатываемый скриптом проверки. По умолчанию: |
compression целое число | Если значение compression больше 0, для новых подключений к этому серверу будет использоваться сжатие. Если параметр не указан, в базе данных ProxySQL по умолчанию для compression задано значение 0. |
config_file путь | Укажите файл конфигурации, из которого нужно прочитать значения login_user и login_password. По умолчанию: |
hostgroup_id целое число | Группа хостов, в которую входит этот экземпляр mysqld. Экземпляр может входить в одну или несколько групп хостов. По умолчанию: |
hostname строка / обязательный | IP-адрес, по которому доступен экземпляр mysqld. |
load_to_runtime логическое значение | Динамически загружать конфигурацию в память среды выполнения. Варианты:
|
login_host строка | Хост для подключения к интерфейсу администратора ProxySQL. По умолчанию: |
login_password строка | Пароль для аутентификации в интерфейсе администратора ProxySQL. |
login_port целое число | Порт для подключения к интерфейсу администратора ProxySQL. По умолчанию: |
login_unix_socket строка | Сокет для подключения к интерфейсу администратора ProxySQL. |
login_user строка | Имя пользователя для аутентификации в интерфейсе администратора ProxySQL. |
max_connections целое число | Максимальное количество подключений, которые ProxySQL откроет к этому серверу бэкенда. Если параметр не указан, в базе данных ProxySQL по умолчанию для max_connections задано значение 1000. |
max_latency_ms целое число | Время отклика на ping регулярно отслеживается. Если время отклика хоста превышает max_latency_ms, хост исключается из пула подключений (при этом сервер остаётся в состоянии ONLINE). Если параметр не указан, в базе данных ProxySQL по умолчанию для max_latency_ms задано значение 0. |
max_replication_lag целое число | Если значение больше 0, ProxySQL будет регулярно отслеживать задержку репликации. Если задержка репликации превысит max_replication_lag, ProxySQL временно исключит сервер из работы, пока репликация не догонит. Если параметр не указан, в базе данных ProxySQL по умолчанию для max_replication_lag задано значение 0. |
port целое число | Порт, по которому доступен экземпляр mysqld. По умолчанию: |
save_to_disk логическое значение | Сохранить конфигурацию в базе данных SQLite на диске, чтобы обеспечить её сохранность. Варианты:
|
state строка | Если указано Варианты:
|
status строка | ONLINE — сервер бэкенда полностью работоспособен. OFFLINE_SOFT — при переводе сервера в режим Варианты:
|
use_ssl логическое значение | Если для use_ssl задано значение Варианты:
|
weight целое число | Чем больше вес сервера относительно весов других серверов, тем выше вероятность выбора этого сервера из группы хостов. Если параметр не указан, в базе данных ProxySQL по умолчанию для weight задано значение 1. |
Примечания
Примечание
- Поддерживает
check_mode.
Примеры
---
# This example adds a server, it saves the mysql server config to disk, but
# avoids loading the mysql server config to runtime (this might be because
# several servers 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 server
community.proxysql.proxysql_backend_servers:
login_user: 'admin'
login_password: 'admin'
hostname: 'mysql01'
state: present
load_to_runtime: false
# This example removes a server, saves the mysql server config to disk, and
# dynamically loads the mysql server config to runtime. It uses credentials
# in a supplied config file to connect to the proxysql admin interface.
- name: Remove a server
community.proxysql.proxysql_backend_servers:
config_file: '~/proxysql.cnf'
hostname: 'mysql02'
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
stdout словарь | Хост MySQL, изменённый или удалённый из ProxySQL Возвращается: При создании или обновлении возвращает изменённый хост; при удалении возвращает удалённую запись. Пример: |
Ссылки на коллекцию
© 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_backend_servers_module.html
