Spec-Zone.ru › Ansible

Модуль community.proxysql.proxysql_mysql_hostgroup_attributes — управление атрибутами группы хостов с помощью интерфейса администрирования ProxySQL

Примечание

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

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

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

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

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

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

Обзор

  • Каждая строка в mysql_hostgroup_attributes задаёт переопределение для конкретной группы хостов. Эта дополнительная таблица позволяет задавать конфигурацию для отдельных групп хостов, например `max_num_online_servers`, изменяя поведение соответствующей группы способами, которые иначе недоступны.

Требования

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

  • PyMySQL
  • mysqlclient

Параметры

Параметр

Комментарии

autocommit

integer

Пока не реализовано (согласно документации ProxySQL).

По умолчанию: -1

comment

string

Текстовое поле, которое пользователь может использовать для любых целей.

По умолчанию: ""

config_file

path

Укажите файл конфигурации, из которого будут прочитаны login_user и login_password.

По умолчанию: ""

connection_warming

integer

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

По умолчанию: 0

free_connections_pct

integer

Процент открытых неактивных соединений для каждого сервера в группе хостов.

По умолчанию: 10

hostgroup_id

integer / обязательный

Идентификатор группы хостов

hostgroup_settings

string

Переопределение некоторых глобальных настроек.

По умолчанию: ""

ignore_session_variables

string

Пока не реализовано (согласно документации ProxySQL).

По умолчанию: ""

init_connect

string

Разделённая точками с запятой строка SQL-операторов, которые выполняются при инициализации каждого соединения с сервером базы данных.

По умолчанию: ""

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_num_online_servers

integer

Запрещает новые соединения, если количество серверов со статусом ONLINE в группе хостов превышает это значение.

По умолчанию: 1000000

multiplex

integer

Включает или отключает мультиплексирование для указанной группы хостов.

По умолчанию: 1

save_to_disk

boolean

Сохранить конфигурацию в базе данных sqlite на диске, чтобы она сохранялась между запусками.

Варианты:

  • false
  • true ← (по умолчанию)

servers_defaults

string

Задать значения по умолчанию для обнаруженных серверов.

По умолчанию: ""

state

string

Если указано present — добавляет атрибуты группы хостов; если указано absent — удаляет атрибуты группы хостов.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

throttle_connections_per_sec

integer

Максимальное количество новых соединений, которые можно открыть за секунду.

По умолчанию: 1000000

Атрибуты

Атрибут

Поддержка

Описание

check_mode

Поддержка: полная

Не вносить изменения в память, на диск или в среду выполнения.

Примеры

# This example uses supplied credentials to add a hostgroup override for the
# hostgroup with ID, `1`. The override sets the maximum number of ONLINE
# servers to `1` and provides a short comment. The configuration will be saved
# to disk and memory, but not loaded into runtime.

- name: Add hostgroup overrides to limit servers
  community.proxysql.proxysql_mysql_hostgroup_overrides:
    login_user: admin
    login_password: admin
    hostgroup_id: 1
    state: present
    load_to_runtime: false
    max_num_online_servers: 1
    comment: >-
      Limit connections to the writer hostgroup to prevent split-brains.

# This example uses stored configuration to manage a hostgroup override for the
# hostgroup with ID, `2`. The override limits the number of new connections
# that can be opened to 100/sec. The configuration will be saved to memory and
# runtime but not persisted to disk.

- name: Throttle connections on reader hostgroup
  community.proxysql.proxysql_mysql_hostgroup_overrides:
    config_file: /etc/proxysql/admin.cnf
    hostgroup_id: 2
    state: present
    load_to_runtime: true
    save_to_disk: false
    throttle_connections_per_sec: 100

# This example uses supplied credentials to add a hostgroup override for the
# hostgroup with ID, `2`. The override enables multiplexing and sets the number
# of cached connections to 100%. The configuration will be saved to memory but
# not disk or runtime.

- name: Aggressively reuse and cache connections
  community.proxysql.proxysql_mysql_hostgroup_overrides:
    login_user: admin
    login_password: admin
    hostgroup_id: 2
    load_to_runtime: false
    save_to_disk: false
    multiplex: 1
    free_connections_pct: 100

# This example uses stored configuration to manage a hostgroup override for the
# hostgroup with ID, `42`. The override changes the hostgroup to handle
# warnings and each server added into the hostgroup to have 1000 connections.

- name: Override globals for hostgroup 42
  community.proxysql.proxysql_mysql_hostgroup_overrides:
    config_file: /etc/proxysql/admin.cnf
    hostgroup_id: 42
    hostgroup_settings: >-
      {
        "handle_warnings": 1
      }
    server_settings: >-
      {
        "max_connections": 1000
      }

# This example removes a hostgroup override using the credentials supplied in
# a configuration file.

- name: Remove hostgroup overrides
  community.proxysql.proxysql_mysql_hostgroup_attributes:
    config_file: '~/proxysql.cnf'
    hostgroup_id: 3
    state: absent

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

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

Ключ

Описание

stdout

dictionary

Изменённая или удалённая из ProxySQL запись mysql_hostgroup_override.

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

Пример: {"changed": true, "msg": "Added server to mysql_hostgroup_overrides", "mysql_hostgroup_attributes": {"autocommit": "-1", "comment": "", "connection_warming": "0", "free_connections_pct": "10", "hostgroup_id": "21", "hostgroup_settings": "", "ignore_session_variables": "", "init_connect": "", "max_num_online_servers": "1000000", "multiplex": "1", "servers_defaults": "", "throttle_connections_per_sec": "1000000"}, "state": "present"}

Авторы

  • Richard Burnison (@burnison)

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

  • Отслеживание ошибок
  • Репозиторий (исходный код)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API