proxysql_mysql_users — Добавление или удаление пользователей MySQL в админском интерфейсе ProxySQL.
Новая версия с 2.3.
Описание
- Модуль proxysql_mysql_users добавляет или удаляет пользователей MySQL, используя админский интерфейс ProxySQL.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- PyMySQL (Python 2.7 и Python 3.X), или
- MySQLdb (Python 2.x)
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| active | Пользователь с active, установленным в False, будет отслеживаться в базе данных, но никогда не загружаться в кэшируемые структуры данных. Если опущено, значение по умолчанию для active в базе данных ProxySQL равно True. | |
| backend | По умолчанию: да | Если backend установлено в True, эта пара (имя пользователя, пароль) используется для аутентификации в экземпляре ProxySQL. |
| config_file | По умолчанию: | Укажите файл конфигурации, из которого необходимо считать login_user и login_password. |
| default_hostgroup | Если для запросов, отправленных этим пользователем, нет соответствующего правила, трафик, который он генерирует, отправляется в указанную группу хостов. Если опущено, значение по умолчанию для use_ssl в базе данных ProxySQL равно 0. | |
| default_schema | Схема, в которую по умолчанию должна быть изменена связь. | |
| fast_forward | Если fast_forward установлено в True, fast_forward пропустит слой обработки запросов (переписывание, кэширование) и передаст запрос напрямую на сервер базы данных без изменений. Если опущено, значение по умолчанию для fast_forward в базе данных ProxySQL равно False. | |
| frontend | По умолчанию: да | Если frontend установлено в True, эта пара (имя пользователя, пароль) используется для аутентификации на серверах MySQL в любой группе хостов. |
| load_to_runtime |
| Динамическая загрузка конфигурации в оперативную память. |
| 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 равно 10000. | |
| password | Пароль пользователя, подключающегося к экземпляру mysqld или ProxySQL. | |
| save_to_disk |
| Сохранение конфигурации в базе данных SQLite на диске для сохранения настроек. |
| state |
| При значении present, добавляется пользователь; при значении absent, удаляется пользователь. |
| transaction_persistent | Если это установлено для пользователя, подключающегося к ProxySQL с помощью MySQL-клиента (т. е. для «переднего» пользователя), транзакции, начатые в группе хостов, останутся в рамках этой группы хостов независимо от других правил. Если опущено, значение по умолчанию для transaction_persistent в базе данных ProxySQL равно False. | |
| use_ssl | Если use_ssl установлено в True, соединения, выполняемые этим пользователем, будут осуществляться с использованием SSL-соединений. Если опущено, значение по умолчанию для use_ssl в базе данных ProxySQL равно False. | |
| username необходимо | Имя пользователя, подключающегося к экземпляру mysqld или ProxySQL. |
Примеры
---
# This example adds a user, it saves the mysql user config to disk, but
# avoids loading the mysql 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 M(proxysql_manage_config) module). It
# uses supplied credentials to connect to the proxysql admin interface.
- proxysql_mysql_users:
login_user: 'admin'
login_password: 'admin'
username: 'productiondba'
state: present
load_to_runtime: False
# This example removes a user, saves the mysql user config to disk, and
# dynamically loads the mysql user config to runtime. It uses credentials
# in a supplied config file to connect to the proxysql admin interface.
- proxysql_mysql_users:
config_file: '~/proxysql.cnf'
username: 'mysqlboy'
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны в этом разделе. Ниже перечислены поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| stdout словарь | При создании/обновлении возвращает вновь изменённого пользователя; при удалении — удалённую запись. | Пользователь MySQL, изменённый или удалённый из ProxySQL Пример: {'msg': 'Пользователь добавлен в mysql_users', 'username': 'guest_ro', 'state': 'present', 'changed': True, 'user': {'default_hostgroup': 1, 'username': 'guest_ro', 'frontend': 1, 'default_schema': None, 'transaction_persistent': 0, 'schema_locked': 0, 'backend': 1, 'fast_forward': 0, 'active': 1, 'use_ssl': 0, 'password': 'VALUE_SPECIFIED_IN_NO_LOG_PARAMETER', 'max_connections': 10000}} |
Статус
Этот модуль помечен как stableinterface, что означает, что авторы гарантируют отсутствие несовместимых изменений интерфейса.
Автор
- 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.5/modules/proxysql_mysql_users_module.html
