ansible.mysql.mysql_resource_group module – Add, update, or remove MySQL resource groups

Note

This module is part of the ansible.mysql collection (version 5.2.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install ansible.mysql. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: ansible.mysql.mysql_resource_group.

New in ansible.mysql 5.1.0

Synopsis

  • Add, update, or remove MySQL resource groups.

  • Resource groups are supported by MySQL 8.0 or later.

Requirements

The below requirements are needed on the host that executes this module.

  • PyMySQL (Python 2.7 and Python 3.x)

Parameters

Parameter

Comments

ca_cert

aliases: ssl_ca

path

The path to a Certificate Authority (CA) certificate. This option, if used, must specify the same certificate as used by the server.

check_hostname

boolean

added in ansible.mysql 1.1.0

Whether to validate the server host name when an SSL connection is required. Corresponds to MySQL CLIs --ssl switch.

Setting this to false disables hostname verification. Use with caution.

Requires pymysql >= 0.7.11.

Choices:

  • false

  • true

client_cert

aliases: ssl_cert

path

The path to a client public key certificate.

client_key

aliases: ssl_key

path

The path to the client private key.

config_file

path

Specify a config file from which user and password are to be read.

The default config file, ~/.my.cnf, if it exists, will be read, even if config_file is not specified.

The default config file, ~/.my.cnf, if it exists, must contain a [client] section as a MySQL connector requirement.

To prevent the default config file from being read, set config_file to be an empty string.

Default: "~/.my.cnf"

connect_timeout

integer

The connection timeout when connecting to the MySQL server.

Default: 30

enabled

boolean

Whether the resource group should be enabled.

When omitted for an existing resource group, the current value is left unchanged.

Choices:

  • false

  • true

force

boolean

If true, use FORCE when dropping a resource group.

This only applies when state=absent.

Choices:

  • false ← (default)

  • true

login_host

string

Host running the database.

In some cases for local connections the login_unix_socket=/path/to/mysqld/socket, that is usually /var/run/mysqld/mysqld.sock, needs to be used instead of login_host=localhost.

Default: "localhost"

login_password

string

The password used to authenticate with.

login_port

integer

Port of the MySQL server. Requires login_host be defined as other than localhost if login_port is used.

Default: 3306

login_unix_socket

string

The path to a Unix domain socket for local connections.

Use this parameter to avoid the Please explicitly state intended protocol error.

login_user

string

The username used to authenticate with.

name

string / required

Name of the resource group to manage.

resource_group_type

string

Resource group type.

Required when creating a new resource group.

The value is immutable after creation.

Choices:

  • "SYSTEM"

  • "USER"

state

string

If present, creates the resource group when it does not exist.

If present, updates mutable attributes when the resource group already exists.

If absent, removes the resource group.

Choices:

  • "absent"

  • "present" ← (default)

thread_priority

integer

Thread priority to set for the resource group.

Must be between -20 and 0 for SYSTEM resource groups.

Must be between 0 and 19 for USER resource groups.

When omitted for an existing resource group, the current value is left unchanged.

vcpu_ids

string

CPU affinity in native MySQL syntax.

Examples include 0-3 and 0-3,8,10-12.

When omitted for an existing resource group, the current value is left unchanged.

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying target.

idempotent

Support: full

When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.

This assumes that the system controlled/queried by the module has not changed in a relevant way.

Notes

Note

  • This module supports MySQL 8.0 or later only.

  • Resource groups are not available on MariaDB.

  • MySQL documents resource groups as unavailable when the thread pool plugin is installed.

  • Thread-priority behavior can depend on server platform and operating-system capabilities.

  • Requires the PyMySQL (Python 2.7 and Python 3.X) package installed on the remote host. The Python package may be installed with apt-get install python-pymysql (Ubuntu; see ansible.builtin.apt) or yum install python2-PyMySQL (RHEL/CentOS/Fedora; see ansible.builtin.yum). You can also use dnf install python2-PyMySQL for newer versions of Fedora; see ansible.builtin.dnf.

  • Be sure you have PyMySQL library installed on the target machine for the Python interpreter Ansible discovers. For example if ansible discovers and uses Python 3, you need to install the Python 3 version of PyMySQL. If ansible discovers and uses Python 2, you need to install the Python 2 version of PyMySQL.

  • If you have trouble, it may help to force Ansible to use the Python interpreter you need by specifying ansible_python_interpreter. For more information, see https://docs.ansible.com/ansible/latest/reference_appendices/interpreter_discovery.html.

  • Both login_password and login_user are required when you are passing credentials. If none are present, the module will attempt to read the credentials from ~/.my.cnf, and finally fall back to using the MySQL default login of ‘root’ with no password.

  • If there are problems with local connections, using login_unix_socket=/path/to/mysqld/socket instead of login_host=localhost might help. As an example, the default MariaDB installation of version 10.4 and later uses the unix_socket authentication plugin by default that without using login_unix_socket=/var/run/mysqld/mysqld.sock (the default path) causes the error ``Host ‘127.0.0.1’ is not allowed to connect to this MariaDB server``.

  • If credentials from the config file (for example, /root/.my.cnf) are not needed to connect to a database server, but the file exists and does not contain a [client] section, before any other valid directives, it will be read and this will cause the connection to fail, to prevent this set it to an empty string, (for example config_file: '').

  • To avoid the Please explicitly state intended protocol error, use the login_unix_socket argument, for example, login_unix_socket: /run/mysqld/mysqld.sock.

  • Alternatively, to avoid using login_unix_socket argument on each invocation you can specify the socket path using the `socket` option in your MySQL config file (usually ~/.my.cnf) on the destination host, for example socket=/var/lib/mysql/mysql.sock.

See Also

See also

ansible.mysql.mysql_resource_group_info

Gather information about MySQL resource groups.

MySQL CREATE RESOURCE GROUP reference

Complete reference of the CREATE RESOURCE GROUP command documentation.

MySQL ALTER RESOURCE GROUP reference

Complete reference of the ALTER RESOURCE GROUP command documentation.

MySQL DROP RESOURCE GROUP reference

Complete reference of the DROP RESOURCE GROUP command documentation.

Examples

# If you encounter the "Please explicitly state intended protocol" error,
# use the login_unix_socket argument
- name: Create a reporting resource group
  ansible.mysql.mysql_resource_group:
    name: reporting
    resource_group_type: USER
    vcpu_ids: 4-7
    thread_priority: 5
    enabled: true
    login_unix_socket: /run/mysqld/mysqld.sock

- name: Disable a resource group
  ansible.mysql.mysql_resource_group:
    name: reporting
    state: present
    enabled: false

- name: Drop a resource group and reassign running threads
  ansible.mysql.mysql_resource_group:
    name: reporting
    state: absent
    force: true

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

queries

list / elements=string

List of executed queries.

Returned: when changed

Sample: ["CREATE RESOURCE GROUP `reporting` TYPE = USER VCPU = 4-7 THREAD_PRIORITY = 5 ENABLE"]

resource_group

dictionary

Normalized representation of the resource group after module execution.

Returned: when state=present

enabled

boolean

Whether the resource group is enabled.

Returned: success

Sample: true

name

string

Resource group name.

Returned: success

Sample: "reporting"

resource_group_type

string

Resource group type.

Returned: success

Sample: "USER"

thread_priority

integer

Resource-group thread priority.

Returned: success

Sample: 5

vcpu_ids

string

Normalized CPU affinity.

Returned: success

Sample: "4-7"

Authors

  • Ron Gershburg (@ronger4)