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 bool |
| Динамическая загрузка конфигурации в оперативную память. |
| login_host | По умолчанию: "127.0.0.1" | Хост, используемый для подключения к админ-интерфейсу ProxySQL. |
| login_password | Пароль, используемый для аутентификации в админ-интерфейсе ProxySQL. | |
| login_port | По умолчанию: 6032 | Порт, используемый для подключения к админ-интерфейсу ProxySQL. |
| login_user | Имя пользователя, используемое для аутентификации в админ-интерфейсе ProxySQL. | |
| max_connections | Максимальное количество подключений, которые ProxySQL откроет к этому серверу бэкенда. Если опущено, по умолчанию в базе данных proxysql для max_connections установлено значение 1000. | |
| max_latency_ms | Время пинга отслеживается регулярно. Если время пинга хоста превышает max_latency_ms, он исключается из пула подключений (хотя сервер остаётся ONLINE). Если опущено, по умолчанию в базе данных proxysql для max_latency_ms установлено значение 0. | |
| max_replication_lag | Если больше 0, ProxySQL будет регулярно отслеживать задержку репликации. Если задержка репликации превысит max_replication_lag, proxysql временно отключает сервер, пока репликация не догонит. Если опущено, по умолчанию в базе данных proxysql для max_replication_lag установлено значение 0. | |
| port | По умолчанию: 3306 | Порт, по которому можно связаться с экземпляром mysqld. |
| save_to_disk bool |
| Сохранение конфигурации в базу данных 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 | При создании/обновлении возвращает недавно изменённый хост, при удалении возвращает удалённую запись. | Изменённый или удалённый из proxysql хост mysql Пример: {'changed': True, 'hostname': '192.168.52.1', 'msg': 'Добавлен сервер в mysql_hosts', 'server': {'comment': '', 'compression': '0', 'hostgroup_id': '1', 'hostname': '192.168.52.1', 'max_connections': '1000', 'max_latency_ms': '0', 'max_replication_lag': '0', 'port': '3306', 'status': 'ONLINE', 'use_ssl': '0', 'weight': '1'}, 'state': 'present'} |
Статус
Этот модуль помечен как stableinterface, что означает, что разработчики этого модуля гарантируют, что не будут вноситься несовместимые изменения в интерфейс.
Техническое обслуживание
Этот модуль помечен как community, что означает, что он поддерживается сообществом Ansible. Дополнительную информацию см. в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- 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.6/modules/proxysql_backend_servers_module.html
