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 bool |
| Динамическая загрузка конфигурации в оперативную память. |
| login_host | По умолчанию: "127.0.0.1" | Хост, используемый для подключения к админ-интерфейсу ProxySQL. |
| login_password | Пароль, используемый для аутентификации в админ-интерфейсе ProxySQL. | |
| login_port | По умолчанию: 6032 | Порт, используемый для подключения к админ-интерфейсу ProxySQL. |
| login_user | Имя пользователя, используемое для аутентификации в админ-интерфейсе ProxySQL. | |
| max_connections | Максимальное количество подключений, которые ProxySQL откроет для этого пользователя к бэкенду. Если параметр опущен, значение max_connections по умолчанию в базе данных ProxySQL — 10000. | |
| password | Пароль пользователя, подключающегося к экземпляру mysqld или ProxySQL. | |
| save_to_disk bool |
| Сохранение конфигурации в базу данных sqlite на диске для сохранения настроек. |
| state |
| При значении present — добавляет пользователя, при значении absent — удаляет пользователя. |
| transaction_persistent | Если этот параметр задан для пользователя, с которым клиент MySQL подключается к ProxySQL (то есть для «фронтового» пользователя), транзакции, начатые в группе хостов, останутся в рамках этой группы хостов независимо от других правил. Если параметр опущен, значение 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 dict | При создании/изменении вернёт обновлённого пользователя, при удалении — удалённую запись. | Пользователь MySQL, изменённый или удалённый из ProxySQL Пример: {'changed': True, 'msg': 'Пользователь добавлен в mysql_users', 'state': 'present', 'user': {'active': 1, 'backend': 1, 'default_hostgroup': 1, 'default_schema': None, 'fast_forward': 0, 'frontend': 1, 'max_connections': 10000, 'password': 'ЗНАЧЕНИЕ_УКАЗАНО_В_ПАРАМЕТРЕ_БЕЗ_ЛОГИРОВАНИЯ', 'schema_locked': 0, 'transaction_persistent': 0, 'use_ssl': 0, 'username': 'guest_ro'}, 'username': 'guest_ro'} |
Статус
Этот модуль помечен как 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_mysql_users_module.html
