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. 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.

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'],
}

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

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.

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_grant: @summary Manage a MySQL user's rights.
• mysql_login_path: Manage a MySQL login path.
• mysql_plugin: Manage MySQL plugins.
• mysql_user: @summary Manage a MySQL user. This includes management of users password as well as privileges.

Private Resource types

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

Functions

• 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: Any

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: Any

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

Default value: false

perl_enable

Data type: Any

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

Default value: false

php_enable

Data type: Any

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

Default value: false

python_enable

Data type: Any

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

Default value: false

ruby_enable

Data type: Any

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

Default value: false

client_dev

Data type: Any

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

Default value: false

daemon_dev

Data type: Any

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

Default value: false

java_package_ensure

Data type: Any

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: Any

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: Any

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: Any

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: Any

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: Any

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: Any

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: Any

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: Any

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: Any

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: Any

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: Any

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: Any

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: Any

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: Any

What provider should be used to install the package.

Default value: $mysql::params::ruby_package_provider

client_dev_package_ensure

Data type: Any

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: Any

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: Any

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: Any

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: Any

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: Any

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: Any

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

Default value: $mysql::params::bindings_enable

install_options

Data type: Any

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: Any

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: Any

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

Default value: $mysql::params::client_package_manage

package_name

Data type: Any

The name of the MySQL client package to install.

Default value: $mysql::params::client_package_name

package_provider

Data type: Any

Default value: undef

package_source

Data type: Any

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
• install_secret_file
• 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
• mysql_group
• mycnf_owner
• mycnf_group
• root_password
• service_enabled
• service_manage
• service_name
• service_provider
• create_root_user
• create_root_my_cnf
• users
• grants
• databases
• enabled
• manage_service
• old_root_password
• managed_dirs
• create_root_login_file
• login_file

config_file

Data type: Any

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

Default value: $mysql::params::config_file

config_file_mode

Data type: Any

The MySQL configuration file's permissions mode.

Default value: $mysql::params::config_file_mode

includedir

Data type: Any

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

Default value: $mysql::params::includedir

install_options

Data type: Any

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

Default value: undef

install_secret_file

Data type: Any

Path to secret file containing temporary root password.

Default value: $mysql::params::install_secret_file

manage_config_file

Data type: Any

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

Default value: $mysql::params::manage_config_file

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: Any

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: Any

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

Default value: $mysql::params::server_package_ensure

package_manage

Data type: Any

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

Default value: $mysql::params::server_package_manage

package_name

Data type: Any

The name of the MySQL server package to install.

Default value: $mysql::params::server_package_name

package_provider

Data type: Any

Define a specific provider for package install.

Default value: undef

package_source

Data type: Any

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

Default value: undef

purge_conf_dir

Data type: Any

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

Default value: $mysql::params::purge_conf_dir

remove_default_accounts

Data type: Any

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

Default value: false

restart

Data type: Any

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

Default value: $mysql::params::restart

root_group

Data type: Any

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

mysql_group

Data type: Any

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: Any

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

Default value: $mysql::params::mycnf_owner

mycnf_group

Data type: Any

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

Default value: $mysql::params::mycnf_group

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: $mysql::params::root_password

service_enabled

Data type: Any

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

Default value: $mysql::params::server_service_enabled

service_manage

Data type: Any

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

Default value: $mysql::params::server_service_manage

service_name

Data type: Any

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: Any

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

Default value: $mysql::params::server_service_provider

create_root_user

Data type: Any

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: $mysql::params::create_root_user

create_root_my_cnf

Data type: Any

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: $mysql::params::create_root_my_cnf

users

Data type: Any

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

Default value: {}

grants

Data type: Any

Optional hash of grants, which are passed to mysql_grant.

Default value: {}

databases

Data type: Any

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

Default value: {}

enabled

Data type: Any

Deprecated

Default value: undef

manage_service

Data type: Any

Deprecated

Default value: undef

old_root_password

Data type: Any

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

managed_dirs

Data type: Any

Default value: $mysql::params::managed_dirs

create_root_login_file

Data type: Any

Default value: $mysql::params::create_root_login_file

login_file

Data type: Any

Default value: $mysql::params::login_file

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',
}
class { 'mysql::server::backup':
  backupmethod => 'mariabackup',
  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

backupuser

Data type: Any

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: Any

Directory to store backup.

Default value: undef

backupdirmode

Data type: Any

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

Default value: '0700'

backupdirowner

Data type: Any

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

Default value: 'root'

backupdirgroup

Data type: Any

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

Default value: $mysql::params::root_group

backupcompress

Data type: Any

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

Default value: true

backupmethod

Data type: Any

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

Default value: undef

backup_success_file_path

Data type: Any

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

Default value: '/tmp/mysqlbackup_success'

backuprotate

Data type: Any

Backup rotation interval in 24 hour periods.

Default value: 30

ignore_events

Data type: Any

Ignore the mysql.event table.

Default value: true

delete_before_dump

Data type: Any

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: Any

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

Default value: []

file_per_database

Data type: Any

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

Default value: false

include_routines

Data type: Any

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

Default value: false

include_triggers

Data type: Any

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

Default value: false

incremental_backups

Data type: Any

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

Default value: true

ensure

Data type: Any

Default value: 'present'

time

Data type: Any

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: Any

A script that is executed before the backup begins.

Default value: false

postscript

Data type: Any

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: Any

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: Any

Sets the server backup implementation. Valid values are:

Default value: 'mysqldump'

maxallowedpacket

Data type: Any

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: Any

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: Any

Manage installation of cron package

Default value: true

compression_command

Data type: Any

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: Any

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

Default value: undef

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:

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

user

Data type: Any

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: Any

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

Default value: undef

dbname

Data type: Any

The name of the database to create.

Default value: $name

charset

Data type: Any

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: 'utf8'

collate

Data type: Any

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: 'utf8_general_ci'

host

Data type: Any

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

Default value: 'localhost'

grant

Data type: Any

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

Default value: 'ALL'

grant_options

Data type: Any

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

Default value: undef

sql

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

The path to the sqlfile you want to execute. This can be single file specified as string, or it can be an array of strings.

Default value: undef

enforce_sql

Data type: Any

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: Any

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

Default value: 300

import_cat_cmd

Data type: Any

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: Any

Default value: undef

Resource types

mysql_grant

@summary 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

@summary 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::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)

The mysql::password function.

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 Postgresql-Passwordhash 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]

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

Change log

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.

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

Fixed

• add mysql_native_password plugin to authentication_string vs password #1441 (Heidistein)
• fix Error: Transaction store file transactionstore.yaml is corrupt #1429 (andeman)
• pdksync - (MAINT) Remove RHEL 5 family support #1369 (sanfrancrisko)
• pdksync - (MAINT) Remove SLES 11 support #1370 (sanfrancrisko)
• pdksync - (GH-iac-334) Remove Support for Ubuntu 16.04 #1457 (david22swan)
• (Bugfix) Grant privileges idempotency Fix #1466 (LukasAud)

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 (theq86)

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

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 - (MAINT) Remove SLES 11 support #1370 (sanfrancrisko)
• pdksync - (MAINT) Remove RHEL 5 family support #1369 (sanfrancrisko)
• pdksync - Remove Puppet 5 from testing and bump minimal version to 6.0.0 #1366 (carabasdaniel)

Added

• Support compression command and extension #1363 (dploeger)

v10.10.0 (2021-02-11)

Full Changelog

Added

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

v10.9.1 (2021-01-06)

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-03)

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 (andeman)
• (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-25)

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-12)

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 (andeman)

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-02)

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-30)

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-30)

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-10)

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-21)

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 (mauricemeyer)
• (MODULES-8886) Revert removal of deepmerge function #1181 (eimlav)
• Fixed Changelog links for 8.1.0 #1180 (mauricemeyer)

8.1.0 (2019-04-03)

Full Changelog

Added

• Rotate option for xtrabackup script #1176 (elfranne)
• Add support for dynamic backupmethods/mariabackup #1171 (danquack)

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

Fixed

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

8.0.0 (2019-01-18)

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-27)

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-01)

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)
• Replaced 'DROP USER' with 'DROP USER IF EXISTS' #942 (libertamohamed)

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

Added

• (PDOC-210) Puppet Strings documentation #1068 (hunner)
• Compatibility for Alpine linux #1049 (cisco87)

Fixed

• (MODULES-6627) Removed unused --host flag from mysqlcaller #1064 (HelenCampbell)
• Fixed archlinux compatibility #1057 (bastelfreak)
• Changed input param option in export.json from sql to file #1054 (cgoswami)

Supported Release 5.3.0

Summary

This release uses the PDK convert functionality which in return makes the module PDK compliant. It also includes a roll up of maintenance changes, a new task and support for GRANTS FUNCTION.

Added

• Add support for GRANTS FUNCTION (MODULES-2075).
• Add Export database task.
• PDK Convert mysql (MODULES-6454).

Changed

• Allow authentication plugin to be changed.
• Update mysql_user provider.
• Plugins don't exist before 5.5; password field name changed
• Fix helpful rubocops and disable hurtful cops.
• Addressing puppet-lint and rubocop errors
• Remove update bundler and add ignore .DS_Store
• Skip rubocop warning in task.
• Fix a typo in a classname in the changelog.

Supported Release 5.2.1

Summary

This release fixes CVE-2018-6508 which is a potential arbitrary code execution via tasks.

Fixed

• Fix export and mysql tasks for arbitrary remote code

Supported Release 5.2.0

Added

• Compatibility for puppet-staging 3.0.0

Fixed

• Centralize all mysql command calls for providers
• Add paths to mysql_datadir provider for RedHat Software Collections

Supported Release 5.1.0

Summary

This release adds Tasks to the Mysql module.

Added

• Adds the execute sql task.

Supported Release 5.0.0

Summary

This is a major release that adds support for string translation. Currently the only supported language besides English is Japanese.

Added

• Several gem dependencies required for translation.
• Wrapping of strings that require translation. Strings in ruby code are now wrapped with _() and strings in puppet code with translate().
• Debian 9 support

Changed

• The default php_package_name for Debian and Ubuntu to php-mysql

Supported Release 4.0.1

Summary

This is a small bugfix release that makes mysql_install_db optional and fixes some regular expression issues.

Bugfixes

• (MODULES-5528) Fixes the mysql_install_db command so that it is optional
• (MODULES-5602) Removes superfluous backslashes in some regular expressions that were causing instability

Supported Release 4.0.0

Summary

This release sees the enablement of rubocop, also an update to the lib directory with rubocop fixes and several other changes and fixes. Also a bump to the Puppet version compatibility and several Puppet language updates.

Added

• Updated README.md with example how to install MySQL Community Server 5.6 on Centos 7.3
• Enabled Rubocop and addition of Rubocop fixes for /lib directory.

Removed

• Dropped legacy tests for db.pp.

Changed

• Replaced validate function calls with datatypes in db.pp.
• Bumped recommended puppet version to between 4.7.0 and 6.0.0.
• Conditionalize name validation in mysql_grant type. (MODULES-4604)

Fixed

• Removal of invalid parameter provider on Mysql_user[user@localhost] in mysql::db (MODULES-4115)
• Fixed server_service_name for Debian/stretch.
• Spec fixes for Puppet 5.
• Test update for fix:create procedure, then grant (MODULES-5390)
• Fixing empty user/password issue for xtrabackup. Now defaults as undef instead of ''.
• Remove unsupported Ubuntu versions (MODULES-5501)

Supported Release 3.11.0

Summary

This release includes README and metadata translations to Japanese, as well as some enhancements and bugfixes.

Added

• New flag for successful backups
• Solaris support improvements
• New parameter optional_args for extra innobackupex options
• Specify environment variables (e.g. https_proxy) for MySQLTuner download.
• Check to only install bzip2 if $backupcompress is true
• Debian 9 compatibility
• Japanese README

Fixed

• Syntax errors
• Bug where error logs were being created before the datadir was initialized (MODULES-4743)

Supported Release 3.10.0

Summary

This release includes new features for setting TLS options on a mysql user, a new parameter to allow specifying tool to import sql files, as well as various bugfixes.

Features

• (MODULES-3879) Adds import_cat_cmd parameter to specify the command to read sql files
• Adds support for setting tls_options in mysql_user

Bugfixes

• (MODULES-3557) Adds Ubuntu 16.04 package names for language bindings
• (MODULES-3907) Adds MySQL/Percona 5.7 initialize on fresh deploy

Supported Release 3.9.0

Summary

This release adds Percona 5.7 support and compatibility with Ubuntu 16.04, in addition to various bugfixes.

Features

• (MODULES-3441) Adds the mysqld_version fact
• (MODULES-3513) Adds a new backup dump parameter maxallowedpacket
• Adds new parameter xtrabackup_package_name to mysql::backup::xtrabackup class
• Adds ability to revoke GRANT privilege

Bugfixes

• Fixes a bug where mysql_user fails if facter cannot retrieve fqdn.
• Fix global parameter usage in backup script
• Adds support for puppet-staging version 2.0.0
• (MODULES-3601) Moves binary logging configuration to take place after package install
• (MODULES-3711) Add limit to mysql server ID generated value
• (MODULES-3698) Fixes defaults for SLES12
• Updates user name length restrictions for MySQL version 5.7.8 and above.
• Fixes a bug where error log is not writable by owner

Supported Release 3.8.0

Summary

This release adds Percona 5.7 support and compatibility with Ubuntu 16.04, in addition to various bugfixes.

Features

• Adds support for Percona 5.7
• Adds support for Ubuntu 16.04 (Xenial)

Known Limitations

• The mysqlbackup.sh script will not work on MySQL 5.7.0 and up.

Bugfixes

• Use mysql_install_db only with uniq defaults-extra-file
• Updates mysqlbackup.sh to ensure backup directory exist
• Loosen MariaDB recognition to fix it on Debian 8
• Allow mysql::backup::mysqldump to access root_group in tests
• Fixed problem with ignoring parameters from global configs
• Fixes ordering issue that initialized mysqld before config is set
• (MODULES-1256) Fix parameters on OpenSUSE 12
• Fixes install errors on Debian-based OS by configuring the base of includedir
• Configure the configfile location for mariadb
• Default mysqld_type return value should be 'mysql' if another type is not detected
• Make sure that bzip2 is installed before setting up the cron tab job using mysqlbackup.sh
• Fixes path issue on FreeBSD
• Check that /var/lib/mysql actually contains files
• Removes mysql regex when checking type
• (MODULES-2111) Add the system database to user related actions
• Updates default group for logfiles on Debian-based OS to 'adm'
• Fixes an issue with Amazon linux major release 4 installation
• Fixes 'mysql_install_db' script support on Gentoo
• Removes erroneous anchors to mysql::client from mysql::db
• Adds path to be able to find MySQL 5.5 installation on CentOS

Supported Release 3.7.0

Summary

A large release with several new features. Also includes a considerable amount of bugfixes, many around compatibility and improvements to current functionality.

Features

• Now uses mariadb in OpenSuSE >= 13.1.
• Switch to rspec-puppet-facts.
• Additional function to check if table exists before grant.
• Add ability to input password hash directly.
• Now checking major release instead of specific release.
• Debian 8 support.

Bugfixes

• Minor doc update.
• Fixes improper use of function warn in backup manifest of server.
• Fixes to Compatibility with PE 3.3.
• Fixes when not managing config file in mysql_server_spec.
• Improved user validation and munging.
• Fixes fetching the mysql_user password for MySQL >=5.7.6.
• Fixes unique server_id within my.cnf, the issue were the entire mac address was not being read in to generate the id.
• Corrects the daemon_dev_package_name for mariadb on redhat.
• Fix version compare to properly suppress show_diff for root password.
• Fixes to ensure compatibility with future parser.
• Solaris removed from PE in metadata as its not supported.
• Use MYSQL_PWD to avoid mysqldump warnings.
• Use temp cnf file instead of env variable which creates acceptance test failures.
• No longer hash passwords that are already hashed.
• Fix Gemfile to work with ruby 1.8.7.
• Fixed MySQL 5.7.6++ compatibility.
• Fixing error when disabling service management and the service does not exist.
• Ubuntu vivid should use systemd not upstart.
• Fixed new mysql_datadir provider on CentOS for MySQl 5.7.6 compatibility.
• Ensure if service restart to wait till mysql is up.
• Move all dependencies to not have them in case of service unmanaged.
• Re-Added the ability to set a empty string as option parameter.
• Fixes edge-case with dropping pre-existing users with grants.
• Fix logic for choosing rspec version.
• Refactored main acceptance suite.
• Skip idempotency tests on test cells that do have PUP-5016 unfixed.
• Fix tmpdir to be shared across examples.
• Update to current msync configs [006831f].
• Fix mysql_grant with MySQL ANSI_QUOTES mode.
• Generate .my.cnf for all sections.

Supported Release 3.6.2

Summary

Small release for support of newer PE versions. This increments the version of PE in the metadata.json file.

2015-09-22 - Supported Release 3.6.1

Summary

This is a security and bugfix release that fixes incorrect username truncation in the munge for the mysql_user type, incorrect function used in mysql::server::backup and fixes compatibility issues with PE 3.3.x.

Bugfixes

• Loosen the regex in mysql_user munging so the username is not unintentionally truncated.
• Use warning() not warn()
• Metadata had inadvertantly dropped 3.3.x support
• Some 3.3.x compatibility issues in mysqltuner were corrected

2015-08-10 - Supported Release 3.6.0

Summary

This release adds the ability to use mysql::db and mysql_* types against unmanaged or external mysql instances.

Features

• Add ability to use mysql::db WITHOUT mysql::server (ie, externally)
• Add prescript attribute to mysql::server::backup for xtrabackup
• Add postscript ability to xtrabackup provider.

Bugfixes

• Fix default root passwords blocking puppet on mysql 5.8
• Fix service dependency when package_manage is false
• Fix selinux permissions on my.cnf

2015-07-23 - Supported Release 3.5.0

Summary

A small release to add explicit support to newer Puppet versions and accumulated patches.

Features/Improvements

• Start running tests against puppet 4
• Support longer usernames on newer MariaDB versions
• Add parameters for Solaris 11 and 12

Bugfixes

• Fix references to the mysql-server package
• mysql_server_id doesn't throw and error on machines without macaddress

2015-05-19 - Supported Release 3.4.0

Summary

This release includes the addition of extra facts, OpenBSD compatibility, and a number of other features, improvements and bug fixes.

Features/Improvements

• Added server_id fact which includes mac address for better uniqueness
• Added OpenBSD compatibility, only for 'OpenBSD -current' (due to the recent switch to mariadb)
• Added a $mysql_group parameter, and use that instead of the $root_group parameter to define the group membership of the mysql error log file.
• Updated tests for rspec-puppet 2 and future parser
• Further acceptance testing improvements
• MODULES-1928 - allow log-error to be undef
• Split package installation and database install
• README wording improvements
• Added options for including/excluding triggers and routines
• Made the 'TRIGGER' privilege of mysqldump backups depend on whether or not we are actually backing up triggers
• Cleaned up the privilege assignment in the mysqldump backup script
• Add a fact for capturing the mysql version installed

Bugfixes

• mysql backup: fix regression in mysql_user call
• Set service_ensure to undef, in the case of an unmanaged service
• README Typos fixed
• Bugfix on Xtrabackup crons
• Fixed a permission problem that was preventing triggers from being backed up
• MODULES-1981: Revoke and grant difference of old and new privileges
• Fix an issue were we assume triggers work
• Change default for mysql::server::backup to ignore_triggers = false

Deprecations

mysql::server::old_root_password property

2015-03-03 - Supported Release 3.3.0

Summary

This release includes major README updates, the addition of backup providers, and a fix for managing the log-bin directory.

Features

• Add package_manage parameters to mysql::server and mysql::client (MODULES-1143)
• README improvements
• Add mysqldump, mysqlbackup, and xtrabackup backup providers.

Bugfixes

• log-error overrides were not being properly used (MODULES-1804)
• check for full path for log-bin to stop puppet from managing file '.'

2015-02-09 - Supported Release 3.2.0

Summary

This release includes several new features and bugfixes, including support for various plugins, making the output from mysql_password more consistent when input is empty and improved username validation.

Features

• Add type and provider to manage plugins
• Add support for authentication plugins
• Add support for mysql_install_db on freebsd
• Add create_root_user and create_root_my_cnf parameters to mysql::server

Bugfixes

• Remove dependency on stdlib >= 4.1.0 (MODULES-1759)
• Make grant autorequire user
• Remove invalid parameter 'provider' from mysql_user instance (MODULES-1731)
• Return empty string for empty input in mysql_password
• Fix mysql::account_security when fqdn==localhost
• Update username validation (MODULES-1520)
• Future parser fix in params.pp
• Fix package name for debian 8
• Don't start the service until the server package is installed and the config file is in place
• Test fixes
• Lint fixes

2014-12-16 - Supported Release 3.1.0

Summary

This release includes several new features, including SLES12 support, and a number of bug fixes.

Notes

mysql::server::mysqltuner has been refactored to fetch the mysqltuner script from github by default. If you are running on a non-network-connected system, you will need to download that file and have it available to your node at a path specified by the source parameter to the mysqltuner class.

Features

• Add support for install_options for all package resources (MODULES-1484)
• Add log-bin directory creation
• Allow mysql::db to import multiple files (MODULES-1338)
• SLES12 support
• Improved identifier quoting detections
• Reworked mysql::server::mysqltuner so that we are no longer packaging the script as it is licensed under the GPL.

Bugfixes

• Fix regression in username validation
• Proper containment for mysql::client in mysql::db
• Support quoted usernames of length 15 and 16 chars

2014-11-11 - Supported Release 3.0.0

Summary

Added several new features including MariaDB support and future parser

Backwards-incompatible Changes

• Remove the deprecated database, database_user, and database_grant resources. The correct resources to use are mysql, mysql_user, and mysql_grant respectively.

Features

• Add MariaDB Support
• The mysqltuner perl script has been updated to 1.3.0 based on work at http://github.com/major/MySQLTuner-perl
• Add future parse support, fixed issues with undef to empty string
• Pass the backup credentials to 'SHOW DATABASES'
• Ability to specify the Includedir for mysql::server
• mysql::db now has an import_timeout feature that defaults to 300
• The mysql class has been removed
• mysql::server now takes an override_options hash that will affect the installation
• Ability to install both dev and client dev

BugFix

• mysql::server::backup now passes ensure param to the nested mysql_grant
• mysql::server::service now properly requires the presence of the log_error file
• mysql::config now occurs before mysql::server::install_db correctly

2014-07-15 - Supported Release 2.3.1

Summary

This release merely updates metadata.json so the module can be uninstalled and upgraded via the puppet module command.

2014-05-14 - Supported Release 2.3.0

This release primarily adds support for RHEL7 and Ubuntu 14.04 but it also adds a couple of new parameters to allow for further customization, as well as ensuring backups can backup stored procedures properly.

Features

Added execpath to allow a custom executable path for non-standard mysql installations. Added dbname to mysql::db and use ensure_resource to create the resource. Added support for RHEL7 and Fedora Rawhide. Added support for Ubuntu 14.04. Create a warning for if you disable SSL. Ensure the error logfile is owned by MySQL. Disable ssl on FreeBSD. Add PROCESS privilege for backups.

Bugfixes

Known Bugs

• No known bugs

2014-03-04 - Supported Release 2.2.3

Summary

This is a supported release. This release removes a testing symlink that can cause trouble on systems where /var is on a seperate filesystem from the modulepath.

Features

Bugfixes

Known Bugs

• No known bugs

2014-03-04 - Supported Release 2.2.2

Summary

This is a supported release. Mostly comprised of enhanced testing, plus a bugfix for Suse.

Bugfixes

• PHP bindings on Suse
• Test fixes

Known Bugs

• No known bugs

2014-02-19 - Version 2.2.1

Summary

Minor release that repairs mysql_database{} so that it sees the correct collation settings (it was only checking the global mysql ones, not the actual database and constantly setting it over and over since January 22nd).

Also fixes a bunch of tests on various platforms.

2014-02-13 - Version 2.2.0

Summary

Features

• Add backupdirmode, backupdirowner, backupdirgroup to mysql::server::backup to allow customizing the mysqlbackupdir.
• Support multiple options of the same name, allowing you to do 'replicate-do-db' => ['base1', 'base2', 'base3'] in order to get three lines of replicate-do-db = base1, replicate-do-db = base2 etc.

Bugfixes

• Fix restart so it actually stops mysql restarting if set to false.
• DRY out the defaults_file functionality in the providers.
• mysql_grant fixed to work with root@localhost/@.
• mysql_grant fixed for WITH MAX_QUERIES_PER_HOUR
• mysql_grant fixed so revoking all privileges accounts for GRANT OPTION
• mysql_grant fixed to remove duplicate privileges.
• mysql_grant fixed to handle PROCEDURES when removing privileges.
• mysql_database won't try to create existing databases, breaking replication.
• bind_address renamed bind-address in 'mysqld' options.
• key_buffer renamed to key_buffer_size.
• log_error renamed to log-error.
• pid_file renamed to pid-file.
• Ensure mysql::server::root_password runs before mysql::server::backup
• Fix options_override -> override_options in the README.
• Extensively rewrite the README to be accurate and awesome.
• Move to requiring stdlib 3.2.0, shipped in PE3.0
• Add many new tests.

2013-11-13 - Version 2.1.0

Summary

The most important changes in 2.1.0 are improvements to the my.cnf creation, as well as providers. Setting options to = true strips them to be just the key name itself, which is required for some options.

The provider updates fix a number of bugs, from lowercase privileges to deprecation warnings.

Last, the new hiera integration functionality should make it easier to externalize all your grants, users, and, databases. Another great set of community submissions helped to make this release.

Features

• Some options can not take a argument. Gets rid of the '= true' when an option is set to true.
• Easier hiera integration: Add hash parameters to mysql::server to allow specifying grants, users, and databases.

Bugfixes

• Fix an issue with lowercase privileges in mysql_grant{} causing them to be reapplied needlessly.
• Changed defaults-file to defaults-extra-file in providers.
• Ensure /root/.my.cnf is 0600 and root owned.
• database_user deprecation warning was incorrect.
• Add anchor pattern for client.pp
• Documentation improvements.
• Various test fixes.

2013-10-21 - Version 2.0.1

Summary

This is a bugfix release to handle an issue where unsorted mysql_grant{} privileges could cause Puppet to incorrectly reapply the permissions on each run.

Bugfixes

• Mysql_grant now sorts privileges in the type and provider for comparison.
• Comment and test tweak for PE3.1.

2013-10-14 - Version 2.0.0

Summary

(Previously detailed in the changelog for 2.0.0-rc1)

This module has been completely refactored and works significantly different. The changes are broad and touch almost every piece of the module.

See the README.md for full details of all changes and syntax. Please remain on 1.0.0 if you don't have time to fully test this in dev.

• mysql::server, mysql::client, and mysql::bindings are the primary interface classes.
• mysql::server takes an override_options parameter to set my.cnf options, with the hash format: { 'section' => { 'thing' => 'value' }}
• mysql attempts backwards compatibility by forwarding all parameters to mysql::server.

2013-10-09 - Version 2.0.0-rc5

Summary

Hopefully the final rc! Further fixes to mysql_grant (stripping out the cleverness so we match a much wider range of input.)

Bugfixes

• Make mysql_grant accept '.'@'.' in terms of input for user@host.

2013-10-09 - Version 2.0.0-rc4

Summary

Bugfixes to mysql_grant and mysql_user form the bulk of this rc, as well as ensuring that values in the override_options hash that contain a value of '' are created as just "key" in the conf rather than "key =" or "key = false".

Bugfixes

• Improve mysql_grant to work with IPv6 addresses (both long and short).
• Ensure @host users work as well as user@host users.
• Updated my.cnf template to support items with no values.

2013-10-07 - Version 2.0.0-rc3

Summary

Fix mysql::server::monitor's use of mysql_user{}.

Bugfixes

• Fix myql::server::monitor's use of mysql_user{} to grant the proper permissions. Add specs as well. (Thanks to treydock!)

2013-10-03 - Version 2.0.0-rc2

Summary

Bugfixes

Bugfixes

• Fix a duplicate parameter in mysql::server

2013-10-03 - Version 2.0.0-rc1

Summary

This module has been completely refactored and works significantly different. The changes are broad and touch almost every piece of the module.

See the README.md for full details of all changes and syntax. Please remain on 1.0.0 if you don't have time to fully test this in dev.

• mysql::server, mysql::client, and mysql::bindings are the primary interface classes.
• mysql::server takes an override_options parameter to set my.cnf options, with the hash format: { 'section' => { 'thing' => 'value' }}
• mysql attempts backwards compatibility by forwarding all parameters to mysql::server.

---

2013-09-23 - Version 1.0.0

Summary

This release introduces a number of new type/providers, to eventually replace the database_ ones. The module has been converted to call the new providers rather than the previous ones as they have a number of fixes, additional options, and work with puppet resource.

This 1.0.0 release precedes a large refactoring that will be released almost immediately after as 2.0.0.

Features

• Added mysql_grant, mysql_database, and mysql_user.
• Add mysql::bindings class and refactor all other bindings to be contained underneath mysql::bindings:: namespace.
• Added support to back up specified databases only with 'mysqlbackup' parameter.
• Add option to mysql::backup to set the backup script to perform a mysqldump on each database to its own file

Bugfixes

• Update my.cnf.pass.erb to allow custom socket support
• Add environment variable for .my.cnf in mysql::db.
• Add HOME environment variable for .my.cnf to mysqladmin command when (re)setting root password

---

2013-07-15 - Version 0.9.0

Features

• Add mysql::backup::backuprotate parameter
• Add mysql::backup::delete_before_dump parameter
• Add max_user_connections attribute to database_user type

Bugfixes

• Add client package dependency for mysql::db
• Remove duplicate expire_logs_days and max_binlog_size settings
• Make root's .my.cnf file path dynamic
• Update pidfile path for Suse variants
• Fixes for lint

2013-07-05 - Version 0.8.1

Bugfixes

• Fix a typo in the Fedora 19 support.

2013-07-01 - Version 0.8.0

Features

• mysql::perl class to install perl-DBD-mysql.
• minor improvements to the providers to improve reliability
• Install the MariaDB packages on Fedora 19 instead of MySQL.
• Add new mysql class parameters:
  • max_connections: The maximum number of allowed connections.
  • manage_config_file: Opt out of puppetized control of my.cnf.
  • ft_min_word_len: Fine tune the full text search.
  • ft_max_word_len: Fine tune the full text search.
• Add new mysql class performance tuning parameters:
  • key_buffer
  • thread_stack
  • thread_cache_size
  • myisam-recover
  • query_cache_limit
  • query_cache_size
  • max_connections
  • tmp_table_size
  • table_open_cache
  • long_query_time
• Add new mysql class replication parameters:
  • server_id
  • sql_log_bin
  • log_bin
  • max_binlog_size
  • binlog_do_db
  • expire_logs_days
  • log_bin_trust_function_creators
  • replicate_ignore_table
  • replicate_wild_do_table
  • replicate_wild_ignore_table
  • expire_logs_days
  • max_binlog_size

Bugfixes

• No longer restart MySQL when /root/.my.cnf changes.
• Ensure mysql::config runs before any mysql::db defines.

2013-06-26 - Version 0.7.1

Bugfixes

• Single-quote password for special characters
• Update travis testing for puppet 3.2.x and missing Bundler gems

2013-06-25 - Version 0.7.0

This is a maintenance release for community bugfixes and exposing configuration variables.

• Add new mysql class parameters:
  • basedir: The base directory mysql uses
  • bind_address: The IP mysql binds to
  • client_package_name: The name of the mysql client package
  • config_file: The location of the server config file
  • config_template: The template to use to generate my.cnf
  • datadir: The directory MySQL's datafiles are stored
  • default_engine: The default engine to use for tables
  • etc_root_password: Whether or not to add the mysql root password to /etc/my.cnf
  • java_package_name: The name of the java package containing the java connector
  • log_error: Where to log errors
  • manage_service: Boolean dictating if mysql::server should manage the service
  • max_allowed_packet: Maximum network packet size mysqld will accept
  • old_root_password: Previous root user password
  • php_package_name: The name of the phpmysql package to install
  • pidfile: The location mysql will expect the pidfile to be
  • port: The port mysql listens on
  • purge_conf_dir: Value fed to recurse and purge parameters of the /etc/mysql/conf.d resource
  • python_package_name: The name of the python mysql package to install
  • restart: Whether to restart mysqld
  • root_group: Use specified group for root-owned files
  • root_password: The root MySQL password to use
  • ruby_package_name: The name of the ruby mysql package to install
  • ruby_package_provider: The installation suite to use when installing the ruby package
  • server_package_name: The name of the server package to install
  • service_name: The name of the service to start
  • service_provider: The name of the service provider
  • socket: The location of the MySQL server socket file
  • ssl_ca: The location of the SSL CA Cert
  • ssl_cert: The location of the SSL Certificate to use
  • ssl_key: The SSL key to use
  • ssl: Whether or not to enable ssl
  • tmpdir: The directory MySQL's tmpfiles are stored
• Deprecate mysql::package_name parameter in favor of mysql::client_package_name
• Fix local variable template deprecation
• Fix dependency ordering in mysql::db
• Fix ANSI quoting in queries
• Fix travis support (but still messy)
• Fix typos

2013-01-11 - Version 0.6.1

• Fix providers when /root/.my.cnf is absent

2013-01-09 - Version 0.6.0

• Add mysql::server::config define for specific config directives
• Add mysql::php class for php support
• Add backupcompress parameter to mysql::backup
• Add restart parameter to mysql::config
• Add purge_conf_dir parameter to mysql::config
• Add manage_service parameter to mysql::server
• Add syslog logging support via the log_error parameter
• Add initial SuSE support
• Fix remove non-localhost root user when fqdn != hostname
• Fix dependency in mysql::server::monitor
• Fix .my.cnf path for root user and root password
• Fix ipv6 support for users
• Fix / update various spec tests
• Fix typos
• Fix lint warnings

2012-08-23 - Version 0.5.0

• Add puppetlabs/stdlib as requirement
• Add validation for mysql privs in provider
• Add pidfile parameter to mysql::config
• Add ensure parameter to mysql::db
• Add Amazon linux support
• Change bind_address parameter to be optional in my.cnf template
• Fix quoting root passwords

2012-07-24 - Version 0.4.0

• Fix various bugs regarding database names
• FreeBSD support
• Allow specifying the storage engine
• Add a backup class
• Add a security class to purge default accounts

2012-05-03 - Version 0.3.0

• 14218 Query the database for available privileges
• Add mysql::java class for java connector installation
• Use correct error log location on different distros
• Fix set_mysql_rootpw to properly depend on my.cnf

2012-04-11 - Version 0.2.0

2012-03-19 - William Van Hevelingen blkperl@cat.pdx.edu

• (#13203) Add ssl support (f7e0ea5)

2012-03-18 - Nan Liu nan@puppetlabs.com

• Travis ci before script needs success exit code. (0ea463b)

2012-03-18 - Nan Liu nan@puppetlabs.com

• Fix Puppet 2.6 compilation issues. (9ebbbc4)

2012-03-16 - Nan Liu nan@puppetlabs.com

• Add travis.ci for testing multiple puppet versions. (33c72ef)

2012-03-15 - William Van Hevelingen blkperl@cat.pdx.edu

• (#13163) Datadir should be configurable (f353fc6)

2012-03-16 - Nan Liu nan@puppetlabs.com

• Document create_resources dependency. (558a59c)

2012-03-16 - Nan Liu nan@puppetlabs.com

• Fix spec test issues related to error message. (eff79b5)

2012-03-16 - Nan Liu nan@puppetlabs.com

• Fix mysql service on Ubuntu. (72da2c5)

2012-03-16 - Dan Bode dan@puppetlabs.com

• Add more spec test coverage (55e399d)

2012-03-16 - Nan Liu nan@puppetlabs.com

• (#11963) Fix spec test due to path changes. (1700349)

2012-03-07 - François Charlier fcharlier@ploup.net

• Add a test to check path for 'mysqld-restart' (b14c7d1)

2012-03-07 - François Charlier fcharlier@ploup.net

• Fix path for 'mysqld-restart' (1a9ae6b)

2012-03-15 - Dan Bode dan@puppetlabs.com

• Add rspec-puppet tests for mysql::config (907331a)

2012-03-15 - Dan Bode dan@puppetlabs.com

• Moved class dependency between sever and config to server (da62ad6)

2012-03-14 - Dan Bode dan@puppetlabs.com

• Notify mysql restart from set_mysql_rootpw exec (0832a2c)

2012-03-15 - Nan Liu nan@puppetlabs.com

• Add documentation related to osfamily fact. (8265d28)

2012-03-14 - Dan Bode dan@puppetlabs.com

• Mention osfamily value in failure message (e472d3b)

2012-03-14 - Dan Bode dan@puppetlabs.com

• Fix bug when querying for all database users (015490c)

2012-02-09 - Nan Liu nan@puppetlabs.com

• Major refactor of mysql module. (b1f90fd)

2012-01-11 - Justin Ellison justin.ellison@buckle.com

• Ruby and Python's MySQL libraries are named differently on different distros. (1e926b4)

2012-01-11 - Justin Ellison justin.ellison@buckle.com

• Per @ghoneycutt, we should fail explicitly and explain why. (09af083)

2012-01-11 - Justin Ellison justin.ellison@buckle.com

• Removing duplicate declaration (7513d03)

2012-01-10 - Justin Ellison justin.ellison@buckle.com

• Use socket value from params class instead of hardcoding. (663e97c)

2012-01-10 - Justin Ellison justin.ellison@buckle.com

• Instead of hardcoding the config file target, pull it from mysql::params (031a47d)

2012-01-10 - Justin Ellison justin.ellison@buckle.com

• Moved $socket to within the case to toggle between distros. Added a $config_file variable to allow per-distro config file destinations. (360eacd)

2012-01-10 - Justin Ellison justin.ellison@buckle.com

• Pretty sure this is a bug, 99% of Linux distros out there won't ever hit the default. (3462e6b)

2012-02-09 - William Van Hevelingen blkperl@cat.pdx.edu

• Changed the README to use markdown (3b7dfeb)

2012-02-04 - Daniel Black grooverdan@users.sourceforge.net

• (#12412) mysqltuner.pl update (b809e6f)

2011-11-17 - Matthias Pigulla mp@webfactory.de

• (#11363) Add two missing privileges to grant: event_priv, trigger_priv (d15c9d1)

2011-12-20 - Jeff McCune jeff@puppetlabs.com

• (minor) Fixup typos in Modulefile metadata (a0ed6a1)

2011-12-19 - Carl Caum carl@carlcaum.com

• Only notify Exec to import sql if sql is given (0783c74)

2011-12-19 - Carl Caum carl@carlcaum.com

• (#11508) Only load sql_scripts on DB creation (e3b9fd9)

2011-12-13 - Justin Ellison justin.ellison@buckle.com

• Require not needed due to implicit dependencies (3058feb)

2011-12-13 - Justin Ellison justin.ellison@buckle.com

• Bug #11375: puppetlabs-mysql fails on CentOS/RHEL (a557b8d)

2011-06-03 - Dan Bode dan@puppetlabs.com - 0.0.1

• initial commit

* This Changelog was automatically generated by github_changelog_generator

* This Changelog was automatically generated by github_changelog_generator