proxysql_backend_servers - Добавляет или удаляет mysql хосты из администрирования proxysql.
Новая версия с 2.3.
Описание
- Модуль proxysql_backend_servers добавляет или удаляет mysql хосты с помощью интерфейса администрирования proxysql.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- PyMySQL (Python 2.7 и Python 3.X), или
- MySQLdb (Python 2.x)
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| comment | Значение по умолчанию: | Поле текста, которое может использоваться для любых целей, определенных пользователем. Может содержать описание того, что хранит хост, напоминание о том, когда хост был добавлен или отключен, или JSON, обрабатываемый некоторым скриптом-проверяющим. |
| compression | Если значение compression больше 0, новые подключения к этому серверу будут использовать сжатие. Если опущено, по умолчанию в базе данных proxysql compression равно 0. | |
| config_file | Значение по умолчанию: | Укажите конфигурационный файл, из которого необходимо считывать login_user и login_password. |
| hostgroup_id | Значение по умолчанию: 0 | Группа хостов, в которую включен этот экземпляр mysqld. Экземпляр может входить в одну или несколько групп хостов. |
| hostname обязательно | IP-адрес, по которому можно связаться с экземпляром mysqld. | |
| load_to_runtime |
| Динамическая загрузка конфигурации в оперативную память. |
| login_host | Значение по умолчанию: 127.0.0.1 | Хост, используемый для подключения к интерфейсу администрирования ProxySQL. |
| login_password | Значение по умолчанию: None | Пароль, используемый для аутентификации в интерфейсе администрирования ProxySQL. |
| login_port | Значение по умолчанию: 6032 | Порт, используемый для подключения к интерфейсу администрирования ProxySQL. |
| login_user | Значение по умолчанию: None | Имя пользователя, используемое для аутентификации в интерфейсе администрирования ProxySQL. |
| max_connections | Максимальное количество подключений, которые ProxySQL откроет к этому серверу-бекенду. Если опущено, по умолчанию в базе данных proxysql max_connections равно 1000. | |
| max_latency_ms | Время пинга регулярно отслеживается. Если время пинга хоста больше, чем max_latency_ms, он исключается из пула подключений (хотя сервер остается онлайн). Если опущено, по умолчанию в базе данных proxysql max_latency_ms равно 0. | |
| max_replication_lag | Если больше 0, ProxySQL будет регулярно отслеживать задержку репликации. Если задержка репликации превышает max_replication_lag, proxysql временно отключает сервер, пока репликация не догонит. | |
| port | Значение по умолчанию: 3306 | Порт, по которому можно связаться с экземпляром mysqld. |
| save_to_disk |
| Сохранение конфигурации в базе данных sqlite на диске для сохранения конфигурации. |
| state |
| Когда present - добавляет хост, когда absent - удаляет хост. |
| status |
| ONLINE - Сервер-бекенд полностью работает. OFFLINE_SOFT - Когда сервер переводится в OFFLINE_SOFT режим, подключения остаются в использовании до завершения текущей транзакции. Это позволяет плавно отключить бэкенд. OFFLINE_HARD - Когда сервер переводится в OFFLINE_HARD режим, существующие подключения отбрасываются, а новые входящие подключения также не принимаются. Если опущено, по умолчанию в базе данных proxysql status равен ONLINE. |
| use_ssl | Если use_ssl установлено в True, подключения к этому серверу будут выполняться с использованием SSL-подключений. Если опущено, по умолчанию в базе данных proxysql use_ssl равно False. | |
| weight | Чем больше вес сервера по отношению к другим весам, тем выше вероятность, что сервер будет выбран из группы хостов. Если опущено, по умолчанию в базе данных proxysql weight равен 1. |
Примеры
---
# 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 M(proxysql_manage_config) module). It
# uses supplied credentials to connect to the proxysql admin interface.
- 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.
- proxysql_backend_servers:
config_file: '~/proxysql.cnf'
hostname: 'mysql02'
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие — поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| stdout dict | При создании/обновлении возвращает новый измененный хост, при удалении — удалённую запись. | Измененный или удалённый mysql хост из proxysql Пример: {'msg': 'Добавлен сервер в mysql_hosts', 'state': 'present', 'changed': True, 'hostname': '192.168.52.1', 'server': {'comment': '', 'status': 'ONLINE', 'compression': '0', 'weight': '1', 'hostname': '192.168.52.1', 'hostgroup_id': '1', 'use_ssl': '0', 'max_connections': '1000', 'port': '3306', 'max_latency_ms': '0', 'max_replication_lag': '0'}} |
Статус
Этот модуль помечен как stableinterface, что означает, что разработчики этого модуля гарантируют, что не будет внесены несовместимые с предыдущими версиями изменения в интерфейс.
Автор
- Ben Mildren (@bmildren)
Подсказка
Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/proxysql_backend_servers_module.html
