community.proxysql.proxysql_mysql_users – Добавляет или удаляет пользователей mysql в интерфейсе администрирования proxysql.

Примечание

Этот плагин входит в коллекцию community.proxysql (версия 1.0.0).

Для его установки используйте: ansible-galaxy collection install community.proxysql.

Для использования в книге задач укажите: community.proxysql.proxysql_mysql_users.

Обзор
Требования
Параметры
Примеры
Возвращаемые значения

Обзор

Модуль community.proxysql.proxysql_mysql_users добавляет или удаляет пользователей mysql с использованием интерфейса администрирования proxysql.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

PyMySQL (Python 2.7 и Python 3.X), или
MySQLdb (Python 2.x)

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
active boolean	Варианты: no yes	Пользователь с active, установленным в `False`, будет отслеживаться в базе данных, но никогда не будет загружаться в структуры данных в памяти. Если опущено, значение по умолчанию для active в базе данных proxysql равно `True`.
backend boolean	Варианты: no yes ←	Если backend установлено в `True`, эта пара (имя пользователя, пароль) используется для аутентификации в экземпляре ProxySQL.
config_file path	По умолчанию: ""	Укажите файл конфигурации, из которого следует читать login_user и login_password.
default_hostgroup integer		Если для запросов этого пользователя нет соответствующего правила, трафик, который он генерирует, отправляется в указанную группу хостов. Если опущено, значение по умолчанию для use_ssl в базе данных proxysql равно 0.
default_schema string		Схема, в которую по умолчанию должна переключаться связь.
encrypt_password boolean	Варианты: no ← yes	Зашифровать открытый текст пароля, переданный в параметре password, используя метод, определённый в encryption_method.
encryption_method string	Варианты: mysql_native_password ←	Метод шифрования, используемый, когда encrypt_password установлено в `True`.
fast_forward boolean	Варианты: no yes	Если fast_forward установлено в `True`, fast_forward будет пропускать уровень обработки запросов (переписывание, кэширование) и передавать запрос непосредственно на сервер бэкенда в исходном виде. Если опущено, значение по умолчанию для fast_forward в базе данных proxysql равно `False`.
frontend boolean	Варианты: no yes ←	Если frontend установлено в `True`, эта пара (имя пользователя, пароль) используется для аутентификации на серверах mysqld для любой группы хостов.
load_to_runtime boolean	Варианты: no yes ←	Динамическая загрузка конфигурации в оперативную память.
login_host string	По умолчанию: "127.0.0.1"	Хост, используемый для подключения к интерфейсу администрирования ProxySQL.
login_password string		Пароль, используемый для аутентификации в интерфейсе администрирования ProxySQL.
login_port integer	По умолчанию: 6032	Порт, используемый для подключения к интерфейсу администрирования ProxySQL.
login_unix_socket string		Сокет, используемый для подключения к интерфейсу администрирования ProxySQL.
login_user string		Имя пользователя, используемое для аутентификации в интерфейсе администрирования ProxySQL.
max_connections integer		Максимальное количество подключений, которые ProxySQL откроет к бэкенду для этого пользователя. Если опущено, значение по умолчанию для max_connections в базе данных proxysql равно 10000.
password string		Пароль пользователя, подключающегося к экземпляру mysqld или ProxySQL.
save_to_disk boolean	Варианты: no yes ←	Сохранить конфигурацию в базе данных sqlite на диске для сохранения конфигурации.
state string	Варианты: present ← absent	При значении `present`, добавляет пользователя; при значении `absent`, удаляет пользователя.
transaction_persistent boolean	Варианты: no yes	Если это значение установлено для пользователя, с которым клиент MySQL подключается к ProxySQL (следовательно, «пользователь frontend»), транзакции, начатые в группе хостов, останутся в этой группе хостов независимо от других правил. Если опущено, значение по умолчанию для transaction_persistent в базе данных proxysql равно `False`.
use_ssl boolean	Варианты: no yes	Если use_ssl установлено в `True`, подключения этого пользователя будут осуществляться с использованием SSL-подключений. Если опущено, значение по умолчанию для use_ssl в базе данных proxysql равно `False`.
username string / required		Имя пользователя, подключающегося к экземпляру 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 dictionary	При создании/обновлении возвращает изменённого пользователя, при удалении — удалённую запись.	Пользователь 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'}

Авторы

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.10/collections/community/proxysql/proxysql_mysql_users_module.html