Ansible role `mariadb`

An Ansible role for managing MariaDB in RedHat-based distributions. Specifically, the responsibilities of this role are to:

Install MariaDB packages from the official MariaDB repositories
Remove unsafe defaults:
- set database root password (remark that once set, this role is unable to change the database root password)
- remove anonymous users
- remove test database
Create users and databases
Manage configuration files network.cnf, and server.cnf

This role only supports InnoDB as storage engine.

If you like/use this role, please consider giving it a star! Thank you!

Requirements

No specific requirements

Role Variables

None of the variables below are required. When not defined by the user, the default values are used.

Basic configuration

Variable	Default	Comments
`mariadb_bind_address`	'127.0.0.1'	Set this to the IP address of the network interface to listen on, or '0.0.0.0' to listen on all interfaces.
`mariadb_configure_swappiness`	true	When `true`, this role will set the "swappiness" value.
`mariadb_custom_cnf`	{}	Dictionary with custom configuration.
`mariadb_databases`	[]	List of dicts specifyint the databases to be added. See below for details.
`mariadb_init_scripts`	[]	List of dicts specifying any scripts to initialise the databases. Se below for details. ta
`mariadb_mirror`	yum.mariadb.org	Download mirror for the .rpm package (1)
`mariadb_port`	3306	The port number used to listen to client requests
`mariadb_root_password`	''	The MariaDB root password. It is highly recommended to change this!
`mariadb_service`	mariadb	Name of the service (should e.g. be 'mysql' on CentOS for MariaDB 5.5)
`mariadb_swappiness`	0	"Swappiness" value. System default is 60. A value of 0 means that swapping out processes is avoided.
`mariadb_users`	[]	List of dicts specifying the users to be added. See below for details.
`mariadb_version`	'10.3'	The version of MariaDB to be installed. Default is the current stable release.

(1) Installing MariaDB from the default yum repository can be very slow (e.g. >10 minutes). The variable mariadb_mirror allows you to specify a custom download mirror closer to your geographical location that may speed up the installation process. E.g.:

mariadb_mirror: 'mariadb.mirror.nucleus.be/yum'

Server configuration

This role supports setting several variables in /etc/my.cnf.d/server.cnf, specifically in the [mariadb] section. Repeating them all here, would clutter the documentation too much. Please refer to the configuration file template for an overview of the variables that can be set. The default values can be found in <defaults/main.yml>. For more info on the values, read the MariaDB Server System Variables documentation.

Custom configuration

Settings that aren't supported by the server.cnf template, can be set with mariadb_custom_cnf. These settings will be written to /etc/mysql/my.cnf.d/custom.cnf.

mariadb_custom_cnf should be a dictionary. Keys are section names and values are dictionaries with key-value mappings for individual settings.

The following example enables the general query log:

mariadb_custom_cnf:
  mysqld:
    general-log:
    general-log-file: queries.log
    log-output: file

The resulting config file will look like this:

[mysqld]
general-log-file=queries.log
general-log
log-output=file

Remark the setting general-log was left empty, so doesn't get =value in the config file.

Adding databases

Databases are defined with a dict containing the fields name: (required), and init_script: (optional). The init script is a SQL file that is executed when the database is created to initialise tables and populate it with values.

mariadb_databases:
  - name: appdb1
  - name: appdb2
    init_script: files/init_appdb2.sql

Adding users

Users are defined with a dict containing fields name:, password:, priv:, and, optionally, host:, and append_privs. The password is in plain text and priv: specifies the privileges for this user as described in the Ansible documentation.

An example:

mariadb_users:
  - name: john
    password: letmein
    priv: '*.*:ALL,GRANT'
  - name: jack
    password: sekrit
    priv: 'jacksdb.*:ALL'
    append_privs: 'yes'
    host: '192.168.56.%'

Dependencies

No dependencies.

Example Playbook

See the test playbook

Testing

Test code is stored in separate branches. See the appropriate README:

Docker test environment
Ansible test environment (TODO)

License

2 clause BSD

Contributors

Issues, feature requests, ideas, suggestions, etc. are appreciated and can be posted in the Issues section.

Pull requests are also very welcome. Please create a topic branch for your proposed changes. If you don’t, this will create conflicts in your fork when you synchronise changes after the merge. Don’t hesitate to add yourself to the contributor list below in your PR!

X0Ken/ansible-role-mariadb

Ansible role mariadb