- Module Description - What the module does and why it is useful
- Setup - The basics of getting started with mysql
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
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.
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,
override_options => $override_options
}See Customize Server Options below for examples of the hash structure for $override_options`.
All interaction for the server is done via mysql::server. To install the client, use mysql::client. To install bindings, use mysql::bindings.
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
...you can make an entry like 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 separate 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.
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.
mysql::db { 'mydb':
user => 'myuser',
password => 'mypass',
host => 'localhost',
grant => ['SELECT', 'UPDATE'],
sql => '/path/to/sqlfile.gz',
import_cat_cmd => 'zcat',
import_timeout => 900,
}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.
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.
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'],
}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 / 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/centos/$releasever/os/$basearch/',
gpgkey => 'http://www.percona.com/downloads/percona-release/RPM-GPG-KEY-percona',
enabled => 1,
gpgcheck => 1,
}
class {'mysql::server':
package_name => 'Percona-Server-server-57',
package_ensure => '5.7.11-4.1.el7',
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',
package_ensure => '5.7.11-4.1.el7',
}
# 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_package_ensure => '5.7.11-4.1.el7',
client_dev => true,
daemon_dev_package_name => 'Percona-Server-devel-57',
daemon_dev_package_ensure => '5.7.11-4.1.el7',
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']In this example, we'll use the latest stable (currently 10.1) 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.1/ubuntu',
release => $::lsbdistcodename,
repos => 'main',
key => {
id => '199369E5404BD5FC7D2FE43BCBCB082A1BB943DB',
server => 'hkp://keyserver.ubuntu.com:80',
},
include => {
src => false,
deb => true,
},
}
This example shows MariaDB server installation on Ubuntu Trusty. 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 => '10.1.14+maria-1~trusty',
service_name => 'mysql',
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']
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 => '10.1.14+maria-1~trusty',
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']
mysql::server: Installs and configures MySQL.mysql::server::monitor: Sets up a monitoring user.mysql::server::mysqltuner: Installs MySQL tuner script.mysql::server::backup: Sets up MySQL backups via cron.mysql::bindings: Installs various MySQL language bindings.mysql::client: Installs MySQL client (for non-servers).
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.
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.
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.
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.
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.
Specifies override options to pass into MySQL. Structured like a hash in the my.cnf file:
$override_options = {
'section' => {
'item' => 'thing',
}
}See Customize Server Options above for usage details.
The location, as a path, of the MySQL configuration file.
Whether the MySQL configuration file should be managed. Valid values are true, false. Defaults to true.
The location, as a path, of !includedir for custom configuration overrides.
Passes install_options array to managed package resources. You must pass the appropriate options for the specified package manager.
Whether the includedir directory should be purged. Valid values are true, false. Defaults to false.
Whether the service should be restarted when things change. Valid values are true, false. Defaults to false.
The name of the group used for root. Can be a group name or a group ID. See more about the group file attribute.
The name of the group of the MySQL daemon user. Can be a group name or a group ID. See more about the group file attribute.
Whether the package exists or should be a specific version. Valid values are 'present', 'absent', or 'x.y.z'. Defaults to 'present'.
Whether to manage the MySQL server package. Defaults to true.
The name of the MySQL server package to install.
Specifies whether to automatically include mysql::server::account_security. Valid values are true, false. Defaults to false.
Specifies whether the service should be enabled. Valid values are true, false. Defaults to true.
Specifies whether the service should be managed. Valid values are true, false. Defaults to true.
The name of the MySQL server service. Defaults are OS dependent, defined in params.pp.
The provider to use to manage the service. For Ubuntu, defaults to 'upstart'; otherwise, default is undefined.
Optional hash of users to create, which are passed to mysql_user.
users => {
'someuser@localhost' => {
ensure => 'present',
max_connections_per_hour => '0',
max_queries_per_hour => '0',
max_updates_per_hour => '0',
max_user_connections => '0',
password_hash => '*F3A2A51A9B0F2BE2468926B4132313728C250DBF',
tls_options => ['NONE'],
},
}
Optional hash of grants, which are passed to mysql_grant.
grants => {
'someuser@localhost/somedb.*' => {
ensure => 'present',
options => ['GRANT'],
privileges => ['SELECT', 'INSERT', 'UPDATE', 'DELETE'],
table => 'somedb.*',
user => 'someuser@localhost',
},
}
Optional hash of databases to create, which are passed to mysql_database.
databases => {
'somedb' => {
ensure => 'present',
charset => 'utf8',
},
}
MySQL user to create for backups.
MySQL user password for backups.
Directory in which to store backups.
Permissions applied to the backup directory. This parameter is passed directly
to the file resource.
Owner for the backup directory. This parameter is passed directly to the file
resource.
Group owner for the backup directory. This parameter is passed directly to the
file resource.
Whether backups should be compressed. Valid values are true, false. Defaults to true.
How many days to keep backups. Valid value is an integer. Defaults to '30'.
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. Valid values are true, false. Defaults to false.
Specifies an array of databases to back up.
Whether a separate file be used per database. Valid values are true, false. Defaults to false.
Whether or not to include routines for each database when doing a file_per_database backup. Defaults to false.
Whether or not to include triggers for each database when doing a file_per_database backup. Defaults to false.
Allows you to remove the backup scripts. Valid values are 'present', 'absent'. Defaults to 'present'.
Allows you to set a custom PATH should your MySQL installation be non-standard places. Defaults to /usr/bin:/usr/sbin:/bin:/sbin.
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.
A script that is executed when the backup is finished. This could be used to (r)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.
A script that is executed before the backup begins.
Sets the server backup implementation. Valid values are:
mysqldump: Implements backups with mysqldump. Backup type: Logical. This is the default value.mysqlbackup: Implements backups with MySQL Enterprise Backup from Oracle. Backup type: Physical. To use this type of backup, you'll need themebpackage, which is available in RPM and TAR formats from Oracle. For Ubuntu, you can use meb-deb to create a package from an official tarball.xtrabackup: Implements backups with XtraBackup from Percona. Backup type: Physical.
Defines the maximum SQL statement size for the backup dump script. The default value is 1MB, as this is the default MySQL Server value.
The username to create for MySQL monitoring.
The password to create for MySQL monitoring.
The hostname from which the monitoring user requests are allowed access.
Note: If you're using this class on a non-network-connected system, you must download the mysqltuner.pl script and have it hosted somewhere accessible via http(s)://, puppet://, ftp://, or a fully qualified file path.
Ensures that the resource exists. Valid values are present, absent. Defaults to present.
The version to install from the major/MySQLTuner-perl github repository. Must be a valid tag. Defaults to 'v1.3.0'.
Specifies the source. If not specified, defaults to https://github.com/major/MySQLTuner-perl/raw/${version}/mysqltuner.pl
Specifies whether ::mysql::bindings::client_dev should be included. Valid values are true', false. Defaults to false.
Specifies whether ::mysql::bindings::daemon_dev should be included. Valid values are true, false. Defaults to false.
Specifies whether ::mysql::bindings::java should be included. Valid values are true, false. Defaults to false.
Specifies whether mysql::bindings::perl should be included. Valid values are true, false. Defaults to false.
Specifies whether mysql::bindings::php should be included. Valid values are true, false. Defaults to false.
Specifies whether mysql::bindings::python should be included. Valid values are true, false. Defaults to false.
Specifies whether mysql::bindings::ruby should be included. Valid values are true, false. Defaults to false.
Passes install_options array to managed package resources. You must pass the appropriate options for the package manager(s).
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.
The name of the client_dev package to install. Only applies if client_dev => true.
The provider to use to install the client_dev package. Only applies if client_dev => true.
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.
The name of the daemon_dev package to install. Only applies if daemon_dev => true.
The provider to use to install the daemon_dev package. Only applies if daemon_dev => true.
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.
The name of the Java package to install. Only applies if java_enable => true.
The provider to use to install the Java package. Only applies if java_enable => true.
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.
The name of the Perl package to install. Only applies if perl_enable => true.
The provider to use to install the Perl package. Only applies if perl_enable => true.
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.
The name of the PHP package to install. Only applies if php_enable => true.
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.
The name of the Python package to install. Only applies if python_enable => true.
The provider to use to install the PHP package. Only applies if python_enable => true.
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.
The name of the Ruby package to install. Only applies if ruby_enable => true.
What provider should be used to install the package.
Whether to automatically install all bindings. Valid values are true, false. Default to false.
Array of install options for managed package resources. You must pass the appropriate options for the package manager.
Whether the MySQL package should be present, absent, or a specific version. Valid values are 'present', 'absent', or 'x.y.z'.
Whether to manage the MySQL client package. Defaults to true.
The name of the MySQL client package to install.
mysql_database { 'information_schema':
ensure => 'present',
charset => 'utf8',
collate => 'utf8_swedish_ci',
}
mysql_database { 'mysql':
ensure => 'present',
charset => 'latin1',
collate => 'latin1_swedish_ci',
}
The user for the database you're creating.
The password for $user for the database you're creating.
The name of the database to create. Defaults to $name.
The character set for the database. Defaults to 'utf8'.
The collation for the database. Defaults to 'utf8_general_ci'.
The host to use as part of user@host for grants. Defaults to 'localhost'.
The privileges to be granted for user@host on the database. Defaults to 'ALL'.
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. Defaults to undef.
Specifies whether executing the sqlfiles should happen on every run. If set to false, sqlfiles only run once. Valid values are true, false. Defaults to false.
Specifies whether to create the database. Valid values are 'present', 'absent'. Defaults to 'present'.
Timeout, in seconds, for loading the sqlfiles. Defaults to '300'.
Command to read the sqlfile for importing the database. Useful for compressed sqlfiles. For example, you can use 'zcat' for .gz files. Defaults to 'cat'.
mysql_database creates and manages databases within MySQL.
Whether the resource is present. Valid values are 'present', 'absent'. Defaults to 'present'.
The name of the MySQL database to manage.
The CHARACTER SET setting for the database. Defaults to ':utf8'.
The COLLATE setting for the database. Defaults to ':utf8_general_ci'.
Creates and manages user grants within MySQL.
mysql_user { '[email protected]':
ensure => 'present',
max_connections_per_hour => '0',
max_queries_per_hour => '0',
max_updates_per_hour => '0',
max_user_connections => '0',
}
You can also specify an authentication plugin.
mysql_user{ 'myuser'@'localhost':
ensure => 'present',
plugin => 'unix_socket',
}
TLS options can be specified for a user.
mysql_user{ 'myuser'@'localhost':
ensure => 'present',
tls_options => ['SSL'],
}
The name of the user, as 'username@hostname' or username@hostname.
The user's password hash of the user. Use mysql_password() for creating such a hash.
Maximum concurrent connections for the user. Must be an integer value. A value of '0' specifies no (or global) limit.
Maximum connections per hour for the user. Must be an integer value. A value of '0' specifies no (or global) limit.
Maximum queries per hour for the user. Must be an integer value. A value of '0' specifies no (or global) limit.
Maximum updates per hour for the user. Must be an integer value. A value of '0' specifies no (or global) limit.
SSL-related options for a MySQL account, using one or more tls_option values. 'NONE' specifies that the account has no TLS options enforced, and the available options are 'SSL', 'X509', 'CIPHER cipher', 'ISSUER issuer', 'SUBJECT subject'; as stated in the MySQL documentation.
mysql_grant creates grant permissions to access databases within MySQL. To create grant permissions to access databases with MySQL, use it you must create the title of the resource as shown below, following the pattern of username@hostname/database.table:
mysql_grant { 'root@localhost/*.*':
ensure => 'present',
options => ['GRANT'],
privileges => ['ALL'],
table => '*.*',
user => 'root@localhost',
}
It is possible to specify privileges down to the column level:
mysql_grant { 'root@localhost/mysql.user':
ensure => 'present',
privileges => ['SELECT (Host, User)'],
table => 'mysql.user',
user => 'root@localhost',
}
To revoke GRANT privilege specify ['NONE'].
Whether the resource is present. Valid values are 'present', 'absent'. Defaults to 'present'.
Name to describe the grant. Must in a 'user/table' format.
Privileges to grant the user.
The table to which privileges are applied.
User to whom privileges are granted.
MySQL options to grant. Optional.
mysql_plugin can be used to load plugins into the MySQL Server.
mysql_plugin { 'auth_socket':
ensure => 'present',
soname => 'auth_socket.so',
}
Whether the resource is present. Valid values are 'present', 'absent'. Defaults to 'present'.
The name of the MySQL plugin to manage.
The library file name.
Initializes the MySQL data directory with version specific code. Pre MySQL 5.7.6 it uses mysql_install_db. After MySQL 5.7.6 it uses mysqld --initialize-insecure.
Insecure initialization is needed, as mysqld version 5.7 introduced "secure by default" mode. This means MySQL generates a random password and writes it to STDOUT. This means puppet can never accesss the database server afterwards, as no credencials are available.
This type is an internal type and should not be called directly.
Determines the MySQL version by parsing the output from mysql --version
Generates a unique id, based on the node's MAC address, which can be used as
server_id. This fact will always return 0 on nodes that have only
loopback interfaces. Because those nodes aren't connected to the outside world, this shouldn't cause any conflicts.
This module has been tested on:
- RedHat Enterprise Linux 5, 6, 7
- Debian 6, 7, 8
- CentOS 5, 6, 7
- Ubuntu 10.04, 12.04, 14.04, 16.04
- Scientific Linux 5, 6
- SLES 11
Testing on other platforms has been minimal and cannot be guaranteed.
Note: The mysqlbackup.sh does not work and is not supported on MySQL 5.7 and greater.
Puppet Labs 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.
This module is based on work by David Schmitt. The following contributors have contributed to this module (beyond Puppet Labs):
- Larry Ludwig
- Christian G. Warden
- Daniel Black
- Justin Ellison
- Lowe Schmidt
- Matthias Pigulla
- William Van Hevelingen
- Michael Arnold
- Chris Weyl
- Daniël van Eeden
- Jan-Otto Kröpke