mysql

Table of Contents

1. Module Description - What the module does and why it is useful
2. Setup - The basics of getting started with mysql
   • Beginning with mysql
3. Usage - Configuration options and additional functionality
   • Customize server options
   • Create a database
   • Customize configuration
   • Work with an existing server
   • Specify passwords
   • Install Percona server on CentOS
   • Install MariaDB on Ubuntu
   • Install Plugins
   • Use Percona XtraBackup
4. Reference - An under-the-hood peek at what the module is doing and how
5. Limitations - OS compatibility, etc.
6. License
7. Development - Guide for contributing to the module

Module Description

The mysql module installs, configures, and manages the MySQL service.

This module manages both the installation and configuration of MySQL, as well as extending Puppet to allow management of MySQL resources, such as databases, users, and grants.

Setup

Beginning with mysql

To install a server with the default options:

include mysql::server.

To customize options, such as the root password or /etc/my.cnf settings, you must also pass in an override hash:

class { 'mysql::server':
  root_password           => 'strongpassword',
  remove_default_accounts => true,
  restart                 => true,
  override_options        => $override_options,
}

Nota bene: Configuration changes will only be applied to the running MySQL server if you pass true as restart to mysql::server.

See Customize Server Options below for examples of the hash structure for $override_options.

Usage

All interaction for the server is done via mysql::server. To install the client, use mysql::client. To install bindings, use mysql::bindings.

Customize server options

To define server options, structure a hash structure of overrides in mysql::server. This hash resembles a hash in the my.cnf file:

$override_options = {
  'section' => {
    'item' => 'thing',
  },
}

For options that you would traditionally represent in this format:

[section]
thing = X

Entries can be created as thing => true, thing => value, or thing => "" in the hash. Alternatively, you can pass an array as thing => ['value', 'value2'] or list each thing => value separately on individual lines.

You can pass a variable in the hash without setting a value for it; the variable would then use MySQL's default settings. To exclude an option from the my.cnf file --- for example, when using override_options to revert to a default value --- pass thing => undef.

If an option needs multiple instances, pass an array. For example,

$override_options = {
  'mysqld' => {
    'replicate-do-db' => ['base1', 'base2'],
  },
}

produces

[mysqld]
replicate-do-db = base1
replicate-do-db = base2

To implement version specific parameters, specify the version, such as [mysqld-5.5]. This allows one config for different versions of MySQL.

If you don’t want to use the default configuration, you can also supply your options to the $options parameter instead of $override_options. Please note that $options and $override_options are mutually exclusive, you can only use one of them.

By default, the puppet won't reload/restart mysqld when you change an existing configuration. If you want to do that, you can set mysql::server::reload_on_config_change to true.

Create a database

To create a database with a user and some assigned privileges:

mysql::db { 'mydb':
  user     => 'myuser',
  password => 'mypass',
  host     => 'localhost',
  grant    => ['SELECT', 'UPDATE'],
}

To use a different resource name with exported resources:

 @@mysql::db { "mydb_${fqdn}":
  user     => 'myuser',
  password => 'mypass',
  dbname   => 'mydb',
  host     => ${fqdn},
  grant    => ['SELECT', 'UPDATE'],
  tag      => $domain,
}

Then you can collect it on the remote DB server:

Mysql::Db <<| tag == $domain |>>

If you set the sql parameter to a file when creating a database, the file is imported into the new database.

For large sql files, increase the import_timeout parameter, which defaults to 300 seconds.

If you have installed the mysql client in a non standard bin/sbin path you can set this with mysql_exec_path .

mysql::db { 'mydb':
  user            => 'myuser',
  password        => 'mypass',
  host            => 'localhost',
  grant           => ['SELECT', 'UPDATE'],
  sql             => ['/path/to/sqlfile.gz'],
  import_cat_cmd  => 'zcat',
  import_timeout  => 900,
  mysql_exec_path => '/opt/rh/rh-myql57/root/bin',
}

Customize configuration

To add custom MySQL configuration, place additional files into includedir. This allows you to override settings or add additional ones, which is helpful if you don't use override_options in mysql::server. The includedir location is by default set to /etc/mysql/conf.d.

Managing Root Passwords

If you want the password managed by puppet for 127.0.0.1 and ::1 as an end user you would need to explicitly manage them with additional manifest entries. For example:

mysql_user { '[root@127.0.0.1]':
  ensure        => present,
  password_hash => mysql::password($mysql::server::root_password),
}

mysql_user { 'root@::1':
  ensure        => present,
  password_hash => mysql::password($mysql::server::root_password),
}

Note: This module is not designed to carry out additional DNS and aliasing.

Work with an existing server

To instantiate databases and users on an existing MySQL server, you need a .my.cnf file in root's home directory. This file must specify the remote server address and credentials. For example:

[client]
user=root
host=localhost
password=secret

This module uses the mysqld_version fact to discover the server version being used. By default, this is set to the output of mysqld -V. If you're working with a remote MySQL server, you may need to set a custom fact for mysqld_version to ensure correct behaviour.

When working with a remote server, do not use the mysql::server class in your Puppet manifests.

Specify passwords

In addition to passing passwords as plain text, you can input them as hashes. For example:

mysql::db { 'mydb':
  user     => 'myuser',
  password => '*6C8989366EAF75BB670AD8EA7A7FC1176A95CEF4',
  host     => 'localhost',
  grant    => ['SELECT', 'UPDATE'],
}

If required, the password can also be an empty string to allow connections without an password.

Create login paths

This feature works only for the MySQL Community Edition >= 5.6.6.

A login path is a set of options (host, user, password, port and socket) that specify which MySQL server to connect to and which account to authenticate as. The authentication credentials and the other options are stored in an encrypted login file named .mylogin.cnf typically under the users home directory.

More information about MySQL login paths: https://dev.mysql.com/doc/refman/8.0/en/mysql-config-editor.html.

Some example for login paths:

mysql_login_path { 'client':
  owner    => root,
  host     => 'localhost',
  user     => 'root',
  password => Sensitive('secure'),
  socket   => '/var/run/mysqld/mysqld.sock',
  ensure   => present,
}

mysql_login_path { 'remote_db':
  owner    => root,
  host     => '10.0.0.1',
  user     => 'network',
  password => Sensitive('secure'),
  port     => 3306,
  ensure   => present,
}

See examples/mysql_login_path.pp for further examples.

Install Percona server on CentOS

This example shows how to do a minimal installation of a Percona server on a CentOS system. This sets up the Percona server, client, and bindings (including Perl and Python bindings). You can customize this usage and update the version as needed.

This usage has been tested on Puppet 4.4, 5.5 and 6.3.0 / CentOS 7 / Percona Server 5.7.

Note: The installation of the yum repository is not part of this package and is here only to show a full example of how you can install.

yumrepo { 'percona':
  descr    => 'CentOS $releasever - Percona',
  baseurl  => 'http://repo.percona.com/percona/yum/release/$releasever/RPMS/$basearch',
  gpgkey   => 'https://repo.percona.com/yum/PERCONA-PACKAGING-KEY',
  enabled  => 1,
  gpgcheck => 1,
}

class { 'mysql::server':
  package_name     => 'Percona-Server-server-57',
  service_name     => 'mysql',
  config_file      => '/etc/my.cnf',
  includedir       => '/etc/my.cnf.d',
  root_password    => 'PutYourOwnPwdHere',
  override_options => {
    mysqld => {
      log-error => '/var/log/mysqld.log',
      pid-file  => '/var/run/mysqld/mysqld.pid',
    },
    mysqld_safe => {
      log-error => '/var/log/mysqld.log',
    },
  },
}

# Note: Installing Percona-Server-server-57 also installs Percona-Server-client-57.
# This shows how to install the Percona MySQL client on its own
class { 'mysql::client':
  package_name => 'Percona-Server-client-57',
}

# These packages are normally installed along with Percona-Server-server-57
# If you needed to install the bindings, however, you could do so with this code
class { 'mysql::bindings':
  client_dev_package_name => 'Percona-Server-shared-57',
  client_dev              => true,
  daemon_dev_package_name => 'Percona-Server-devel-57',
  daemon_dev              => true,
  perl_enable             => true,
  perl_package_name       => 'perl-DBD-MySQL',
  python_enable           => true,
  python_package_name     => 'MySQL-python',
}

# Dependencies definition
Yumrepo['percona']->
Class['mysql::server']

Yumrepo['percona']->
Class['mysql::client']

Yumrepo['percona']->
Class['mysql::bindings']

Install MariaDB on Ubuntu

Optional: Install the MariaDB official repo

In this example, we'll use the latest stable (currently 10.3) from the official MariaDB repository, not the one from the distro repository. You could instead use the package from the Ubuntu repository. Make sure you use the repository corresponding to the version you want.

Note: sfo1.mirrors.digitalocean.com is one of many mirrors available. You can use any official mirror.

include apt

apt::source { 'mariadb':
  location => 'http://sfo1.mirrors.digitalocean.com/mariadb/repo/10.3/ubuntu',
  release  => $::facts['os']['codename'],
  repos    => 'main',
  key      => {
    id     => '177F4010FE56CA3336300305F1656F24C74CD1D8',
    server => 'hkp://keyserver.ubuntu.com:80',
  },
  include => {
    src   => false,
    deb   => true,
  },
}

Install the MariaDB server

This example shows MariaDB server installation on Ubuntu Xenial. Adjust the version and the parameters of my.cnf as needed. All parameters of the my.cnf can be defined using the override_options parameter.

The folders /var/log/mysql and /var/run/mysqld are created automatically, but if you are using other custom folders, they should exist as prerequisites for this code.

All the values set here are an example of a working minimal configuration.

Specify the version of the package you want with the package_ensure parameter.

class { 'mysql::server':
  package_name     => 'mariadb-server',
  package_ensure   => '1:10.3.21+maria~xenial',
  service_name     => 'mysqld',
  root_password    => 'AVeryStrongPasswordUShouldEncrypt!',
  override_options => {
    mysqld => {
      'log-error' => '/var/log/mysql/mariadb.log',
      'pid-file'  => '/var/run/mysqld/mysqld.pid',
    },
    mysqld_safe => {
      'log-error' => '/var/log/mysql/mariadb.log',
    },
  },
}

# Dependency management. Only use that part if you are installing the repository
# as shown in the Preliminary step of this example.
Apt::Source['mariadb'] ~>
Class['apt::update'] ->
Class['mysql::server']

Install the MariaDB client

This example shows how to install the MariaDB client and all of the bindings at once. You can do this installation separately from the server installation.

Specify the version of the package you want with the package_ensure parameter.

class { 'mysql::client':
  package_name    => 'mariadb-client',
  package_ensure  => '1:10.3.21+maria~xenial',
  bindings_enable => true,
}

# Dependency management. Only use that part if you are installing the repository as shown in the Preliminary step of this example.
Apt::Source['mariadb'] ~>
Class['apt::update'] ->
Class['mysql::client']

Install MySQL Community server on CentOS

You can install MySQL Community Server on CentOS using the mysql module and Hiera. This example was tested with the following versions:

• MySQL Community Server 5.6
• Centos 7.3
• Puppet 3.8.7 using Hiera
• puppetlabs-mysql module v3.9.0

In Puppet:

include mysql::server

create_resources(yumrepo, hiera('yumrepo', {}))

Yumrepo['repo.mysql.com'] -> Anchor['mysql::server::start']
Yumrepo['repo.mysql.com'] -> Package['mysql_client']

create_resources(mysql::db, hiera('mysql::server::db', {}))

In Hiera:

---

# Centos 7.3
yumrepo:
  'repo.mysql.com':
    baseurl: "http://repo.mysql.com/yum/mysql-5.6-community/el/%{::operatingsystemmajrelease}/$basearch/"
    descr: 'repo.mysql.com'
    enabled: 1
    gpgcheck: true
    gpgkey: 'http://repo.mysql.com/RPM-GPG-KEY-mysql'

mysql::client::package_name: "mysql-community-client" # required for proper MySQL installation
mysql::server::package_name: "mysql-community-server" # required for proper MySQL installation
mysql::server::package_ensure: 'installed' # do not specify version here, unfortunately yum fails with error that package is already installed
mysql::server::root_password: "change_me_i_am_insecure"
mysql::server::manage_config_file: true
mysql::server::service_name: 'mysqld' # required for puppet module
mysql::server::override_options:
  'mysqld':
    'bind-address': '127.0.0.1'
    'log-error': '/var/log/mysqld.log' # required for proper MySQL installation
  'mysqld_safe':
    'log-error': '/var/log/mysqld.log'  # required for proper MySQL installation

# create database + account with access, passwords are not encrypted
mysql::server::db:
  "dev":
    user: "dev"
    password: "devpass"
    host: "127.0.0.1"
    grant:
      - "ALL"

Install Plugins

Plugins can be installed by using the mysql_plugin defined type. See examples/mysql_plugin.pp for futher examples.

Use Percona XtraBackup

This example shows how to configure MySQL backups with Percona XtraBackup. This sets up a weekly cronjob to perform a full backup and additional daily cronjobs for incremental backups. Each backup will create a new directory. A cleanup job will automatically remove backups that are older than 15 days.

yumrepo { 'percona':
  descr    => 'CentOS $releasever - Percona',
  baseurl  => 'http://repo.percona.com/release/$releasever/RPMS/$basearch',
  gpgkey   => 'https://www.percona.com/downloads/RPM-GPG-KEY-percona https://repo.percona.com/yum/PERCONA-PACKAGING-KEY',
  enabled  => 1,
  gpgcheck => 1,
}

class { 'mysql::server::backup':
  backupuser        => 'myuser',
  backuppassword    => 'mypassword',
  backupdir         => '/tmp/backups',
  provider          => 'xtrabackup',
  backuprotate      => 15,
  execpath          => '/usr/local/bin:/usr/local/sbin:/usr/bin:/usr/sbin:/bin:/sbin',
  time              => ['23', '15'],
}

If the daily or weekly backup was successful, then the empty file /tmp/mysqlbackup_success is created, which makes it easy to monitor the status of the database backup.

After two weeks the backup directory should look similar to the example below.

/tmp/backups/2019-11-10_full
/tmp/backups/2019-11-11_23-15-01
/tmp/backups/2019-11-13_23-15-01
/tmp/backups/2019-11-13_23-15-02
/tmp/backups/2019-11-14_23-15-01
/tmp/backups/2019-11-15_23-15-02
/tmp/backups/2019-11-16_23-15-01
/tmp/backups/2019-11-17_full
/tmp/backups/2019-11-18_23-15-01
/tmp/backups/2019-11-19_23-15-01
/tmp/backups/2019-11-20_23-15-02
/tmp/backups/2019-11-21_23-15-01
/tmp/backups/2019-11-22_23-15-02
/tmp/backups/2019-11-23_23-15-01

A drawback of using incremental backups is the need to keep at least 7 days of backups, otherwise the full backups is removed early and consecutive incremental backups will fail. Furthermore an incremental backups becomes obsolete once the required full backup was removed.

The next example uses XtraBackup with incremental backups disabled. In this case the daily cronjob will always perform a full backup.

class { 'mysql::server::backup':
  backupuser          => 'myuser',
  backuppassword      => 'mypassword',
  backupdir           => '/tmp/backups',
  provider            => 'xtrabackup',
  incremental_backups => false,
  backuprotate        => 5,
  execpath            => '/usr/local/bin:/usr/local/sbin:/usr/bin:/usr/sbin:/bin:/sbin',
  time                => ['23', '15'],
}

The next example shows how to use mariabackup (a fork of xtrabackup) as a backup provider. Note that on most Linux/BSD distributions, this will require setting backupmethod_package => 'mariadb-backup' in the mysql::server::backup declaration in order to override the default xtrabackup package (percona-xtrabackup).

class { 'mysql::server':
  package_name            => 'mariadb-server',
  package_ensure          => '1:10.3.21+maria~xenial',
  service_name            => 'mysqld',
  root_password           => 'AVeryStrongPasswordUShouldEncrypt!',
}

class { 'mysql::server::backup':
  backupuser              => 'mariabackup',
  backuppassword          => 'AVeryStrongPasswordUShouldEncrypt!',
  provider                => 'xtrabackup',
  backupmethod            => 'mariabackup',
  backupmethod_package    => 'mariadb-backup',
  backupdir               => '/tmp/backups',
  backuprotate            => 15,
  execpath                => '/usr/local/bin:/usr/local/sbin:/usr/bin:/usr/sbin:/bin:/sbin',
  time                    => ['23', '15'],
}

Reference

Classes

Public classes

• mysql::server: Installs and configures MySQL.
• mysql::server::backup: Sets up MySQL backups via cron.
• mysql::bindings: Installs various MySQL language bindings.
• mysql::client: Installs MySQL client (for non-servers).

Private classes

• mysql::server::install: Installs packages.
• mysql::server::installdb: Implements setup of mysqld data directory (e.g. /var/lib/mysql)
• mysql::server::config: Configures MYSQL.
• mysql::server::service: Manages service.
• mysql::server::account_security: Deletes default MySQL accounts.
• mysql::server::root_password: Sets MySQL root password.
• mysql::server::providers: Creates users, grants, and databases.
• mysql::bindings::client_dev: Installs MySQL client development package.
• mysql::bindings::daemon_dev: Installs MySQL daemon development package.
• mysql::bindings::java: Installs Java bindings.
• mysql::bindings::perl: Installs Perl bindings.
• mysql::bindings::php: Installs PHP bindings.
• mysql::bindings::python: Installs Python bindings.
• mysql::bindings::ruby: Installs Ruby bindings.
• mysql::client::install: Installs MySQL client.
• mysql::backup::mysqldump: Implements mysqldump backups.
• mysql::backup::mysqlbackup: Implements backups with Oracle MySQL Enterprise Backup.
• mysql::backup::xtrabackup: Implements backups with XtraBackup from Percona or Mariabackup.

Parameters

mysql::server

create_root_user

Whether root user should be created.

Valid values are true, false.

Defaults to true.

This is useful for a cluster setup with Galera. The root user has to be created only once. You can set this parameter true on one node and set it to false on the remaining nodes.

create_root_my_cnf

Whether to create /root/.my.cnf.

Valid values are true, false.

Defaults to true.

create_root_my_cnf allows creation of /root/.my.cnf independently of create_root_user. You can use this for a cluster setup with Galera where you want /root/.my.cnf to exist on all nodes.

root_password

The MySQL root password. Puppet attempts to set the root password and update /root/.my.cnf with it.

This is required if create_root_user or create_root_my_cnf are true. If root_password is 'UNSET', then create_root_user and create_root_my_cnf are assumed to be false --- that is, the MySQL root user and /root/.my.cnf are not created.

Password changes are supported; however, the old password must be set in /root/.my.cnf. Effectively, Puppet uses the old password, configured in /root/my.cnf, to set the new password in MySQL, and then updates /root/.my.cnf with the new password.

old_root_password

This parameter no longer does anything. It exists only for backwards compatibility. See the root_password parameter above for details on changing the root password.

create_root_login_file

Whether to create /root/.mylogin.cnf when using mysql 5.6.6+.

Valid values are true, false.

Defaults to false.

create_root_login_file will put a copy of your existing .mylogin.cnf in the /root/.mylogin.cnf location.

When set to 'true', this option also requires the login_file option.

The login_file option is required when set to true.

login_file

Whether to put the /root/.mylogin.cnf in place.

You need to create the .mylogin.cnf file with mysql_config_editor, this tool comes with mysql 5.6.6+.

The created .mylogin.cnf needs to be put under files in your module, see example below on how to use this.

When the /root/.mylogin.cnf exists the environment variable MYSQL_TEST_LOGIN_FILE will be set.

This is required if create_root_user and create_root_login_file are true. If root_password is 'UNSET', then create_root_user and create_root_login_file are assumed to be false --- that is, the MySQL root user and /root/.mylogin.cnf are not created.

class { 'mysql::server':
  root_password          => 'password',
  create_root_my_cnf     => false,
  create_root_login_file => true,
  login_file             => 'puppet:///modules/${module_name}/mylogin.cnf',
}

override_options

Specifies override options to pass into MySQL. Structured like a hash in the my.cnf file:

class { 'mysql::server':
  root_password => 'password'
}

mysql_plugin { 'auth_pam':
  ensure => present,
  soname => 'auth_pam.so',
}

Tasks

The MySQL module has an example task that allows a user to execute arbitary SQL against a database. Please refer to to the PE documentation or Bolt documentation on how to execute a task.

Limitations

This module lacks compatibility with the ARM architecture, for an extensive list of supported operating systems, see metadata.json

Note: The mysqlbackup.sh does not work and is not supported on MySQL 5.7 and greater.

License

This codebase is licensed under the Apache2.0 licensing, however due to the nature of the codebase the open source dependencies may also use a combination of AGPL, BSD-2, BSD-3, GPL2.0, LGPL, MIT and MPL Licensing.

Development

We are experimenting with a new tool for running acceptance tests. Its name is puppet_litmus this replaces beaker as the test runner. To run the acceptance tests follow the instructions from the Litmus documentation.

Puppet modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can't access the huge number of platforms and myriad of hardware, software, and deployment configurations that Puppet is intended to serve.

We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.

Check out our the complete module contribution guide.

Authors

This module is based on work by David Schmitt. Thank you to all of our contributors.

Reference

Table of Contents

Classes

Public Classes

• mysql::bindings: Parent class for MySQL bindings.
• mysql::client: Installs and configures the MySQL client.
• mysql::server: Installs and configures the MySQL server.
• mysql::server::backup: Create and manage a MySQL backup.

Private Classes

• mysql::backup::mysqlbackup: Manage the mysqlbackup client.
• mysql::backup::mysqldump: "Provider" for mysqldump
• mysql::backup::xtrabackup: "Provider" for Percona XtraBackup/MariaBackup
• mysql::bindings::client_dev: Private class for installing client development bindings
• mysql::bindings::daemon_dev: Private class for installing daemon development bindings
• mysql::bindings::java: Private class for installing java language bindings.
• mysql::bindings::perl: Private class for installing perl language bindings.
• mysql::bindings::php: Private class for installing php language bindings
• mysql::bindings::python: Private class for installing python language bindings
• mysql::bindings::ruby: Private class for installing ruby language bindings
• mysql::client::install: Private class for MySQL client install.
• mysql::params: Params class.
• mysql::server::account_security: Private class for ensuring localhost accounts do not exist
• mysql::server::config: Private class for MySQL server configuration.
• mysql::server::install: Private class for managing MySQL package.
• mysql::server::installdb: Builds initial databases on installation.
• mysql::server::managed_dirs: Binary log configuration requires the mysql user to be present. This must be done after package install.
• mysql::server::providers: Convenience class to call each of the three providers with the corresponding hashes provided in mysql::server.
• mysql::server::root_password: Private class for managing the root password
• mysql::server::service: Private class for managing the MySQL service

Defined types

• mysql::db: Create and configure a MySQL database.

Resource types

Public Resource types

• mysql_database: Manage a MySQL database.
• mysql_grant: Manage a MySQL user's rights.
• mysql_login_path: Manage a MySQL login path.
• mysql_plugin: Manage MySQL plugins.
• mysql_user: Manage a MySQL user. This includes management of users password as well as privileges.

Private Resource types

• mysql_datadir: Manage MySQL datadirs with mysql_install_db OR mysqld (5.7.6 and above).

Functions

• mysql::innobackupex_args: This function populates and returns the string of arguments which later gets injected in template. Arguments that return string holds is conditional and decided by the the input given to function.
• mysql::normalise_and_deepmerge: Recursively merges two or more hashes together, normalises keys with differing use of dashes and underscores.
• mysql::password: Hash a string as mysql's "PASSWORD()" function would do it
• mysql::strip_hash: When given a hash this function strips out all blank entries.
• mysql_password: DEPRECATED. Use the namespaced function mysql::password instead.

Data types

• Mysql::Options: A hash of options structured like the override_options, but not merged with the default options.

Tasks

• export: Allows you to backup your database to local file.
• sql: Allows you to execute arbitary SQL

Classes

mysql::bindings

Parent class for MySQL bindings.

Examples

Install Ruby language bindings

class { 'mysql::bindings':
  ruby_enable           => true,
  ruby_package_ensure   => 'present',
  ruby_package_name     => 'ruby-mysql-2.7.1-1mdv2007.0.sparc.rpm',
  ruby_package_provider => 'rpm',
}

Parameters

The following parameters are available in the mysql::bindings class:

• install_options
• java_enable
• perl_enable
• php_enable
• python_enable
• ruby_enable
• client_dev
• daemon_dev
• java_package_ensure
• java_package_name
• java_package_provider
• perl_package_ensure
• perl_package_name
• perl_package_provider
• php_package_ensure
• php_package_name
• php_package_provider
• python_package_ensure
• python_package_name
• python_package_provider
• ruby_package_ensure
• ruby_package_name
• ruby_package_provider
• client_dev_package_ensure
• client_dev_package_name
• client_dev_package_provider
• daemon_dev_package_ensure
• daemon_dev_package_name
• daemon_dev_package_provider

install_options

Data type: Optional[Array[String[1]]]

Passes install_options array to managed package resources. You must pass the appropriate options for the package manager(s).

Default value: undef

java_enable

Data type: Boolean

Specifies whether ::mysql::bindings::java should be included. Valid values are true, false.

Default value: false

perl_enable

Data type: Boolean

Specifies whether mysql::bindings::perl should be included. Valid values are true, false.

Default value: false

php_enable

Data type: Boolean

Specifies whether mysql::bindings::php should be included. Valid values are true, false.

Default value: false

python_enable

Data type: Boolean

Specifies whether mysql::bindings::python should be included. Valid values are true, false.

Default value: false

ruby_enable

Data type: Boolean

Specifies whether mysql::bindings::ruby should be included. Valid values are true, false.

Default value: false

client_dev

Data type: Boolean

Specifies whether ::mysql::bindings::client_dev should be included. Valid values are true', false.

Default value: false

daemon_dev

Data type: Boolean

Specifies whether ::mysql::bindings::daemon_dev should be included. Valid values are true, false.

Default value: false

java_package_ensure

Data type: Variant[Enum['present','absent'], Pattern[/(\d+)[\.](\d+)[\.](\d+)/]]

Whether the package should be present, absent, or a specific version. Valid values are 'present', 'absent', or 'x.y.z'. Only applies if java_enable => true.

Default value: $mysql::params::java_package_ensure

java_package_name

Data type: String[1]

The name of the Java package to install. Only applies if java_enable => true.

Default value: $mysql::params::java_package_name

java_package_provider

Data type: Optional[String[1]]

The provider to use to install the Java package. Only applies if java_enable => true.

Default value: $mysql::params::java_package_provider

perl_package_ensure

Data type: Variant[Enum['present','absent'], Pattern[/(\d+)[\.](\d+)[\.](\d+)/]]

Whether the package should be present, absent, or a specific version. Valid values are 'present', 'absent', or 'x.y.z'. Only applies if perl_enable => true.

Default value: $mysql::params::perl_package_ensure

perl_package_name

Data type: String[1]

The name of the Perl package to install. Only applies if perl_enable => true.

Default value: $mysql::params::perl_package_name

perl_package_provider

Data type: Optional[String[1]]

The provider to use to install the Perl package. Only applies if perl_enable => true.

Default value: $mysql::params::perl_package_provider

php_package_ensure

Data type: Variant[Enum['present','absent'], Pattern[/(\d+)[\.](\d+)[\.](\d+)/]]

Whether the package should be present, absent, or a specific version. Valid values are 'present', 'absent', or 'x.y.z'. Only applies if php_enable => true.

Default value: $mysql::params::php_package_ensure

php_package_name

Data type: String[1]

The name of the PHP package to install. Only applies if php_enable => true.

Default value: $mysql::params::php_package_name

php_package_provider

Data type: Optional[String[1]]

The provider to use to install the PHP package. Only applies if php_enable => true.

Default value: $mysql::params::php_package_provider

python_package_ensure

Data type: Variant[Enum['present','absent'], Pattern[/(\d+)[\.](\d+)[\.](\d+)/]]

Whether the package should be present, absent, or a specific version. Valid values are 'present', 'absent', or 'x.y.z'. Only applies if python_enable => true.

Default value: $mysql::params::python_package_ensure

python_package_name

Data type: String[1]

The name of the Python package to install. Only applies if python_enable => true.

Default value: $mysql::params::python_package_name

python_package_provider

Data type: Optional[String[1]]

The provider to use to install the Python package. Only applies if python_enable => true.

Default value: $mysql::params::python_package_provider

ruby_package_ensure

Data type: Variant[Enum['present','absent'], Pattern[/(\d+)[\.](\d+)[\.](\d+)/]]

Whether the package should be present, absent, or a specific version. Valid values are 'present', 'absent', or 'x.y.z'. Only applies if ruby_enable => true.

Default value: $mysql::params::ruby_package_ensure

ruby_package_name

Data type: String[1]

The name of the Ruby package to install. Only applies if ruby_enable => true.

Default value: $mysql::params::ruby_package_name

ruby_package_provider

Data type: Optional[String[1]]

What provider should be used to install the package.

Default value: $mysql::params::ruby_package_provider

client_dev_package_ensure

Data type: Variant[Enum['present','absent'], Pattern[/(\d+)[\.](\d+)[\.](\d+)/]]

Whether the package should be present, absent, or a specific version. Valid values are 'present', 'absent', or 'x.y.z'. Only applies if client_dev => true.

Default value: $mysql::params::client_dev_package_ensure

client_dev_package_name

Data type: Optional[String[1]]

The name of the client_dev package to install. Only applies if client_dev => true.

Default value: $mysql::params::client_dev_package_name

client_dev_package_provider

Data type: Optional[String[1]]

The provider to use to install the client_dev package. Only applies if client_dev => true.

Default value: $mysql::params::client_dev_package_provider

daemon_dev_package_ensure

Data type: Variant[Enum['present','absent'], Pattern[/(\d+)[\.](\d+)[\.](\d+)/]]

Whether the package should be present, absent, or a specific version. Valid values are 'present', 'absent', or 'x.y.z'. Only applies if daemon_dev => true.

Default value: $mysql::params::daemon_dev_package_ensure

daemon_dev_package_name

Data type: String[1]

The name of the daemon_dev package to install. Only applies if daemon_dev => true.

Default value: $mysql::params::daemon_dev_package_name

daemon_dev_package_provider

Data type: Optional[String[1]]

The provider to use to install the daemon_dev package. Only applies if daemon_dev => true.

Default value: $mysql::params::daemon_dev_package_provider

mysql::client

Installs and configures the MySQL client.

Examples

Install the MySQL client

class {'::mysql::client':
  package_name    => 'mysql-client',
  package_ensure  => 'present',
  bindings_enable => true,
}

Parameters

The following parameters are available in the mysql::client class:

• bindings_enable
• install_options
• package_ensure
• package_manage
• package_name
• package_provider
• package_source

bindings_enable

Data type: Boolean

Whether to automatically install all bindings. Valid values are true, false. Default to false.

Default value: $mysql::params::bindings_enable

install_options

Data type: Optional[Array[String[1]]]

Array of install options for managed package resources. You must pass the appropriate options for the package manager.

Default value: undef

package_ensure

Data type: Variant[Enum['present','absent'], Pattern[/(\d+)[\.](\d+)[\.](\d+)/]]

Whether the MySQL package should be present, absent, or a specific version. Valid values are 'present', 'absent', or 'x.y.z'.

Default value: $mysql::params::client_package_ensure

package_manage

Data type: Boolean

Whether to manage the MySQL client package. Defaults to true.

Default value: $mysql::params::client_package_manage

package_name

Data type: String[1]

The name of the MySQL client package to install.

Default value: $mysql::params::client_package_name

package_provider

Data type: Optional[String[1]]

Specify the provider of the package. Optional. Valid value is a String.

Default value: undef

package_source

Data type: Optional[String[1]]

Specify the path to the package source. Optional. Valid value is a String

Default value: undef

mysql::server

Installs and configures the MySQL server.

Examples

Install MySQL Server

class { '::mysql::server':
  package_name            => 'mysql-server',
  package_ensure          => '5.7.1+mysql~trusty',
  root_password           => 'strongpassword',
  remove_default_accounts => true,
}

Parameters

The following parameters are available in the mysql::server class:

• config_file
• config_file_mode
• includedir
• install_options
• manage_config_file
• options
• override_options
• package_ensure
• package_manage
• package_name
• package_provider
• package_source
• purge_conf_dir
• remove_default_accounts
• restart
• root_group
• managed_dirs
• mysql_group
• mycnf_owner
• mycnf_group
• root_password
• service_enabled
• service_manage
• service_name
• service_provider
• create_root_user
• create_root_my_cnf
• create_root_login_file
• login_file
• users
• grants
• databases
• reload_on_config_change
• enabled
• manage_service
• old_root_password

config_file

Data type: String[1]

The location, as a path, of the MySQL configuration file.

Default value: $mysql::params::config_file

config_file_mode

Data type: String[1]

The MySQL configuration file's permissions mode.

Default value: '0644'

includedir

Data type: Optional[String]

The location, as a path, of !includedir for custom configuration overrides.

Default value: $mysql::params::includedir

install_options

Data type: Optional[Array[String[1]]]

Passes install_options array to managed package resources. You must pass the appropriate options for the specified package manager

Default value: undef

manage_config_file

Data type: Variant[Boolean, String[1]]

Whether the MySQL configuration file should be managed. Valid values are true, false. Defaults to true.

Default value: true

options

Data type: Mysql::Options

A hash of options structured like the override_options, but not merged with the default options. Use this if you don't want your options merged with the default options.

Default value: {}

override_options

Data type: Hash

Specifies override options to pass into MySQL. Structured like a hash in the my.cnf file: See above for usage details.

Default value: {}

package_ensure

Data type: Variant[Enum['present','absent'], Pattern[/(\d+)[\.](\d+)[\.](\d+)/]]

Whether the package exists or should be a specific version. Valid values are 'present', 'absent', or 'x.y.z'. Defaults to 'present'.

Default value: 'present'

package_manage

Data type: Boolean

Whether to manage the MySQL server package. Defaults to true.

Default value: true

package_name

Data type: String[1]

The name of the MySQL server package to install.

Default value: $mysql::params::server_package_name

package_provider

Data type: Optional[String[1]]

Define a specific provider for package install.

Default value: undef

package_source

Data type: Optional[String[1]]

The location of the package source (require for some package provider)

Default value: undef

purge_conf_dir

Data type: Variant[Boolean, String[1]]

Whether the includedir directory should be purged. Valid values are true, false. Defaults to false.

Default value: false

remove_default_accounts

Data type: Variant[Boolean, String[1]]

Specifies whether to automatically include mysql::server::account_security. Valid values are true, false. Defaults to false.

Default value: false

restart

Data type: Variant[Boolean, String[1]]

Whether the service should be restarted when things change. Valid values are true, false. Defaults to false.

Default value: false

root_group

Data type: String[1]

The name of the group used for root. Can be a group name or a group ID. See more about the group.

Default value: $mysql::params::root_group

managed_dirs

Data type: Optional[Array[String[1]]]

An array containing all directories to be managed.

Default value: $mysql::params::managed_dirs

mysql_group

Data type: String[1]

The name of the group of the MySQL daemon user. Can be a group name or a group ID. See more about the group.

Default value: $mysql::params::mysql_group

mycnf_owner

Data type: Optional[String[1]]

Name or user-id who owns the mysql-config-file.

Default value: undef

mycnf_group

Data type: Optional[String[1]]

Name or group-id which owns the mysql-config-file.

Default value: undef

root_password

Data type: Variant[String, Sensitive[String]]

The MySQL root password. Puppet attempts to set the root password and update /root/.my.cnf with it. This is required if create_root_user or create_root_my_cnf are true. If root_password is 'UNSET', then create_root_user and create_root_my_cnf are assumed to be false --- that is, the MySQL root user and /root/.my.cnf are not created. Password changes are supported; however, the old password must be set in /root/.my.cnf. Effectively, Puppet uses the old password, configured in /root/my.cnf, to set the new password in MySQL, and then updates /root/.my.cnf with the new password.

Default value: 'UNSET'

service_enabled

Data type: Variant[Boolean, String[1]]

Specifies whether the service should be enabled. Valid values are true, false. Defaults to true.

Default value: true

service_manage

Data type: Variant[Boolean, String[1]]

Specifies whether the service should be managed. Valid values are true, false. Defaults to true.

Default value: true

service_name

Data type: String[1]

The name of the MySQL server service. Defaults are OS dependent, defined in 'params.pp'.

Default value: $mysql::params::server_service_name

service_provider

Data type: Optional[String[1]]

The provider to use to manage the service. For Ubuntu, defaults to 'upstart'; otherwise, default is undefined.

Default value: undef

create_root_user

Data type: Boolean

Whether root user should be created. Valid values are true, false. Defaults to true. This is useful for a cluster setup with Galera. The root user has to be created only once. You can set this parameter true on one node and set it to false on the remaining nodes.

Default value: true

create_root_my_cnf

Data type: Boolean

Whether to create /root/.my.cnf. Valid values are true, false. Defaults to true. create_root_my_cnf allows creation of /root/.my.cnf independently of create_root_user. You can use this for a cluster setup with Galera where you want /root/.my.cnf to exist on all nodes.

Default value: true

create_root_login_file

Data type: Boolean

Whether to create a login file for root. Valid values are 'true', 'false'.

Default value: false

login_file

Data type: Optional[String[1]]

Specify the login file.

Default value: undef

users

Data type: Hash

Optional hash of users to create, which are passed to mysql_user.

Default value: {}

grants

Data type: Hash

Optional hash of grants, which are passed to mysql_grant.

Default value: {}

databases

Data type: Hash

Optional hash of databases to create, which are passed to mysql_database.

Default value: {}

reload_on_config_change

Data type: Boolean

By default, a my.cnf change won't reload/restart the database. Turn this flag to true to enable it

Default value: false

enabled

Data type: Optional[Variant[String[1], Boolean]]

Deprecated

Default value: undef

manage_service

Data type: Optional[Variant[String[1], Boolean]]

Deprecated

Default value: undef

old_root_password

Data type: Optional[Variant[String, Sensitive[String]]]

This parameter no longer does anything. It exists only for backwards compatibility. See the root_password parameter above for details on changing the root password.

Default value: undef

mysql::server::backup

Create and manage a MySQL backup.

Examples

Create a basic MySQL backup:

class { 'mysql::server':
  root_password           => 'password'
}
class { 'mysql::server::backup':
  backupuser              => 'myuser',
  backuppassword          => 'mypassword',
  backupdir               => '/tmp/backups',
}

Create a basic MySQL backup using mariabackup:

class { 'mysql::server':
  root_password           => 'password'
}
class { 'mysql::server::backup':
  backupmethod            => 'mariabackup',
  backupmethod_package    => 'mariadb-backup'
  provider                => 'xtrabackup',
  backupdir               => '/tmp/backups',
}

Parameters

The following parameters are available in the mysql::server::backup class:

• backupuser
• backuppassword
• backupdir
• backupdirmode
• backupdirowner
• backupdirgroup
• backupcompress
• backupmethod
• backup_success_file_path
• backuprotate
• ignore_events
• delete_before_dump
• backupdatabases
• file_per_database
• include_routines
• include_triggers
• incremental_backups
• ensure
• time
• prescript
• postscript
• execpath
• provider
• maxallowedpacket
• optional_args
• install_cron
• compression_command
• compression_extension
• backupmethod_package
• excludedatabases

backupuser

Data type: Optional[String[1]]

MySQL user to create with backup administrator privileges.

Default value: undef

backuppassword

Data type: Optional[Variant[String, Sensitive[String]]]

Password to create for backupuser.

Default value: undef

backupdir

Data type: Optional[String[1]]

Directory to store backup.

Default value: undef

backupdirmode

Data type: String[1]

Permissions applied to the backup directory. This parameter is passed directly to the file resource.

Default value: '0700'

backupdirowner

Data type: String[1]

Owner for the backup directory. This parameter is passed directly to the file resource.

Default value: 'root'

backupdirgroup

Data type: String[1]

Group owner for the backup directory. This parameter is passed directly to the file resource.

Default value: $mysql::params::root_group

backupcompress

Data type: Boolean

Whether or not to compress the backup (when using the mysqldump or xtrabackup provider)

Default value: true

backupmethod

Data type: Optional[String[1]]

The execution binary for backing up. ex. mysqldump, xtrabackup, mariabackup

Default value: undef

backup_success_file_path

Data type: String[1]

Specify a path where upon successfull backup a file should be created for checking purposes.

Default value: '/tmp/mysqlbackup_success'

backuprotate

Data type: Variant[String[1], Integer]

Backup rotation interval in 24 hour periods.

Default value: 30

ignore_events

Data type: Boolean

Ignore the mysql.event table.

Default value: true

delete_before_dump

Data type: Boolean

Whether to delete old .sql files before backing up. Setting to true deletes old files before backing up, while setting to false deletes them after backup.

Default value: false

backupdatabases

Data type: Array[String[1]]

Databases to backup (required if using xtrabackup provider). By default [] will back up all databases.

Default value: []

file_per_database

Data type: Boolean

Use file per database mode creating one file per database backup.

Default value: false

include_routines

Data type: Boolean

Dump stored routines (procedures and functions) from dumped databases when doing a file_per_database backup.

Default value: false

include_triggers

Data type: Boolean

Dump triggers for each dumped table when doing a file_per_database backup.

Default value: false

incremental_backups

Data type: Boolean

A flag to activate/deactivate incremental backups. Currently only supported by the xtrabackup provider.

Default value: true

ensure

Data type: Variant[Enum['present','absent'], Pattern[/(\d+)[\.](\d+)[\.](\d+)/]]

Default value: 'present'

time

Data type: Variant[Array[String[1]], Array[Integer]]

An array of two elements to set the backup time. Allows ['23', '5'] (i.e., 23:05) or ['3', '45'] (i.e., 03:45) for HH:MM times.

Default value: ['23', '5']

prescript

Data type: Variant[Boolean, String[1], Array[String[1]]]

A script that is executed before the backup begins.

Default value: false

postscript

Data type: Variant[Boolean, String[1], Array[String[1]]]

A script that is executed when the backup is finished. This could be used to sync the backup to a central store. This script can be either a single line that is directly executed or a number of lines supplied as an array. It could also be one or more externally managed (executable) files.

Default value: false

execpath

Data type: String[1]

Allows you to set a custom PATH should your MySQL installation be non-standard places. Defaults to /usr/bin:/usr/sbin:/bin:/sbin.

Default value: '/usr/bin:/usr/sbin:/bin:/sbin'

provider

Data type: Enum['xtrabackup', 'mysqldump', 'mysqlbackup']

Sets the server backup implementation. Valid values are: xtrabackup, mysqldump, mysqlbackup

Default value: 'mysqldump'

maxallowedpacket

Data type: String[1]

Defines the maximum SQL statement size for the backup dump script. The default value is 1MB, as this is the default MySQL Server value.

Default value: '1M'

optional_args

Data type: Array[String[1]]

Specifies an array of optional arguments which should be passed through to the backup tool. (Supported by the xtrabackup and mysqldump providers.)

Default value: []

install_cron

Data type: Boolean

Manage installation of cron package

Default value: true

compression_command

Data type: Optional[String[1]]

Configure the command used to compress the backup (when using the mysqldump provider). Make sure the command exists on the target system. Packages for it are NOT automatically installed.

Default value: undef

compression_extension

Data type: Optional[String[1]]

Configure the file extension for the compressed backup (when using the mysqldump provider)

Default value: undef

backupmethod_package

Data type: String[1]

The package which provides the binary specified by the backupmethod parameter.

Default value: $mysql::params::xtrabackup_package_name

excludedatabases

Data type: Array[String]

Give a list of excluded databases when using file_per_database, e.g.: [ 'information_schema', 'performance_schema' ]

Default value: []

Defined types

mysql::db

Create and configure a MySQL database.

Examples

Create a database

mysql::db { 'mydb':
  user     => 'myuser',
  password => 'mypass',
  host     => 'localhost',
  grant    => ['SELECT', 'UPDATE'],
}

Parameters

The following parameters are available in the mysql::db defined type:

• name
• user
• password
• tls_options
• dbname
• charset
• collate
• host
• grant
• grant_options
• sql
• enforce_sql
• ensure
• import_timeout
• import_cat_cmd
• mysql_exec_path

name

The name of the database to create. Database names must:

• not be longer than 64 characters.
• not contain '/' '\' or '.' characters.
• not contain characters that are not permitted in file names.
• not end with space characters.

user

Data type: String[1]

The user for the database you're creating.

password

Data type: Variant[String, Sensitive[String]]

The password for $user for the database you're creating.

tls_options

Data type: Optional[Array[String[1]]]

The tls_options for $user for the database you're creating.

Default value: undef

dbname

Data type: String

The name of the database to create.

Default value: $name

charset

Data type: String[1]

The character set for the database. Must have the same value as collate to avoid corrective changes. See https://dev.mysql.com/doc/refman/8.0/en/charset-mysql.html for charset and collation pairs.

Default value: 'utf8mb3'

collate

Data type: String[1]

The collation for the database. Must have the same value as charset to avoid corrective changes. See https://dev.mysql.com/doc/refman/8.0/en/charset-mysql.html for charset and collation pairs.

Default value: 'utf8mb3_general_ci'

host

Data type: String[1]

The host to use as part of user@host for grants.

Default value: 'localhost'

grant

Data type: Variant[String[1], Array[String[1]]]

The privileges to be granted for user@host on the database.

Default value: 'ALL'

grant_options

Data type: Optional[Variant[String[1], Array[String[1]]]]

The grant_options for the grant for user@host on the database.

Default value: undef

sql

Data type: Optional[Array]

The path to the sqlfile you want to execute. This can be an array containing one or more file paths.

Default value: undef

enforce_sql

Data type: Boolean

Specifies whether executing the sqlfiles should happen on every run. If set to false, sqlfiles only run once.

Default value: false

ensure

Data type: Enum['absent', 'present']

Specifies whether to create the database. Valid values are 'present', 'absent'. Defaults to 'present'.

Default value: 'present'

import_timeout

Data type: Integer

Timeout, in seconds, for loading the sqlfiles. Defaults to 300.

Default value: 300

import_cat_cmd

Data type: Enum['cat', 'zcat', 'bzcat']

Command to read the sqlfile for importing the database. Useful for compressed sqlfiles. For example, you can use 'zcat' for .gz files.

Default value: 'cat'

mysql_exec_path

Data type: Optional[String]

Specify the path in which mysql has been installed if done in the non-standard bin/sbin path.

Default value: undef

Resource types

mysql_database

Manage a MySQL database.

Properties

The following properties are available in the mysql_database type.

charset

Valid values: %r{^\S+$}

The CHARACTER SET setting for the database

Default value: utf8

collate

Valid values: %r{^\S+$}

The COLLATE setting for the database

Default value: utf8_general_ci

ensure

Valid values: present, absent

The basic property that the resource should be in.

Default value: present

Parameters

The following parameters are available in the mysql_database type.

• name
• provider

name

namevar

The name of the MySQL database to manage.

provider

The specific backend to use for this mysql_database resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform.

mysql_grant

Manage a MySQL user's rights.

Properties

The following properties are available in the mysql_grant type.

ensure

Valid values: present, absent

The basic property that the resource should be in.

Default value: present

options

Options to grant.

privileges

Privileges for user

table

Valid values: %r{.*\..*}, %r{^[0-9a-zA-Z$_]*@[\w%.:\-/]*$}

Table to apply privileges to.

user

User to operate on.

Parameters

The following parameters are available in the mysql_grant type.

• name
• provider

name

namevar

Name to describe the grant.

provider

The specific backend to use for this mysql_grant resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform.

mysql_login_path

This type provides Puppet with the capabilities to store authentication credentials in an obfuscated login path file named .mylogin.cnf created with the mysql_config_editor utility. Supports only MySQL Community Edition > v5.6.6.

• See also
  • https://dev.mysql.com/doc/refman/8.0/en/mysql-config-editor.html

Examples

mysql_login_path { 'local_socket':
  owner    => 'root',
  host     => 'localhost',
  user     => 'root',
  password => Sensitive('secure'),
  socket   => '/var/run/mysql/mysql.sock',
  ensure   => present,
}

mysql_login_path { 'local_tcp':
  owner    => 'root',
  host     => '127.0.0.1',
  user     => 'root',
  password => Sensitive('more_secure'),
  port     => 3306,
  ensure   => present,
}

Properties

The following properties are available in the mysql_login_path type.

ensure

Data type: Enum[present, absent]

Whether this resource should be present or absent on the target system.

host

Data type: Optional[String]

Host name to be entered into the login path.

password

Data type: Optional[Sensitive[String[1]]]

Password to be entered into login path

port

Data type: Optional[Integer[0,65535]]

Port number to be entered into login path.

socket

Data type: Optional[String]

Socket path to be entered into login path

user

Data type: Optional[String]

Username to be entered into the login path.

Parameters

The following parameters are available in the mysql_login_path type.

• name
• owner

name

namevar

Data type: String

Name of the login path you want to manage.

owner

namevar

Data type: String

The user to whom the logon path should belong.

Default value: root

mysql_plugin

Manage MySQL plugins.

Examples

mysql_plugin { 'some_plugin':
  soname => 'some_pluginlib.so',
}

Properties

The following properties are available in the mysql_plugin type.

ensure

Valid values: present, absent

The basic property that the resource should be in.

Default value: present

soname

Valid values: %r{^\w+\.\w+$}

The name of the library

Parameters

The following parameters are available in the mysql_plugin type.

• name
• provider

name

namevar

The name of the MySQL plugin to manage.

provider

The specific backend to use for this mysql_plugin resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform.

mysql_user

Manage a MySQL user. This includes management of users password as well as privileges.

Properties

The following properties are available in the mysql_user type.

ensure

Valid values: present, absent

The basic property that the resource should be in.

Default value: present

max_connections_per_hour

Valid values: %r{\d+}

Max connections per hour for the user. 0 means no (or global) limit.

max_queries_per_hour

Valid values: %r{\d+}

Max queries per hour for the user. 0 means no (or global) limit.

max_updates_per_hour

Valid values: %r{\d+}

Max updates per hour for the user. 0 means no (or global) limit.

max_user_connections

Valid values: %r{\d+}

Max concurrent connections for the user. 0 means no (or global) limit.

password_hash

Valid values: %r{\w*}

The password hash of the user. Use mysql::password() for creating such a hash.

plugin

Valid values: %r{\w+}

The authentication plugin of the user.

tls_options

Options to that set the TLS-related REQUIRE attributes for the user.

Parameters

The following parameters are available in the mysql_user type.

• name
• provider

name

namevar

The name of the user. This uses the 'username@hostname' or username@hostname.

provider

The specific backend to use for this mysql_user resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform.

Functions

mysql::innobackupex_args

Type: Ruby 4.x API

This function populates and returns the string of arguments which later gets injected in template. Arguments that return string holds is conditional and decided by the the input given to function.

mysql::innobackupex_args(Optional[String] $backupuser, Boolean $backupcompress, Optional[Variant[String, Sensitive[String]]] $backuppassword_unsensitive, Array[String[1]] $backupdatabases, Array[String[1]] $optional_args)

The mysql::innobackupex_args function.

Returns: Variant[String] String Generated on the basis of provided values.

backupuser

Data type: Optional[String]

The user to use for the backup.

backupcompress

Data type: Boolean

If the backup should be compressed.

backuppassword_unsensitive

Data type: Optional[Variant[String, Sensitive[String]]]

The password to use for the backup.

backupdatabases

Data type: Array[String[1]]

The databases to backup.

optional_args

Data type: Array[String[1]]

Additional arguments to pass to innobackupex.

mysql::normalise_and_deepmerge

Type: Ruby 4.x API

• When there is a duplicate key that is a hash, they are recursively merged.
• When there is a duplicate key that is not a hash, the key in the rightmost hash will "win."
• When there are conficting uses of dashes and underscores in two keys (which mysql would otherwise equate), the rightmost style will win.

Examples

$hash1 = {'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } }
$hash2 = {'two' => 'dos', 'three' => { 'five' => 5 } }
$merged_hash = mysql::normalise_and_deepmerge($hash1, $hash2)
# The resulting hash is equivalent to:
# $merged_hash = { 'one' => 1, 'two' => 'dos', 'three' => { 'four' => 4, 'five' => 5 } }

mysql::normalise_and_deepmerge(Any *$args)

• When there is a duplicate key that is a hash, they are recursively merged.
• When there is a duplicate key that is not a hash, the key in the rightmost hash will "win."
• When there are conficting uses of dashes and underscores in two keys (which mysql would otherwise equate), the rightmost style will win.

Returns: Any hash The given hash normalised

Examples

$hash1 = {'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } }
$hash2 = {'two' => 'dos', 'three' => { 'five' => 5 } }
$merged_hash = mysql::normalise_and_deepmerge($hash1, $hash2)
# The resulting hash is equivalent to:
# $merged_hash = { 'one' => 1, 'two' => 'dos', 'three' => { 'four' => 4, 'five' => 5 } }

*args

Data type: Any

Hash to be normalised

mysql::password

Type: Ruby 4.x API

Hash a string as mysql's "PASSWORD()" function would do it

mysql::password(Variant[String, Sensitive[String]] $password, Optional[Boolean] $sensitive)

Hash a string as mysql's "PASSWORD()" function would do it

Returns: Variant[String, Sensitive[String]] hash The mysql password hash from the clear text password.

password

Data type: Variant[String, Sensitive[String]]

Plain text password.

sensitive

Data type: Optional[Boolean]

If the mysql password hash should be of datatype Sensitive[String]

mysql::strip_hash

Type: Ruby 4.x API

When given a hash this function strips out all blank entries.

mysql::strip_hash(Hash $hash)

The mysql::strip_hash function.

Returns: Hash hash The given hash with all blank entries removed

hash

Data type: Hash

Hash to be stripped

mysql_password

Type: Ruby 4.x API

DEPRECATED. Use the namespaced function mysql::password instead.

mysql_password(Variant[String, Sensitive[String]] $password, Optional[Boolean] $sensitive)

The mysql_password function.

Returns: Variant[String, Sensitive[String]] The mysql password hash from the 4.x function mysql::password.

password

Data type: Variant[String, Sensitive[String]]

Plain text password.

sensitive

Data type: Optional[Boolean]

If the mysql password hash should be of datatype Sensitive[String]

Data types

Mysql::Options

Use this if you don’t want your options merged with the default options.

Alias of Hash[String, Hash]

Tasks

export

Allows you to backup your database to local file.

Supports noop? false

Parameters

database

Data type: Optional[String[1]]

Database to connect to

user

Data type: Optional[String[1]]

The user

password

Data type: Optional[String[1]]

The password

file

Data type: String[1]

Path to file you want backup to

sql

Allows you to execute arbitary SQL

Supports noop? false

Parameters

database

Data type: Optional[String[1]]

Database to connect to

user

Data type: Optional[String[1]]

The user

password

Data type: Optional[String[1]]

The password

sql

Data type: String[1]

The SQL you want to execute

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

v16.2.0 - 2024-12-16

Full Changelog

v16.1.0 - 2024-12-09

Full Changelog

Added

• (CAT-2100) Add Debian 12 support #1653 (shubhamshinde360)

Fixed

• (CAT-2158) Upgrade rexml to address CVE-2024-49761 #1656 (amitkarsale)
• Fix backup/rotation with multiple excluded databases #1610 (BuJo)

v16.0.0 - 2024-07-11

Full Changelog

Changed

• Remove deprecated option expire_logs_days from default config #1625 (fraenki)
• (#1619) mysq::db: update charset/collate to utf8mb3/utf8mb3_general_ci #1624 (bastelfreak)
• (CAT-1428) Removal of redhat/scientific/oraclelinux 6 for mysql module #1597 (praj1001)

Added

• Add support for mysqlcluster #1601 (tommy2d)

Fixed

• (CAT-1919) - Handle scenario when user input password in * #1634 (Ramesh7)
• remove ssl-disable notify #1534 (rbelnap)

v15.0.0 - 2023-06-19

Full Changelog

Changed

• pdksync - (MAINT) - Require Stdlib 9.x #1572 (LukasAud)

Added

• (CONT-576) allow deferred function for token & secrets #1569 (Ramesh7)

Fixed

• Fix broken sensitive parameter for mysql::password #1564 (cruelsmith)

v14.0.0 - 2023-04-17

Full Changelog

Changed

• (CONT-789) Add Support for Puppet 8 / Drop Support for Puppet 6 #1557 (david22swan)

v13.3.0 - 2023-04-11

Full Changelog

Added

• mysql::server: Implement reload_on_config_change #1551 (bastelfreak)

Fixed

• move static data from params to server class #1552 (bastelfreak)

v13.2.0 - 2023-02-24

Full Changelog

Added

• (CONT-359) Syntax update #1532 (LukasAud)

Fixed

• xtrabackup.sh only touch when backup_success_file_path is set #1522 (JvGinkel)

v13.1.0 - 2022-12-20

Full Changelog

Added

• mysql::db sql parameter support filenames with multiple dots #1505 (skn-bvdh)

Fixed

• (GH-1518) Declare minimum Puppet version 6.24.0 #1519 (pmcmaw)
• (GH-1516) Update sql example to use array #1517 (pmcmaw)
• do not emit other ssl directives when ssl = false #1513 (kjetilho)
• (GH-1491) Fix for Ubuntu 22.04 #1508 (david22swan)

v13.0.1 - 2022-10-24

Full Changelog

Fixed

• (CONT-173) - Updating deprecated facter instances #1501 (jordanbreen28)
• pdksync - (CONT-189) Remove support for RedHat6 / OracleLinux6 / Scientific6 #1498 (david22swan)
• pdksync - (CONT-130) - Dropping Support for Debian 9 #1495 (jordanbreen28)
• MySQL 8.0: Grant required privileges to xtrabackup user #1478 (jan-win1993)

v13.0.0 - 2022-08-25

Full Changelog

Changed

• Harden db defined type #1484 (chelnak)

Added

• pdksync - (GH-cat-11) Certify Support for Ubuntu 22.04 #1483 (david22swan)
• [Compatibility] Add Raspbian OS to provider configuration #1481 (jordi-upc)
• Allow excludedatabases when using file_per_database #1480 (HT43-bqxFqB)
• pdksync - (GH-cat-12) Add Support for Redhat 9 #1477 (david22swan)

Fixed

• Harden config class #1487 (chelnak)
• Harden service class #1486 (chelnak)
• Harden root password class #1485 (chelnak)
• Use MariaDB for Ubuntu 20.04 #1449 (treydock)
• Add support for mariabackup #1447 (rsynnest)

v12.0.3 - 2022-05-25

Full Changelog

Fixed

• (IAC-1595) MySQL maintenance #1472 (LukasAud)
• Solve issue with repeated restarts if ssl-disable is true #1425 (markasammut)

v12.0.2 - 2022-04-19

Full Changelog

Added

• pdksync - (IAC-1753) - Add Support for AlmaLinux 8 #1444 (david22swan)
• pdksync - (IAC-1751) - Add Support for Rocky 8 #1442 (david22swan)

Fixed

• (Bugfix) Grant privileges idempotency Fix #1466 (LukasAud)
• pdksync - (GH-iac-334) Remove Support for Ubuntu 16.04 #1457 (david22swan)
• pdksync - (IAC-1787) Remove Support for CentOS 6 #1450 (david22swan)
• add mysql_native_password plugin to authentication_string vs password #1441 (Heidistein)
• fix Error: Transaction store file transactionstore.yaml is corrupt #1429 (andreas-stuerz)
• Combine multiple grants into one while checking state #1428 (fuyar)

v12.0.1 - 2021-08-26

Full Changelog

Fixed

• (IAC-1741) Allow stdlib v8.0.0 #1433 (david22swan)
• MODULES-8373 Fix mysql_grant resource to be idempodent on MySQL 8+ #1427 (aponert)

v12.0.0 - 2021-07-27

Full Changelog

Changed

• Deprecate mysql::server::mysqltuner and show it as an example #1409 (ghoneycutt)
• Deprecate mysql::server::monitor and show as an example #1408 (ghoneycutt)
• Remove EOL platforms Debian 8 and Ubuntu 14.04 #1406 (ghoneycutt)

v11.1.0 - 2021-07-05

Full Changelog

Added

• (MODULES-11115) add Rocky Linux 8 compatibility #1405 (vchepkov)
• Use Puppet-Datatype Sensitive #1400 (cocker-cc)

Fixed

• Fix mysql_user parameters update on modern MySQL #1415 (weastur)
• (IAC-1677) Fix issue with deprecated rspec #1414 (ghoneycutt)
• Fix broken link and style in documentation #1403 (ghoneycutt)

v11.0.3 - 2021-06-21

Full Changelog

Fixed

• (IAC-1430) - Minor docs updating #1401 (pmcmaw)

v11.0.2 - 2021-06-07

Full Changelog

Fixed

• (bugfix) - Pull python3-mysqldb in Debian Bullseye #1396 (thomasgoirand)
• Update xtrabackup package name for Ubuntu 20.04 #1387 (rsynnest)

v11.0.1 - 2021-04-19

Full Changelog

Fixed

• Fix: Puppet Unknown variable: 'mysql::params::exec_path' #1378 (JvGinkel)
• (IAC-1497) - Removal of unsupported translate dependency #1375 (david22swan)
• (MODULES-10926) Fix Java binding package for Ubuntu 20.04 #1373 (treydock)

v11.0.0 - 2021-03-01

Full Changelog

Changed

• pdksync - Remove Puppet 5 from testing and bump minimal version to 6.0.0 #1366 (carabasdaniel)

Added

• Support compression command and extension #1363 (dploeger)

Fixed

• pdksync - (MAINT) Remove SLES 11 support #1370 (sanfrancrisko)
• pdksync - (MAINT) Remove RHEL 5 family support #1369 (sanfrancrisko)

v10.10.0 - 2021-02-12

Full Changelog

Added

• Set default MySQL version for FreeBSD #1360 (olevole)

v10.9.1 - 2021-01-07

Full Changelog

Fixed

• Repair check of logbindir #1348 (qha)

v10.9.0 - 2020-12-16

Full Changelog

Added

• (FEAT) Add support for Puppet 7 #1347 (daianamezdrea)
• (IAC-996) Removal of inappropriate terminology #1340 (pmcmaw)

v10.8.0 - 2020-11-04

Full Changelog

Added

• Add compatibility for Amazon Linux 2 #1328 (greno2)

Fixed

• (IAC-1137) Ensure curl package is installed for xtrabackup tests #1338 (pmcmaw)
• (MODULES-10788) - fix for password prompt when creating mysql_login_path resource #1334 (andreas-stuerz)
• (MODULES-10790) - Setting logbin results in error Unknown variable: 'managed_dirs_path' #1325 (pmcmaw)
• Fix package for python bindings on Ubuntu 20.04 #1323 (tobias-urdin)

v10.7.1 - 2020-09-28

Full Changelog

Fixed

• (IAC-1175) Pin percona-release to version 1.0-22 for Debian 8 #1329 (pmcmaw)
• [MODULES-10773] Fix for rh-mysql80 #1322 (carabasdaniel)

v10.7.0 - 2020-08-13

Full Changelog

Added

• pdksync - (IAC-973) - Update travis/appveyor to run on new default branch main #1316 (david22swan)
• add package provider and source #1314 (fe80)

Fixed

• Remove non printable characters #1315 (elmobp)
• Remove control character from manifests/server.pp #1312 (tomkrouper)

v10.6.0 - 2020-06-23

Full Changelog

Added

• Handle cron package from different module #1306 (ashish1099)
• (IAC-746) - Add ubuntu 20.04 support #1303 (david22swan)
• (MODULES-1550) add new Feature MySQL login paths #1295 (andreas-stuerz)

Fixed

• Add managed_dirs parameter #1305 (evgenkisel)
• change split on whitespace to split on tab in mysql_user #1233 (koshatul)

v10.5.0 - 2020-05-13

Full Changelog

Added

• Support mariadb's ed25519-based authentication #1292 (dciabrin)
• Allow changing the mysql-config-file group-ownership #1284 (unki)

Fixed

• Remove legacy (old API) mysql_password function #1299 (alexjfisher)
• Improve differences between generated mysql service id values #1293 (ryaner)
• (MODULES-10023) Fix multiple xtrabackup regressions #1245 (fraenki)
• Fix binarylog by allowing users to specify managed directories #1194 (elfranne)

v10.4.0 - 2020-03-03

Full Changelog

Added

• Allow adapting MySQL configuration file's permissions mode #1278 (unki)
• pdksync - (FM-8581) - Debian 10 added to travis and provision file refactored #1275 (david22swan)
• Allow backupcompress for xtrabackup profile #1196 (Spuffnduff)
• Enable module to not use default options #1192 (morremeyer)

v10.3.0 - 2019-12-11

Full Changelog

Added

• (FM-8677) - Support added for CentOS 8 #1254 (david22swan)

Fixed

• Fix java and ruby binding packages for Debian 10 #1264 (treydock)
• (MODULES-10114) Confine fact for only when mysql is in PATH #1256 (bFekete)

v10.2.1 - 2019-10-31

Full Changelog

Fixed

• Fix mysql::sql task error message #1243 (alexjfisher)
• Fix xtrabackup regression introduced in #1207 #1242 (fraenki)
• Repair mysql_grant docs and diagnostics #1237 (qha)

v10.2.0 - 2019-09-24

Full Changelog

Added

• FM-8406 add support on Debian10 #1230 (lionce)
• Make backup success file path configurable #1207 (HT43-bqxFqB)

Fixed

• No package under FreeBSD #1227 (jas01)
• Fix group on FreeBSD #1226 (jas01)
• Don't run fact when you can't find mysqld #1224 (jstewart612)
• Bugfix on Debian 9 : ruby_package_name must be ruby-mysql2 #1223 (leopoiroux)
• Fix errors for /bin/sh with the xtrabackup cron #1222 (baldurmen)
• Fix/fix dependency issue in freebsd with log error file creation from 10.0.0 #1221 (rick-pri)

v10.1.0 - 2019-07-31

Full Changelog

Added

• Allow backup::mysqldump::time to accept monthday, month, weekday #1214 (malakai97)

v10.0.0 - 2019-06-26

Full Changelog

Added

• add support for rh-mariadb102 #1209 (martin-schlossarek)
• Freebsd compat #1208 (kapouik)

Fixed

• FM-7982 - update provisioner to docker_exp #1205 (lionce)

v9.1.0 - 2019-06-11

Full Changelog

Added

• Add option to specify $backupdir as a symlink target, for use with dm… #1200 (comport3)
• (FM-8029) Add RedHat 8 support #1199 (eimlav)
• Allow own Xtrabackup script #1189 (SaschaDoering)
• Litmus conversion #1175 (pmcmaw)

Fixed

• (MODULES-6875,MODULES-7487) - Fix mariadb mysql_user password idempotency #1195 (alexjfisher)

v9.0.0 - 2019-05-22

Full Changelog

Changed

• pdksync - (MODULES-8444) - Raise lower Puppet bound #1184 (david22swan)

Added

• Make incremental backups deactivable #1188 (SaschaDoering)
• Allow multiple backupmethods #1187 (SaschaDoering)

Fixed

• Fix the contribution guide URL #1190 (morremeyer)
• (MODULES-8886) Revert removal of deepmerge function #1181 (eimlav)
• Fixed Changelog links for 8.1.0 #1180 (morremeyer)

8.1.0 - 2019-04-03

Full Changelog

Added

• Rotate option for xtrabackup script #1176 (elfranne)

Fixed

• (MODULES-6627) Remove unused --host flags from mysqlcaller #1174 (david22swan)
• Set correct packagename for ruby_mysql on Ubuntu 18.04 #1163 (datty)
• [MODULES-8779] Set proper python_package_name for RHEL/CentOS 8 #1161 (javierpena)
• fix install ordering for innodb data size #1160 (fe80)

8.0.1 - 2019-03-20

Full Changelog

Added

• Add support for dynamic backupmethods/mariabackup #1171 (danquack)

Fixed

• (MODULES-8684) - Removing private tags from Puppet Types #1170 (david22swan)

8.0.0 - 2019-01-23

Full Changelog

Changed

• (MODULES-8193) - Removal of inbuilt deepmerge and dirname functions #1145 (david22swan)

Added

• (MODULES-3539) Allow @ in username #1155 (Fogelholk)
• (MODULES-8144) - Add support for SLES 15 #1146 (eimlav)
• Added support for RHSCL mysql versions and support for .mylogin.cnf for MySQL 5.6.6+ #1061 (DJMuggs)

Fixed

• (MODULES-8193) - Wrapper methods created for inbuilt 4.x functions #1151 (david22swan)
• pdksync - (FM-7655) Fix rubygems-update for ruby < 2.3 #1150 (tphoney)
• Add includedir for Gentoo #1147 (baurmatt)
• add mysql_native_password for mariadb 10.2 in password_hash #1117 (mlk-89)
• Removing query_cache ops that are no longer supported in MySQL >= 8.0 #1107 (ernstae)

7.0.0 - 2018-10-25

Full Changelog

Changed

• (MODULES-6923) remove staging module #1115 (tphoney)

Added

• (MODULES-7857) Support user creation on galera #1130 (MaxFedotov)
• MySQL 8 compatibility in user management #1092 (zpetr)

Fixed

• (MODULES-7487) Check authentication string for user password on MariaDB 10.2.16+ #1135 (gguillotte)

6.2.0 - 2018-09-28

Full Changelog

Added

• pdksync - (MODULES-6805) metadata.json shows support for puppet 6 #1127 (tphoney)

Fixed

• (maint) - Change versioning comparison #1123 (eimlav)

6.1.0 - 2018-09-13

Full Changelog

Fixed

• pdksync - (MODULES-7705) - Bumping stdlib dependency from < 5.0.0 to < 6.0.0 #1114 (pmcmaw)
• (MODULES-6981) Do not try to read ~root/.my.cnf when calling "mysqld -V" #1063 (simondeziel)

6.0.0 - 2018-08-02

Full Changelog

Changed

• [FM-6962] Removal of unsupported OS from mysql #1086 (david22swan)

Added

• (FM-5985) - Addition of support for Ubuntu 18.04 to mysql #1104 (david22swan)
• (MODULES-7439) - Implementing beaker-testmode_switcher #1095 (pmcmaw)
• Support for optional__args and prescript to mysqldump backup provider #1083 (eputnam)
• Allow empty user passwords #1075 (ThoTischner)
• Add user tls_options and grant options to mysql::db #1065 (edestecd)
• Use puppet4 functions-api #1044 (juliantodt)

Fixed

• (MODULES-7353) Enable service for Debian 9 #1094 (david22swan)
• Update locales test for Debian 9 #1091 (HelenCampbell)
• [FM-7045] Fix to allow Debian 9 test's to run clean #1088 (david22swan)
• (MODULES-7198) Fix DROP USER IF EXISTS on mariadb #1082 (hunner)

5.4.0 - 2018-05-23

Full Changelog

Added

• (PDOC-210) add Puppet Strings documentation #1068 (hunner)
• (PDOC-210) add Puppet Strings documentation #1062 (eputnam)
• (MODULES-5618) Hide logging of password_hash changes in mysql::user #993 (jhriggs)
• Replaced 'DROP USER' with 'DROP USER IF EXISTS' #942 (xelmido)

Fixed

• (MODULES-6627) Removes unused --host flag from mysqlcaller #1064 (HelenCampbell)
• fix archlinux compatibility #1057 (bastelfreak)
• changed input param option in export.json from sql to file #1054 (cgoswami)
• PROCESS is now required #958 (elmobp)

5.3.0 - 2018-02-20

Full Changelog

5.2.1 - 2018-02-02

Full Changelog

5.2.0 - 2018-01-19

Full Changelog

Changed

• (maint) - Removing Debian 9 #1020 (pmcmaw)

Added

• (MODULES-4794) Add paths for RHSC #1039 (hunner)
• (MODULES-3623) Centralise MySQL calls... #1036 (hunner)
• #puppethack allow undef value for bind-address #1035 (JvGinkel)
• Add Export database task #1018 (slenky)
• Add support for GRANTS FUNCTION #1005 (joshuaspence)
• Allow authentication plugin to be changed #1004 (joshuaspence)

5.1.0 - 2017-10-11

Full Changelog

5.0.0 - 2017-10-05

Full Changelog

Added

• Updating PO file to match strings in POT file and code base. #1010 (pmcmaw)

Fixed

• refactor php_package_name default for Debian/Ubuntu #969 (mmoll)

4.0.1 - 2017-09-09

Full Changelog

Added

• (MODULES-5528) mysql_install_db change to optional #990 (HelenCampbell)

Fixed

• (MODULES-5602) remove superfluous backslashes from regular expressions #989 (DavidS)

4.0.0 - 2017-09-07

Full Changelog

Changed

• replace validate_* with datatypes in db.pp #930 (bastelfreak)

Fixed

• MODULES-5405 interpolation for puppet strings #984 (tphoney)
• interpolation for ruby & puppet code. #983 (tphoney)
• Updated pot file, decorated simple strings #978 (tphoney)
• Fixing empty user/password issue #972 (ajardan)
• (MODULES-4604) move name validation in mysql_grant type #961 (eputnam)
• (MODULES-4115) Invalid parameter provider on Mysql_user[user@localhost] in mysql::db #912 (ryanb-hc)

3.11.0 - 2017-05-08

Full Changelog

Added

• (#4534) Add PROXY grant support to mysql_grant #934 (jhriggs)
• Add a file in /tmp to check when the last backup was successful #907 (ampersand8)

Fixed

• Do not wait for mysql socket to open if service_ensure is stopped #948 (sw0x2A)
• (MODULES-4743) mysql : cannot initialize database dir not empty #945 (shawnferry)
• Only install bzip2 if backupcompress #933 (edestecd)
• Use gfind on solaris #920 (marvin0815)

Other

• Enhancements to xtrabackup backup provider #902 (fraenki)

3.10.0 - 2016-11-07

Full Changelog

Added

• Add support for setting tls options for mysql_user's #896 (JAORMX)
• MODULES-3907 Add MySQL/Percona 5.7 initialize on fresh deploy #892 (QuentinMoss)
• Add support for REQUIRE SSL|X509 option #888 (edestecd)

Fixed

• Revert "Add support for REQUIRE SSL|X509 option" #895 (hunner)
• fixes problem with package name change from php5-mysql to php-mysql on 16.04 #889 (ppouliot)

Other

• Added parameter import_cat_cmd #891 (jkroepke)

3.9.0 - 2016-09-06

Full Changelog

Added

• (MODULES-3698) Updates defaults for SLES12 #881 (bmjen)
• MODULES-3711 - Add limit to mysql server ID generated value #872 (QuentinMoss)
• parametrize xtradb package name #860 (ndelic0)
• add new backup dump parameter maxallowedpacket #856 (cfasnacht)
• [MODULES-3441] Discover mysql version using facts #852 (jtopper)

Fixed

• revoking GRANT privilege fix #880 (bodik)
• Ensure that error log is writable by owner #877 (runejuhl)
• MODULES-3697 Changed puppet fail behaviour for mysql create user and grant if user name is longer than 16 chars #871 (dn1s)
• (MODULES-3401) Fix for mysql version retrieval #869 (HelenCampbell)
• MODULES-3601 Move binary logging configuration to take place after pa… #868 (QuentinMoss)
• Resource fails when fqdn is not set. #853 (ragonlan)
• Fix global parameter usage in backup script #840 (HT43-bqxFqB)

3.8.0 - 2016-05-31

Full Changelog

Added

• Support mysql_install_db script on Gentoo #838 (glorpen)
• (MODULES-2111) Add the system database to user related actions. #830 (fvanboven)
• Added bzip2 package support on mysqldump backup #827 (lcrisci)

Fixed

• Revert "Use mariadb by default for Debian Jessie (#845)" #847 (DavidS)
• Find MySQL 5.5 installation on CentOS #842 (jjagodzinski)
• Fixed an issue with Amazon linux major release 4 installation #837 (megianni)
• default group for logfiles on Debian/Ubuntu should be adm #836 (fschndr)
• Check that /var/lib/mysql actually contains files. #834 (jonnytdevops)
• move out $options['mysqld']['log-error'] from service.pp into installdb.pp #833 (ndelic0)
• make sure we find mysqld on FreeBSD #831 (fraenki)
• remove erroneous anchors to mysql::client from mysql::db #829 (vicinus)
• Remove mysql regex when checking type #828 (s-t-e-v-e-n-k)
• Default mysqld_type should be "mysql" #824 (ih84ds)
• (FM-5050) Configure the base of includedir #821 (DavidS)
• (MODULES-1256) Fix parameters on OpenSUSE 12 #820 (hunner)
• Remove mysql_table_exists() function #815 (hunner)
• Config before install #813 (tomkrouper)
• Loosen MariaDB recognition to fix it on Debian 8 #812 (koubas)
• Fixed global parameters skipped #811 (pashamesh)
• Use mysql_install_db only with uniq defaults-extra-file #809 (mmalchuk)

3.7.0 - 2016-03-11

Full Changelog

Added

• Ubuntu vivid should use systemd not upstart #769 (gabriel403)

Fixed

• (#3028) Fix mysql_grant with MySQL ANSI_QUOTES mode #796 (jhriggs)
• Re-Add the ability to set a empty string as option parameter #791 (roidelapluie)
• (MODULES-2676) Fixed new mysql_datadir provider on CentOS for MySQl 5.7.6 compatibility #789 (elconas)
• Fixing error when disabling service management and the service does not exist #787 (obi11235)
• ensure if service restart to wait till mysql is up #784 (vicinus)
• Fixes edge-case with dropping pre-existing users with grants #779 (jmcclell)

3.6.2 - 2015-12-04

Full Changelog

Added

• MODULES-2650 Add support for renamed password column #760 (roman-mueller)

Fixed

• Use temp cnf file instead of env variable. #778 (mentat)
• (MODULES-2767) fix mysql_table_exists: add check for args.size, fix rspec test #777 (agadelshin)
• (MODULES-2767) allow to check if table exists before grant #776 (agadelshin)
• (MODULES-2605) Use MYSQL_PWD to avoid mysqldump warnings. #775 (abednarik)
• (MODULES-2787) Fixes for future parser #773 (paco0x)
• (MODULES-2490) correct the daemon_dev_package_name for mariadb on redhat #768 (DavidS)
• Fixes unique server_id within my.cnf Ticket/MODULES-2675 #767 (jkarns87)
• (MODULES-2683) fix version compare to properly suppress show_diff for… #766 (DavidS)

Other

• Using mariadb in OpenSuSE >= 13.1. #572 (sharumpe)

3.6.1 - 2015-09-22

Full Changelog

Fixed

• Fix when not managing config file #751 (mcanevet)
• Fixes improper use of function 'warn' in backup manifest of server. #749 (Herr-Herner)

3.6.0 - 2015-08-11

Full Changelog

Added

• (MODULES-2340) Implement script functionality for xtrabackup provider #744 (danzilio)

Fixed

• (PUP-5021) depend on package title, not name #746 (hunner)
• #2030 Only establish dependency between service and package if package is managed. #745 (jonnytdevops)
• Fix show_diff already set on .my.cnf #743 (michaeltchapman)
• Ensure idempotency between Puppet runs #742 (EmilienM)
• Dont print root #739 (hunner)
• [#puppethack] do not require mysql::server when using mysql::db #736 (igalic)
• Remove default install root password if set #682 (JCotton1123)

3.5.0 - 2015-07-29

Full Changelog

Added

• Add Solaris support to MySQL module #729 (drewfisher314)
• Add helper to install puppet/pe/puppet-agent #725 (hunner)
• length check for usernames should take mysql version into consideration #722 (igalic)

Fixed

• Don't explode if macaddress isn't set #730 (binford2k)
• fix Evaluation Error with future parser #728 (timogoebel)
• (MODULES-2077) Fixes wrong dependency variable #719 (Spredzy)
• Fixed server package name so it isn't hardcoded to mysql #718 (igalic)

3.4.0 - 2015-05-19

Full Changelog

Added

• Added options for including/excluding triggers and routines to the mysql::server::backup module #705 (stevesaliman)
• Adds default values for parameters and align assignments #699 (melan)
• Added server_id fact #676 (igalic)
• Add OpenBSD support. #567 (buzzdeee)

Fixed

• update to proper defaults for freebsd #712 (sethlyons)
• (fix) - Change default for mysql::server::backup to ignore_triggers =… #711 (cyberious)
• (fix) - Fix issue where fact is unknown at start - Resolve issue where if known and failed versioncmp would result in idempotency issue on second run #709 (cyberious)
• MODULES-1981: Revoke and grant difference of old and new privileges #706 (agadelshin)
• Bugfix on Xtrabackup crons #700 (mvisonneau)
• fix FreeBSD support for backups #697 (fraenki)
• Fix regression introduced by adding OpenBSD support. #691 (buzzdeee)
• Manage service only if managed #688 (mremy)
• mysql backup: fix regression in mysql_user call #687 (igalic)
• Only set up ordering between the config file and the service if we're managing the config file. #672 (timmooney)

Other

• (fix) - Check for mysql_verison before assuming that triggers are a valid permission #708 (cyberious)

3.3.0 - 2015-03-03

Full Changelog

Added

• (MODULES-1804) Allow override of log-error #678 (hunner)
• Use backup providers #649 (dveeden)
• (MODULES-1143) Add package_manage parameters #617 (juniorsysadmin)

Fixed

• PR 654 was incorrectly using stdlib dirname #677 (underscorgan)
• Fix bug in 578 #671 ()
• Check for full path for log-bin to stop puppet from managing directory “." #654 (NoodlesNZ)

3.2.0 - 2015-02-10

Full Changelog

Added

• Support authentication plugins #645 (dveeden)
• Add type & provider for managing plugins #641 (dveeden)
• Support for authentication plugins #640 (dveeden)
• mysql_install_db freebsd support #616 (takumin)
• Add new parameters create_root_user and create_root_my_cnf. #578 (franzs)

Fixed

• MODULES-1759: Remove dependency on stdlib >=4.1.0 #661 (underscorgan)
• Bugfix: increase minimum stdlib #660 (hunner)
• Make grant autorequire user #658 (hunner)
• Revert "(#MODULES-1058) root_password.pp cannot create /root/.my.cnf due... #656 (cyberious)
• (MODULES-1731) Invalid parameter 'provider' removed from mysql_user instance. #655 (rnelson0)
• (#MODULES-1058) root_password.pp cannot create /root/.my.cnf due to depe... #651 (lodgenbd)
• Return an empty string for an empty input. #646 (dveeden)
• Revert "Support for authentication plugins" #644 (cmurphy)
• Make sure the example is somewhat secure #638 (dveeden)
• Do the right thing when fqdn==localhost #637 (dveeden)
• Future parser fix in params.pp #632 (underscorgan)
• under Debian 8 package name for ruby mysql biding is called ruby-mysql, ... #629 (Zouuup)
• ensure mysql-config-file and server package is in place before trying to... #615 (KlavsKlavsen)

3.1.0 - 2014-12-16

Full Changelog

Added

• (MODULES-1338) Allow mysql::db to import several files #574 (Spredzy)

Fixed

• Remove mysqltuner, fetch with staging instead #624 (underscorgan)
• Fix issues introduced in puppetlabs/puppetlabs-mysql#612 #623 (underscorgan)
• Use puppet() instead of shell() to install module dependencies #622 (underscorgan)
• Reworked all identifier quoting detections #612 (lavoiesl)
• Fix operating system release fact for SLES #611 (cmurphy)
• Fix support for SLES 12 #610 (cmurphy)
• Default to MariaDB for SLES 12 #608 (cyberious)
• Proper containment for mysql::client in mysql::db #605 (slamont)
• Fix regression in username validation #602 (MasonM)
• Create log-bin directory if it doesn't exist #596 (NoodlesNZ)

3.0.0 - 2014-11-11

Full Changelog

Added

• [MODULES-1484] Add support for install_options for all package resources... #591 (damonconway)
• Improve checks for MySQL user's name. #588 (maxenced)
• Add support for Gentoo #585 (dev-zero)
• [MODULES-1333] Add explicit dependencies for mysql_database and mysql_user types #571 (jtopper)
• (MODULES-552) Add capability to specify column_privileges #570 (fnerdwq)
• (MODULES-1330) Change order of revokation. #569 (fnerdwq)
• Parametrize !includedir #509 (xbezdick)

Fixed

• Fix escaped backslashes in grants #594 (skroll)
• The old regex requires something after the 'host' part. Fix this. #587 (maxenced)
• Oracle 7 uses mariadb #582 (cmurphy)
• Install bzip2 on RHEL 7 and Fedora hosts #580 (cmurphy)
• Ensure error log is present before trying to manage ownership #579 (cmurphy)
• Change sql param to default to undef instead of empty string #577 (cmurphy)
• future parser converts explicit undef to empty string #568 (edestecd)
• mysql_database: prevent syntax error with collate=>'binary' #565 (mmonaco)
• Fix issue with puppet_module_install, removed and using updated method f... #564 (cyberious)
• (MODULES-1287) Pass the backup credentials to 'SHOW DATABASES' #559 (nhinds)
• Fixes manage_service feature #558 (paramite)
• Remove all the deprecated code. #553 (apenney)
• Prevent ERROR 1008 in mysql_database provider #547 (rayl)
• Make sure we actually notify the service. #546 (igalic)
• Fix problem with GRANT not recognizing backslash #540 (jsosic)
• Grants for the backupuser should be conditional #539 (stevesaliman)

2.3.1 - 2014-07-18

Full Changelog

2.3.0 - 2014-07-11

Full Changelog

Added

• Install MySQL client and daemon dev libraries. #510 (Aethylred)
• Add quotes to backup password to be able to use more complex passwords. #495 (mauerj)
• Allow to use different name for db resource other than db name #489 (xcompass)

Fixed

• Handle changing the datadir properly. #536 (apenney)
• Change grant provider to ignore grants for non existing users. #530 (spil-jaak)
• (MODULES-1096) Fix double quote / single quote issue in params.pp. #526 (spil-jaak)
• fix param client_package_ensure #523 (davidmmiller)
• Require title of mysql_grant resource to match form user/table #522 (cmurphy)
• Change the package name in the manifest, too! #513 (underscorgan)
• Package rename in Ubuntu 14.04. #512 (underscorgan)
• Rhel7 fixes #511 (underscorgan)
• Improve this so it works on Ubuntu 14.04. #507 (apenney)
• lowercase hostname values in qualified usernames #505 (larsks)
• Replaced database_user with mysql_user #501 (ryansechrest)
• User needs PROCESS privilege when doing file-per-database backup #500 (nerdlich)
• [BUG][Critical] Removing extra space after slash in mysqlbackup.sh #490 (seocam)
• fix #487 mysql not starting if ssl is not disabled #488 (globin)
• backup script test: Actually loop through a list #479 (igalic)
• handle mysql compiled without ssl #477 (globin)
• mysqlbackup.sh should be able to find mysql #457 (igalic)

2.2.3 - 2014-03-04

Full Changelog

Fixed

• Replace the symlink with the actual file to resolve a PMT issue. #484 (apenney)

2.2.2 - 2014-03-03

Full Changelog

Added

• Add unsupported infrastructure for excluding OSes we can't test on. #470 (apenney)

Fixed

• Last SLES fix, don't use the deprecated parameter name. #469 (apenney)
• This fixes: #467 (apenney)
• As we're deleting /etc/my.cnf, lets not restart MySQL in the middle #466 (apenney)
• Fix the case of this, ARGH. #465 (apenney)
• Make this work in SLES as well As RedHat. #464 (apenney)

2.2.1 - 2014-02-19

Full Changelog

Fixed

• Fix this test for Debian. This is a total hack for now. #455 (apenney)
• Fixes for Ubuntu/Debian. #454 (apenney)
• Repair this by ensuring calls to mysql include the database name. #452 (apenney)

2.2.0 - 2014-02-13

Full Changelog

Added

• Add check for puppet rpm before trying to install #445 (Phil0xF7)
• Add logic to ignore mysql.events #435 (b4ldr)
• option to specify a script that runs after backups #413 (igalic)
• Restart #401 (apenney)
• Support multiple lines of the same option #398 (fridim)
• Added [if not exists] to [create database] clause. #397 (srinathman)
• Parameterize backup directory mode and ownership #375 (ezheidtmann)

Fixed

• Fix this so it installs PE appropriately. #447 (apenney)
• mysql_deepmerge should treat underscore and dash equivalently, as mysql does #428 (radford)
• Allow override_options set to undef to completely remove the corresponding key reverting to the mysql default #427 (radford)

• Allow an option with a value of false to override something that mysql defaults to true rather than eliding it [#426](https://github.com/puppetlabs/puppetlabs-mysql/pull/426) ([radford](https://github.com/radford))
  

• Actually use upstart on Ubuntu by fixing misspelled variable name #425 (radford)
• fixed a problem with the mysql_database provider #422 (stevesaliman)
• Remove duplicate service_provider description #421 (lboynton)
• mysql_grant fixed to properly handle PROCEDURE grants #412 (dgolja)
• my.cnf: typo fix (bind-address) + migrate key_buffer (deprecated) to key_buffer_size #395 (doc75)
• Mysql grant fixes #391 (vicinus)
• Fix missing mysql::config when including mysql #385 (liwo)
• Type mysql_grant fixed, spec test created #376 (w32-blaster)
• Fix having wildcards (%) in hostnames of grants #366 (liwo)

Other

• changed log_error to log-error and pid_file to pid-file to match the mys... #394 (danielfoglio)

2.1.0 - 2013-11-13

Full Changelog

Added

• added * for table name in title to match documented usage #355 (tekenny)
• Add Anchor pattern to client.pp #343 (Bit-Doctor)
• Adds example to set root password #341 (spuder)
• Further improvements to our matching - stop trying to guess what #319 (apenney)
• Improve mysql_grant to work with IPv6. #308 (apenney)
• Extend coverage to the contents of /etc/my.cnf. #302 (apenney)

Fixed

• Method for loading .my.cnf file is changed from "defaults-file" to "defaults-extra-file" (mysql option) #367 (w32-blaster)
• Some options can not take a argument. #364 (jglenn9k)
• Fix the broken anchoring. #358 (apenney)
• fix for the fix: database -> database_user #353 (igalic)
• database_user gives the wrong deprecation warning #345 (igalic)
• Fix an issue with lowercase privileges. #342 (apenney)
• Fix ordering causing mysql_grant to reapply. #332 (apenney)
• Updated my.cnf template to support items with no values #316 (tekenny)
• Previously we were matching to ensure that usernames matched #312 (apenney)
• Fix mysql::server::monitor mysql_grant privileges #303 (treydock)
• Duplicate parameter removed. #298 (apenney)

2.0.1-rc1 - 2013-10-03

Full Changelog

2.0.0-rc1 - 2013-10-03

Full Changelog

Changed

• Completely redesign the MySQL module. #258 (apenney)

Added

• Add all the params here as undef to make it clear what the intent is. #296 (apenney)
• Add collation with the create statement #291 (inkblot)
• Improvements to mysql_grant. #276 (apenney)
• Update mysqltuner.pp #273 (davidcollom)
• Support Fedora's rolling development "release", Rawhide #241 (judge-red)

Fixed

• Use mysql::server::root_password instead of @options. #288 (apenney)
• Add 3.3, strip down the excludes. #286 (apenney)
• Fix mysql::client. #285 (apenney)
• Removing the bindings compat stuff. #280 (apenney)
• Remove mysql::globals. #278 (apenney)

1.0.0 - 2013-09-23

Full Changelog

Changed

• WIP: database_user and database refactoring #248 (apenney)

Added

• Add option so mysql::backup to dump each database to its own file #253 (treydock)
• Add HOME environment variable for .my.cnf to mysqladmin command #245 (embeepea)
• Added support to back up specified databases only with 'mysqlbackup' #244 (cfeskens)
• Add environment variable for .my.cnf and specs #243 (hunner)
• Add compatibility classes to handle the backwards incompatible changes. #237 (apenney)

Fixed

• Fix this so we don't list dates or versions yet. #238 (apenney)
• Fix puppet 2.6 compatibility #235 (ekohl)
• Refactor MySQL bindings and client packages. #232 (apenney)
• Update my.cnf.pass.erb to allow custom socket support #227 (hunner)

0.9.0 - 2013-07-15

Full Changelog

Fixed

• Remove redundant hard coded replication parameters #224 (3flex)
• include mysql_client package as a requirement for the db creation #222 (wolfspyre)
• Fixes suggested by RubyMine (just playing around with it) #219 (apenney)

0.8.1 - 2013-07-10

Full Changelog

0.8.0 - 2013-07-10

Full Changelog

Added

• Support max_user_connections in database_user #215 (mbakke)
• Use $root_home for .my.cnf #214 (paramite)
• Add basic specs for database provider. #211 (apenney)
• add a maximum connection parameter and set the default to 1000 #198 (mhellmic)
• add mysql::perl helper class #187 (rsrchboy)
• Implement character_set and other options #167 (abraham1901)
• handling of my.cnf config file is now optional #132 (savar)

Fixed

• Fixed PID file location for SLES 11 SP2. #216 (vakuum)
• Cover Fedora 19's move from mysql to mariadb packages #210 (judge-red)
• Database user refactor/tests #208 (apenney)
• (WIP) #20562: Minor fix for ordering #186 (apenney)
• Harden mysqlbackup.sh script #170 (omalashenko)
• Quote the password #166 (ekohl)
• add ft_min_word_len and ft_max_word_len config options #165 (leinaddm)
• fixes #19744 - no restart on root/.my.cnf change #162 (frimik)

0.7.0 - 2013-06-25

Full Changelog

Added

• Parameterized max_allowed_packet my.conf config setting, because it is needed to setup puppet-dashboard. #179 (msmithgu)

Fixed

• Update template for #179 #201 (hunner)
• make tmpdir configurable #200 (hunner)
• Fix SQL when ANSI_QUOTES is enabled in mysql config. #199 (hunner)
• change the distribution osfamily from Redhat into RedHat #197 (mhellmic)
• fix puppet warning default_engine #188 (gimler)
• fix variables in templates #185 (ChrisRut)
• python_package_name parameter missing #178 (wolfspyre)
• [Important] Fix default-storage-engine default value #171 (ctrlaltdel)
• Refactor to put a knob on all parameters #169 (wolfspyre)
• Puppet 2.6 fix #163 (domcleal)
• Restrict the versions and add 3.1 #155 (richardc)
• Fix issue with redeclaration of database_user via mysql::db #154 (pbrit)
• Update travis config file #148 (blkperl)

0.6.1 - 2013-01-11

Full Changelog

Fixed

• Patch providers for absent my.cnf #141 (hunner)

0.6.0 - 2013-01-09

Full Changelog

Added

• Add php support #137 (hunner)
• Added SuSE support to puppetlabs-mysql #136 (deadpoint)
• add parameter to remove old files in conf.d dir #131 (saz)
• allow logging via syslog #130 (saz)
• Optionally manage the mysqld service #122 (hunner)
• Mysql::backup Compression Optional #117 (hunner)
• Add show view privilege for backup user #108 (pbrit)
• new config define and a small bugfix #93 (savar)

Fixed

• Update manifests/server/monitor.pp #134 (nikolavp)
• fixed character-set detection regex #133 (obilodeau)
• account security should not fail if hostname == fqdn #128 (bodepd)
• fix mysql bug #126 (bodepd)
• Create /root/.my.cnf even when root passwd is not managed #125 (bodepd)
• Root credentials #123 (hunner)
• Restart optional and minor doc fix #115 (frimik)
• Don't assign to hash after creation #114 (dalen)
• Update mysql::backup privs for #108 #112 (hunner)

0.5.0 - 2012-08-23

Full Changelog

Added

• Add bind address unset #106 (hunner)
• Added an option to specify db status. #101 (martasd)
• Add support for Amazon Linux. #94 (hunner)
• Add priv validation to database_grant provider #91 (reidmv)
• Add a bunch of new parameters #90 (emonty)

Fixed

• Change list passed into validate_re to a stringe #105 (derekhiggins)
• Parameterized pidfile; critical for successful first restart #102 (jkff)
• Clarify how to grant specific privileges with database_grant #100 (mcary)
• Revert "Merge pull request #90 from emonty/master" #97 (bodepd)
• Put that curly brace in the right place this time #96 (branan)
• Add a missing curly brace #95 (branan)
• Escape $root_password during execs. #73 (razorsedge)

0.4.0 - 2012-07-24

Full Changelog

Added

• Add enabled parameter to mysql::server #81 (bodepd)
• Allow consumer to specify default storage engine for MySQL server. #74 (jmchilton)
• Added mysql::backup class. #64 (razorsedge)
• Added mysql::server::account_security class. #63 (razorsedge)

Fixed

• add missing db param to database_grant #83 (agerlic)
• escape database name #82 (agerlic)
• Default types hacks not needed. #76 (rdrgmnzs)
• Fixed regex of database user. #71 (razorsedge)

0.3.0 - 2012-05-04

Full Changelog

Added

• Allow wildcard host assignment with sql. #68 (razorsedge)
• Query the database for possible permissions #65 (branan)
• Java #61 (razorsedge)

Fixed

• (#14316) Make privileges case-insensitive #69 (branan)
• I noticed the following message whilst provisioning using this module: #60 (geogdog)
• set platform dependent error logfile location #58 (derekhiggins)

0.2.0 - 2012-04-11

Full Changelog

Added

• (#13203) Add ssl support #54 (blkperl)

Fixed

• Fix mysql service on Ubuntu. #50 (nanliu)
• (#13163) Datadir should be configurable #47 (blkperl)
• Fix issues from nans massive pull request #45 (bodepd)
• #11963 In the mysql module the Exec[mysqld-restart] should have more in path #42 (fcharlier)
• Refactor mysql module. #41 (nanliu)
• (#12412) mysqltuner.pl update #38 (grooverdan)
• (#11508) Only load sql_scripts on DB creation #28 (ccaum)
• Bug #11375: puppetlabs-mysql fails on CentOS/RHEL #27 (justintime)

v0.0.1 - 2011-12-13

Full Changelog