Модуль community.proxysql.proxysql_pgsql_servers – добавляет или удаляет узлы pgsql через интерфейс администрирования proxysql
Примечание
Этот модуль входит в коллекцию community.proxysql (версия 1.8.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.proxysql. Для работы с этим модулем требуются дополнительные компоненты. Подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: community.proxysql.proxysql_pgsql_servers.
Добавлено в community.proxysql 1.8.0
Краткое описание
- Модуль community.proxysql.proxysql_pgsql_servers добавляет или удаляет узлы pgsql с помощью интерфейса администрирования proxysql.
Требования
На узле, где выполняется этот модуль, необходимы следующие компоненты.
- PyMySQL
- mysqlclient
Параметры
Параметр | Комментарии |
|---|---|
comment string | Текстовое поле, которое пользователь может использовать для любых целей. В нём может содержаться описание хранимых на узле данных, напоминание о том, когда узел был добавлен или отключён, или JSON, обрабатываемый скриптом проверки. По умолчанию: |
compression integer | Если для compression задано значение |
config_file path | Укажите файл конфигурации, из которого следует прочитать значения login_user и login_password. По умолчанию: |
hostgroup_id integer | Группа узлов, в которую входит этот экземпляр PostgreSQL. Экземпляр может входить в одну или несколько групп узлов. По умолчанию: |
hostname string / обязательный | Имя узла или IP-адрес, по которому доступен экземпляр PostgreSQL. |
load_to_runtime boolean | Динамически загрузить конфигурацию в память среды выполнения. Варианты:
|
login_host string | Узел для подключения к интерфейсу администрирования ProxySQL. По умолчанию: |
login_password string | Пароль для аутентификации в интерфейсе администрирования ProxySQL. |
login_port integer | Порт для подключения к интерфейсу администрирования ProxySQL. По умолчанию: |
login_unix_socket string | Сокет для подключения к интерфейсу администрирования ProxySQL. |
login_user string | Имя пользователя для аутентификации в интерфейсе администрирования ProxySQL. |
max_connections integer | Максимальное количество подключений, которые ProxySQL откроет к этому серверу backend. Если параметр не задан, по умолчанию в базе данных proxysql для max_connections используется значение 1000. |
max_latency_ms integer | Время отклика на ping регулярно отслеживается. Если время отклика узла превышает max_latency_ms, узел исключается из пула подключений (при этом сервер остаётся в состоянии ONLINE). Если параметр не задан, по умолчанию в базе данных proxysql для max_latency_ms используется значение 0. |
max_replication_lag integer | Если значение больше 0, ProxySQL будет регулярно отслеживать задержку репликации. Если задержка репликации превысит max_replication_lag, proxysql временно исключит сервер из обслуживания, пока репликация не наверстает отставание. Если параметр не задан, по умолчанию в базе данных proxysql для max_replication_lag используется значение 0. |
port integer | Порт, по которому доступен экземпляр PostgreSQL. По умолчанию: |
save_to_disk boolean | Сохранить конфигурацию в базе данных sqlite на диске, чтобы она сохранилась после перезапуска. Варианты:
|
state string | Если задано значение Варианты:
|
status string | ONLINE — сервер backend полностью работоспособен. SHUNNED — сервер временно выведен из эксплуатации из-за слишком большого количества ошибок подключения за короткое время или превышения допустимого порога задержки репликации. OFFLINE_SOFT — при переводе сервера в режим Варианты:
|
use_ssl boolean | Если для use_ssl задано значение Варианты:
|
weight integer | Чем выше вес сервера относительно весов других серверов, тем выше вероятность выбора этого сервера из группы узлов. Если параметр не задан, по умолчанию в базе данных proxysql для weight используется значение 1. |
Атрибуты
Атрибут | Поддержка | Описание |
|---|---|---|
check_mode | Поддержка: полная | Не вносить изменения в память, на диск или в среду выполнения. |
Примеры
---
# This example adds a server, it saves the pgsql server config to disk, but
# avoids loading the pgsql 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.proxysql.proxysql_manage_config
# module). It uses supplied credentials to connect to the proxysql admin
# interface.
- name: Add a server
community.proxysql.proxysql_pgsql_servers:
login_user: 'admin'
login_password: 'admin'
hostname: 'pgsql01'
state: present
load_to_runtime: false
# This example removes a server, saves the pgsql server config to disk, and
# dynamically loads the pgsql 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_pgsql_servers:
config_file: '~/proxysql.cnf'
hostname: 'pgsql02'
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь. Ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
stdout dictionary | Узел pgsql, изменённый или удалённый из 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_pgsql_servers_module.html
