proxysql_backend_servers - Добавляет или удаляет mysql хосты из админ-интерфейса proxysql.
Новое в версии 2.3.
Описание
- Модуль proxysql_backend_servers добавляет или удаляет mysql хосты с помощью админ-интерфейса proxysql.
Параметры
| параметр | обязательный | значение по умолчанию | допустимые значения | комментарии |
|---|---|---|---|---|
| comment | нет | Поле текста, которое можно использовать для любых целей, определенных пользователем. Может быть описанием того, что хранит хост, напоминанием о том, когда хост был добавлен или отключен, или JSON, обрабатываемым некоторым скриптом-проверяющим. | ||
| compression | нет | Если значение compression больше 0, новые подключения к этому серверу будут использовать сжатие. Если опущено, значение по умолчанию для compression в базе данных proxysql — 0. | ||
| config_file | нет | Укажите файл конфигурации, из которого будут считываться login_user и login_password. | ||
| hostgroup_id | нет | Группа хостов, в которую входит этот экземпляр mysqld. Экземпляр может входить в одну или несколько групп хостов. | ||
| hostname | да | IP-адрес, по которому можно связаться с экземпляром mysqld. | ||
| load_to_runtime | нет | True | Динамически загрузить конфигурацию mysql хоста в оперативную память. | |
| login_host | нет | 127.0.0.1 | Хост, используемый для подключения к админ-интерфейсу ProxySQL. | |
| login_password | нет | None | Пароль, используемый для аутентификации в админ-интерфейсе ProxySQL. | |
| login_port | нет | 6032 | Порт, используемый для подключения к админ-интерфейсу ProxySQL. | |
| login_user | нет | None | Имя пользователя, используемое для аутентификации в админ-интерфейсе ProxySQL. | |
| max_connections | нет | Максимальное количество подключений, которое ProxySQL откроет к этому серверу бэкенда. Если опущено, значение по умолчанию для max_connections в базе данных proxysql — 1000. | ||
| max_latency_ms | нет | Время пинга отслеживается регулярно. Если время пинга хоста больше, чем max_latency_ms, он исключается из пула подключений (хотя сервер остается ONLINE). Если опущено, значение по умолчанию для max_latency_ms в базе данных proxysql — 0. | ||
| max_replication_lag | нет | Если больше 0, ProxySQL будет регулярно отслеживать задержку репликации. Если задержка репликации превышает max_replication_lag, proxysql временно отключает сервер, пока репликация не догонит. Если опущено, значение по умолчанию для max_replication_lag в базе данных proxysql — 0. | ||
| port | нет | 3306 | Порт, по которому можно связаться с экземпляром mysqld. | |
| save_to_disk | нет | True | Сохранить конфигурацию mysql хоста в базу данных sqlite на диске для сохранения конфигурации. | |
| state | нет | present |
| Когда present - добавляет хост, когда absent - удаляет хост. |
| status | нет |
| ONLINE - Сервер бэкенда полностью работоспособен. OFFLINE_SOFT - Когда сервер переводится в OFFLINE_SOFT режим, подключения сохраняются в использовании до завершения текущей транзакции. Это позволяет плавно отсоединить бэкенд. OFFLINE_HARD - Когда сервер переводится в OFFLINE_HARD режим, существующие подключения закрываются, а новые входящие подключения также не принимаются. Если опущено, значение по умолчанию для status в базе данных proxysql — ONLINE. | |
| use_ssl | нет | Если use_ssl установлено в True, подключения к этому серверу будут осуществляться с использованием SSL-подключений. Если опущено, значение по умолчанию для use_ssl в базе данных proxysql — False. | ||
| weight | нет | Чем больше вес сервера по отношению к другим весам, тем выше вероятность выбора сервера из группы хостов. Если опущено, значение по умолчанию для weight в базе данных proxysql — 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 | Измененный или удаленный mysql хост из proxysql | При создании/обновлении вернет измененный хост, при удалении вернет удаленный запрос. | dict | {'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, что означает, что авторы этого модуля гарантируют, что не будут вноситься несовместимые изменения в интерфейс.
Для получения помощи в разработке модулей, если у вас есть такое желание, пожалуйста, прочтите Информация о сообществе и участие, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/proxysql_backend_servers_module.html
