Модуль community.proxysql.proxysql_pgsql_users — добавляет пользователей PostgreSQL в интерфейс администрирования ProxySQL или удаляет их

Примечание

Этот модуль входит в коллекцию community.proxysql (версия 1.8.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.proxysql. Для использования этого модуля также требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.proxysql.proxysql_pgsql_users.

Добавлено в community.proxysql 1.8.0

Краткое описание
Требования
Параметры
Атрибуты
Примеры
Возвращаемые значения

Краткое описание

Модуль community.proxysql.proxysql_pgsql_users добавляет пользователей PostgreSQL с помощью интерфейса администрирования ProxySQL или удаляет их.

Требования

Следующие компоненты должны быть установлены на узле, на котором выполняется этот модуль.

PyMySQL
mysqlclient

Параметры

Параметр	Комментарии
active boolean	Пользователь, для которого active задано как `False`, будет сохранён в базе данных, но никогда не будет загружен в структуры данных в памяти. Если значение не указано, по умолчанию для active в базе данных ProxySQL используется `True`. Варианты: `false` `true`
backend boolean	Если для backend задано значение `True`, эта пара (имя пользователя, пароль) используется для аутентификации в экземпляре ProxySQL. Варианты: `false` `true` ← (по умолчанию)
config_file path	Укажите файл конфигурации, из которого следует считывать значения login_user и login_password. По умолчанию: `""`
default_hostgroup integer	Если для запросов, отправленных этим пользователем, не найдено соответствующее правило, генерируемый им трафик направляется в указанную группу хостов. Если значение не указано, по умолчанию для default_hostgroup в базе данных ProxySQL используется 0.
fast_forward boolean	Если для fast_forward задано значение `True`, запросы будут обходить уровень обработки запросов (перезапись, кэширование) и передаваться на сервер backend напрямую, без изменений. Если значение не указано, по умолчанию для fast_forward в базе данных ProxySQL используется `False`. Варианты: `false` `true`
frontend boolean	Если для frontend задано значение `True`, эта пара (имя пользователя, пароль) используется для аутентификации на серверах PostgreSQL в любой группе хостов. Варианты: `false` `true` ← (по умолчанию)
load_to_runtime boolean	Динамически загружать конфигурацию в память среды выполнения. Варианты: `false` `true` ← (по умолчанию)
login_host string	Узел для подключения к интерфейсу администрирования ProxySQL. По умолчанию: `"127.0.0.1"`
login_password string	Пароль для аутентификации в интерфейсе администрирования ProxySQL.
login_port integer	Порт для подключения к интерфейсу администрирования ProxySQL. По умолчанию: `6032`
login_unix_socket string	Сокет для подключения к интерфейсу администрирования ProxySQL.
login_user string	Имя пользователя для аутентификации в интерфейсе администрирования ProxySQL.
max_connections integer	Максимальное количество соединений, которые ProxySQL откроет с сервером backend для этого пользователя. Если значение не указано, по умолчанию для max_connections в базе данных ProxySQL используется 10000.
password string	Пароль пользователя, подключающегося к экземпляру PostgreSQL или ProxySQL.
save_to_disk boolean	Сохранить конфигурацию в базе данных SQLite на диске для её сохранения между запусками. Варианты: `false` `true` ← (по умолчанию)
state string	Если задано `present` — добавляет пользователя; если `absent` — удаляет пользователя. Варианты: `"present"` ← (по умолчанию) `"absent"`
transaction_persistent boolean	Если этот параметр задан для пользователя, с которым клиент PostgreSQL подключается к ProxySQL (то есть пользователя «frontend»), транзакции, начатые в группе хостов, останутся в этой группе независимо от других правил. Если значение не указано, по умолчанию для transaction_persistent в базе данных ProxySQL используется `True`. Варианты: `false` `true`
use_ssl boolean	Если для use_ssl задано значение `True`, соединения этого пользователя будут использовать SSL. Если значение не указано, по умолчанию для use_ssl в базе данных ProxySQL используется `False`. Варианты: `false` `true`
username string / обязательный	Имя пользователя, подключающегося к экземпляру PostgreSQL или ProxySQL.

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Не вносить изменения в память, на диск или в среду выполнения.

Примеры

---
# This example adds a user, it saves the postgresql user config to disk, but
# avoids loading the postgresql user config to runtime (this might be because
# several users 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 user
  community.proxysql.proxysql_pgsql_users:
    login_user: 'admin'
    login_password: 'admin'
    username: 'productiondba'
    state: present
    load_to_runtime: false

# This example removes a user, saves the postgresql user config to disk, and
# dynamically loads the postgresql user config to runtime.  It uses credentials
# in a supplied config file to connect to the proxysql admin interface.

- name: Remove a user
  community.proxysql.proxysql_pgsql_users:
    config_file: '~/proxysql.cnf'
    username: 'postgresboy'
    state: absent

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
stdout dictionary	Пользователь PostgreSQL, изменённый или удалённый из ProxySQL. Возвращается: При создании или обновлении возвращает изменённого пользователя; при удалении — удалённую запись. Пример: `{"changed": true, "msg": "Added user to pgsql_users", "state": "present", "user": {"active": 1, "backend": 1, "default_hostgroup": 1, "fast_forward": 0, "frontend": 1, "max_connections": 10000, "password": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER", "transaction_persistent": 0, "use_ssl": 0, "username": "guest_ro"}, "username": "guest_ro"}`

Ключ

Описание

stdout

dictionary

Пользователь PostgreSQL, изменённый или удалённый из ProxySQL.

Возвращается: При создании или обновлении возвращает изменённого пользователя; при удалении — удалённую запись.

Пример: {"changed": true, "msg": "Added user to pgsql_users", "state": "present", "user": {"active": 1, "backend": 1, "default_hostgroup": 1, "fast_forward": 0, "frontend": 1, "max_connections": 10000, "password": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER", "transaction_persistent": 0, "use_ssl": 0, "username": "guest_ro"}, "username": "guest_ro"}

Авторы

Janos Ruszo (@jruszo)

Ссылки на коллекцию

© 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_users_module.html