Forge Home


Puppet module for mysql


203,114 latest version

3.8 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 2.1.8 (latest)
  • 2.1.7
  • 2.1.6
  • 2.1.5
  • 2.1.4
  • 2.1.3
  • 2.1.2
  • 2.1.1
  • 2.1.0
  • 2.0.8
  • 2.0.7
released Aug 12th 2016
This module has been deprecated by its author since Oct 28th 2019.

The reason given was: No longer maintained

The author has suggested puppetlabs-mysql as its replacement.

Start using this module


example42/mysql — version 2.1.8 Aug 12th 2016

Deprecation notice

This module was designed for Puppet versions 2 and 3. It should work also on Puppet 4 but doesn't use any of its features.

The current Puppet 3 compatible codebase is no longer actively maintained by example42.

Still, Pull Requests that fix bugs or introduce backwards compatible features will be accepted.

Puppet module: mysql

This is a Puppet mysql module from the second generation of Example42 Puppet Modules.

Made by Alessandro Franceschi / Lab42

Official site:

Official git repository:

Released under the terms of Apache 2 License.

This module requires functions provided by the Example42 Puppi module.

For detailed info about the logic and usage patterns of Example42 modules read README.usage on Example42 main modules set.

USAGE - Module specific

  • Set a specific (cleartext) mysql root password

      class { "mysql":
        root_password => 'mys4cr3',
  • Set a random password ( saved in /root/.my.cnf )

      class { "mysql":
        root_password => 'auto',
  • Create a new grant and database

Create database and manage GRANT

The simplest way to create database is the following.

    mysql::grant { 'db1':
      mysql_user     => 'myusername',
      mysql_password => 'mypassword',

This will create a MySQL database named 'db1' with a MySQL grant allowing full access to user 'myusername' with 'mypassword' password on local host.

Customize host source

If you want to customize the host the new user can connect from you have to use the 'mysql_host'.

    mysql::grant { 'db1':
      mysql_user     => 'myusername',
      mysql_password => 'mypassword',
      mysql_host     => '',

Here the whole can connect.

Customize privileges

For privileges customization there is the 'mysql_privileges' parameter.

    mysql::grant { 'db1':
      mysql_user       => 'myusername',
      mysql_password   => 'mypassword',
      mysql_privileges => 'SELECT',

The default grant privileges is 'ALL'.

Remove GRANT

Like for standard puppet resource you can use the 'ensure' parameter in order to remove a grant.

    mysql::grant { 'db1':
      ensure         => 'absent',
      mysql_user     => 'myusername',
      mysql_password => 'mypassword',

This will ensure the 'myusername@localhost' grant is absent but not the database.

Load initial data

The mysql_db_init_query_file is an optional parameter allowing to specify a sql file. The execution of this SQL file will be triger only once at the creation time.

    mysql::grant { 'db1':
      ensure                   => 'absent',
      mysql_user               => 'myusername',
      mysql_password           => 'mypassword',
      mysql_db_init_query_file => '/full/path/to/the/schema.sql',

NOTE: The SQL file should already be uploaded on mysql server host.

USAGE - Basic management

  • Install mysql with default settings

      class { "mysql": }
  • Disable mysql service.

      class { "mysql":
        disable => true
  • Disable mysql service at boot time, but don't stop if is running.

      class { "mysql":
        disableboot => true
  • Install a specific version of mysqlpackage

      class { 'mysql':
        version => '1.0.1',
  • Remove mysql package

      class { "mysql":
        absent => true
  • Enable auditing without without making changes on existing mysql configuration files

      class { "mysql":
        audit_only => true

USAGE - Overrides and Customizations

  • Use custom sources for main config file

      class { "mysql":
        source => [ "puppet:///modules/lab42/mysql/mysql.conf-${hostname}" , "puppet:///modules/lab42/mysql/mysql.conf" ],
  • Use custom source directory for the whole configuration dir

      class { "mysql":
        source_dir       => "puppet:///modules/lab42/mysql/conf/",
        source_dir_purge => false, # Set to true to purge any existing file not present in $source_dir
  • Use custom template for main config file

      class { "mysql":
        template => "example42/mysql/mysql.conf.erb",
  • Define custom options that can be used in a custom template without the need to add parameters to the mysql class

      class { "mysql":
        template => "example42/mysql/mysql.conf.erb",
        options  => {
          'LogLevel' => 'INFO',
          'UsePAM'   => 'yes',
  • Automaticallly include a custom subclass

      class { "mysql:"
        my_class => 'mysql::example42',

USAGE - Hiera Support

  • Manage MySQL configuration using Hiera
mysql::template: 'modules/mysql/my.cnf.erb'
mysql::root_password: 'example42'
  port: '3306'
  bind-address: ''
  • Defining MySQL resources using Hiera
    mysql_user: 'myusername'
    mysql_password: 'mypassword'
    mysql_host: ''

USAGE - Example42 extensions management

  • Activate puppi (recommended, but disabled by default) Note that this option requires the usage of Example42 puppi module

      class { "mysql":
        puppi    => true,
  • Activate puppi and use a custom puppi_helper template (to be provided separately with a puppi::helper define ) to customize the output of puppi commands

      class { "mysql":
        puppi        => true,
        puppi_helper => "myhelper",
  • Activate automatic monitoring (recommended, but disabled by default) This option requires the usage of Example42 monitor and relevant monitor tools modules

      class { "mysql":
        monitor      => true,
        monitor_tool => [ "nagios" , "monit" , "munin" ],
  • Activate automatic firewalling This option requires the usage of Example42 firewall and relevant firewall tools modules

      class { "mysql":
        firewall      => true,
        firewall_tool => "iptables",
        firewall_src  => "",
        firewall_dst  => "$ipaddress_eth0",

Build Status