Mysql Puppet Module
Puppet Ruby HTML
Latest commit 6f51c47 Aug 12, 2016 @alvagante alvagante Release v2.1.8
Failed to load latest commit information.
.github Added github files May 12, 2016
manifests Fixed the error by removing escape character. Nov 19, 2015
spec Fix #46 mysql::queryfile should be execute on remote server only when… Dec 29, 2014
templates support for socket location in .my.cnf Nov 13, 2015
.fixtures.yml Release v2.1.2 Feb 10, 2014
.gemfile Fixing spec tests for rspec-puppet 2.x Feb 17, 2014
.gitignore Metadata.json removed from gitignore Apr 15, 2016
.travis.yml Trying to fix travis build Mar 13, 2015
Gemfile Trying to fix travis build Mar 13, 2015
LICENSE Added LICENSE Sep 7, 2013 Added deprecation message Aug 12, 2016
Rakefile Travis blues Feb 17, 2014
metadata.json Release v2.1.8 Aug 12, 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