community.proxysql.proxysql_backend_servers модуль – Добавляет или удаляет хосты mysql в интерфейс администрирования proxysql
Примечание
Этот модуль является частью коллекции community.proxysql (версия 1.6.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 string | Текстовое поле, которое может быть использовано для любых целей, определенных пользователем. Может быть описанием того, что хранит хост, напоминанием о том, когда хост был добавлен или отключен, или JSON, обрабатываемым некоторым скриптом проверки. Default: |
compression integer | Если значение compression больше 0, новые соединения с этим сервером будут использовать сжатие. Если параметр опущен, используется значение по умолчанию для compression в базе данных proxysql, равное 0. |
config_file path | Укажите файл конфигурации, из которого будут считываться login_user и login_password. Default: |
hostgroup_id integer | Группа хостов, в которую включен этот экземпляр mysqld. Экземпляр может быть частью одной или нескольких групп хостов. Default: |
hostname string / required | IP-адрес, по которому можно связаться с экземпляром mysqld. |
load_to_runtime boolean | Динамически загрузить конфигурацию в оперативную память. Choices:
|
login_host string | Хост, используемый для подключения к интерфейсу администратора ProxySQL. Default: |
login_password string | Пароль, используемый для аутентификации в интерфейсе администратора ProxySQL. |
login_port integer | Порт, используемый для подключения к интерфейсу администратора ProxySQL. Default: |
login_unix_socket string | Сокет, используемый для подключения к интерфейсу администратора ProxySQL. |
login_user string | Имя пользователя, используемое для аутентификации в интерфейсе администратора ProxySQL. |
max_connections integer | Максимальное количество соединений, которые ProxySQL откроет с этим сервером. Если параметр опущен, используется значение по умолчанию для max_connections в базе данных proxysql, равное 1000. |
max_latency_ms integer | Время ping регулярно отслеживается. Если у хоста время ping больше, чем max_latency_ms, он исключается из пула соединений (хотя сервер остается ONLINE). Если параметр опущен, используется значение по умолчанию для max_latency_ms в базе данных proxysql, равное 0. |
max_replication_lag integer | Если больше 0, ProxySQL будет регулярно отслеживать задержку репликации. Если задержка репликации превысит max_replication_lag, proxysql временно исключит сервер, пока репликация не нагонит. Если параметр опущен, используется значение по умолчанию для max_replication_lag в базе данных proxysql, равное 0. |
port integer | Порт, по которому можно связаться с экземпляром mysqld. Default: |
save_to_disk boolean | Сохранить конфигурацию в sqlite db на диске для сохранения конфигурации. Choices:
|
state string | Когда Choices:
|
status string | ONLINE - Сервер полностью работоспособен. OFFLINE_SOFT - Когда сервер переведен в режим Choices:
|
use_ssl boolean | Если use_ssl установлен в Choices:
|
weight integer | Чем больше вес сервера по отношению к другим весам, тем выше вероятность выбора сервера из группы хостов. Если опущено, значение weight по умолчанию в базе данных proxysql — 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 словарь | Измененный или удаленный из proxysql хост mysql. Возвращаемое значение: При создании/обновлении возвращает новый измененный хост, при удалении — удаленный запис. Пример: |
Ссылки на коллекции
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/proxysql/proxysql_backend_servers_module.html
