community.proxysql.proxysql_mysql_users – Добавляет или удаляет пользователей mysql из интерфейса администрирования proxysql.
Примечание
Этот плагин является частью коллекции community.proxysql (версия 1.0.0).
Для его установки используйте: ansible-galaxy collection install community.proxysql.
Для использования в playbook, укажите: community.proxysql.proxysql_mysql_users.
Обзор
- Модуль community.proxysql.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 строка | Схема, в которую по умолчанию должно переключаться подключение. | |
| encrypt_password логический |
| Зашифровать открытый текст пароля, переданного в параметре password, используя метод, определенный в encryption_method. |
| encryption_method строка |
| Метод шифрования, используемый, когда encrypt_password установлено в True. |
| fast_forward логический |
| Если fast_forward установлено в True, fast_forward пропустит обработку слоя запросов (перезапись, кэширование) и передаст запрос напрямую в сервер бэкенда в первоначальном виде. Если опущено, значение по умолчанию для fast_forward в базе данных proxysql - False. |
| frontend логический |
| Если frontend установлено в True, эта пара (имя пользователя, пароль) используется для аутентификации на серверах mysqld в любой группе хостов. |
| load_to_runtime логический |
| Динамическая загрузка конфигурации в оперативную память. |
| login_host строка | Значение по умолчанию: "127.0.0.1" | Хост, используемый для подключения к интерфейсу администрирования ProxySQL. |
| login_password строка | Пароль, используемый для аутентификации в интерфейсе администрирования ProxySQL. | |
| login_port целое число | Значение по умолчанию: 6032 | Порт, используемый для подключения к интерфейсу администрирования ProxySQL. |
| login_unix_socket строка | Сокет, используемый для подключения к интерфейсу администрирования ProxySQL. | |
| login_user строка | Имя пользователя, используемое для аутентификации в интерфейсе администрирования ProxySQL. | |
| max_connections целое число | Максимальное количество подключений, которые ProxySQL откроет к бэкенду для данного пользователя. Если опущено, значение по умолчанию для max_connections в базе данных proxysql - 10000. | |
| password строка | Пароль пользователя, подключающегося к экземпляру mysqld или ProxySQL. | |
| save_to_disk логический |
| Сохранить конфигурацию в базу данных 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 community.general.proxysql_manage_config
# module). It uses supplied credentials to connect to the proxysql admin
# interface.
- name: Add a user
community.proxysql.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.
- name: Remove a user
community.proxysql.proxysql_mysql_users:
config_file: '~/proxysql.cnf'
username: 'mysqlboy'
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| stdout словарь | При создании/обновлении вернет нового изменённого пользователя, при удалении вернет удалённую запись. | Пользователь 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': 'VALUE_SPECIFIED_IN_NO_LOG_PARAMETER', 'schema_locked': 0, 'transaction_persistent': 0, 'use_ssl': 0, 'username': 'guest_ro'}, 'username': 'guest_ro'} |
Авторы
- Ben Mildren (@bmildren)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/proxysql/proxysql_mysql_users_module.html
