diff --git a/CHANGELOG.md b/CHANGELOG.md
index 8fa2ae1c8..da89ca943 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -2,6 +2,14 @@
All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org).
+## [v10.10.0](https://github.com/puppetlabs/puppetlabs-mysql/tree/v10.10.0) (2021-02-11)
+
+[Full Changelog](https://github.com/puppetlabs/puppetlabs-mysql/compare/v10.9.1...v10.10.0)
+
+### Added
+
+- Set default MySQL version for FreeBSD [\#1360](https://github.com/puppetlabs/puppetlabs-mysql/pull/1360) ([olevole](https://github.com/olevole))
+
## [v10.9.1](https://github.com/puppetlabs/puppetlabs-mysql/tree/v10.9.1) (2021-01-06)
[Full Changelog](https://github.com/puppetlabs/puppetlabs-mysql/compare/v10.9.0...v10.9.1)
@@ -1207,4 +1215,4 @@ configuration variables.
\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
-\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*
diff --git a/REFERENCE.md b/REFERENCE.md
index 9cd445bdf..4ddd55865 100644
--- a/REFERENCE.md
+++ b/REFERENCE.md
@@ -75,7 +75,7 @@ then returns the resulting hash.
## Classes
-### `mysql::bindings`
+### `mysql::bindings`
Parent class for MySQL bindings.
@@ -94,9 +94,39 @@ class { 'mysql::bindings':
#### Parameters
-The following parameters are available in the `mysql::bindings` class.
-
-##### `install_options`
+The following parameters are available in the `mysql::bindings` class:
+
+* [`install_options`](#install_options)
+* [`java_enable`](#java_enable)
+* [`perl_enable`](#perl_enable)
+* [`php_enable`](#php_enable)
+* [`python_enable`](#python_enable)
+* [`ruby_enable`](#ruby_enable)
+* [`client_dev`](#client_dev)
+* [`daemon_dev`](#daemon_dev)
+* [`java_package_ensure`](#java_package_ensure)
+* [`java_package_name`](#java_package_name)
+* [`java_package_provider`](#java_package_provider)
+* [`perl_package_ensure`](#perl_package_ensure)
+* [`perl_package_name`](#perl_package_name)
+* [`perl_package_provider`](#perl_package_provider)
+* [`php_package_ensure`](#php_package_ensure)
+* [`php_package_name`](#php_package_name)
+* [`php_package_provider`](#php_package_provider)
+* [`python_package_ensure`](#python_package_ensure)
+* [`python_package_name`](#python_package_name)
+* [`python_package_provider`](#python_package_provider)
+* [`ruby_package_ensure`](#ruby_package_ensure)
+* [`ruby_package_name`](#ruby_package_name)
+* [`ruby_package_provider`](#ruby_package_provider)
+* [`client_dev_package_ensure`](#client_dev_package_ensure)
+* [`client_dev_package_name`](#client_dev_package_name)
+* [`client_dev_package_provider`](#client_dev_package_provider)
+* [`daemon_dev_package_ensure`](#daemon_dev_package_ensure)
+* [`daemon_dev_package_name`](#daemon_dev_package_name)
+* [`daemon_dev_package_provider`](#daemon_dev_package_provider)
+
+##### `install_options`
Data type: `Any`
@@ -104,7 +134,7 @@ Passes `install_options` array to managed package resources. You must pass the [
Default value: ``undef``
-##### `java_enable`
+##### `java_enable`
Data type: `Any`
@@ -112,7 +142,7 @@ Specifies whether `::mysql::bindings::java` should be included. Valid values are
Default value: ``false``
-##### `perl_enable`
+##### `perl_enable`
Data type: `Any`
@@ -120,7 +150,7 @@ Specifies whether `mysql::bindings::perl` should be included. Valid values are `
Default value: ``false``
-##### `php_enable`
+##### `php_enable`
Data type: `Any`
@@ -128,7 +158,7 @@ Specifies whether `mysql::bindings::php` should be included. Valid values are `t
Default value: ``false``
-##### `python_enable`
+##### `python_enable`
Data type: `Any`
@@ -136,7 +166,7 @@ Specifies whether `mysql::bindings::python` should be included. Valid values are
Default value: ``false``
-##### `ruby_enable`
+##### `ruby_enable`
Data type: `Any`
@@ -144,7 +174,7 @@ Specifies whether `mysql::bindings::ruby` should be included. Valid values are `
Default value: ``false``
-##### `client_dev`
+##### `client_dev`
Data type: `Any`
@@ -152,7 +182,7 @@ Specifies whether `::mysql::bindings::client_dev` should be included. Valid valu
Default value: ``false``
-##### `daemon_dev`
+##### `daemon_dev`
Data type: `Any`
@@ -160,7 +190,7 @@ Specifies whether `::mysql::bindings::daemon_dev` should be included. Valid valu
Default value: ``false``
-##### `java_package_ensure`
+##### `java_package_ensure`
Data type: `Any`
@@ -168,7 +198,7 @@ Whether the package should be present, absent, or a specific version. Valid valu
Default value: `$mysql::params::java_package_ensure`
-##### `java_package_name`
+##### `java_package_name`
Data type: `Any`
@@ -176,7 +206,7 @@ The name of the Java package to install. Only applies if `java_enable => true`.
Default value: `$mysql::params::java_package_name`
-##### `java_package_provider`
+##### `java_package_provider`
Data type: `Any`
@@ -184,7 +214,7 @@ The provider to use to install the Java package. Only applies if `java_enable =>
Default value: `$mysql::params::java_package_provider`
-##### `perl_package_ensure`
+##### `perl_package_ensure`
Data type: `Any`
@@ -192,7 +222,7 @@ Whether the package should be present, absent, or a specific version. Valid valu
Default value: `$mysql::params::perl_package_ensure`
-##### `perl_package_name`
+##### `perl_package_name`
Data type: `Any`
@@ -200,7 +230,7 @@ The name of the Perl package to install. Only applies if `perl_enable => true`.
Default value: `$mysql::params::perl_package_name`
-##### `perl_package_provider`
+##### `perl_package_provider`
Data type: `Any`
@@ -208,7 +238,7 @@ The provider to use to install the Perl package. Only applies if `perl_enable =>
Default value: `$mysql::params::perl_package_provider`
-##### `php_package_ensure`
+##### `php_package_ensure`
Data type: `Any`
@@ -216,7 +246,7 @@ Whether the package should be present, absent, or a specific version. Valid valu
Default value: `$mysql::params::php_package_ensure`
-##### `php_package_name`
+##### `php_package_name`
Data type: `Any`
@@ -224,7 +254,7 @@ The name of the PHP package to install. Only applies if `php_enable => true`.
Default value: `$mysql::params::php_package_name`
-##### `php_package_provider`
+##### `php_package_provider`
Data type: `Any`
@@ -232,7 +262,7 @@ The provider to use to install the PHP package. Only applies if `php_enable => t
Default value: `$mysql::params::php_package_provider`
-##### `python_package_ensure`
+##### `python_package_ensure`
Data type: `Any`
@@ -240,7 +270,7 @@ Whether the package should be present, absent, or a specific version. Valid valu
Default value: `$mysql::params::python_package_ensure`
-##### `python_package_name`
+##### `python_package_name`
Data type: `Any`
@@ -248,7 +278,7 @@ The name of the Python package to install. Only applies if `python_enable => tru
Default value: `$mysql::params::python_package_name`
-##### `python_package_provider`
+##### `python_package_provider`
Data type: `Any`
@@ -256,7 +286,7 @@ The provider to use to install the Python package. Only applies if `python_enabl
Default value: `$mysql::params::python_package_provider`
-##### `ruby_package_ensure`
+##### `ruby_package_ensure`
Data type: `Any`
@@ -264,7 +294,7 @@ Whether the package should be present, absent, or a specific version. Valid valu
Default value: `$mysql::params::ruby_package_ensure`
-##### `ruby_package_name`
+##### `ruby_package_name`
Data type: `Any`
@@ -272,7 +302,7 @@ The name of the Ruby package to install. Only applies if `ruby_enable => true`.
Default value: `$mysql::params::ruby_package_name`
-##### `ruby_package_provider`
+##### `ruby_package_provider`
Data type: `Any`
@@ -280,7 +310,7 @@ What provider should be used to install the package.
Default value: `$mysql::params::ruby_package_provider`
-##### `client_dev_package_ensure`
+##### `client_dev_package_ensure`
Data type: `Any`
@@ -288,7 +318,7 @@ Whether the package should be present, absent, or a specific version. Valid valu
Default value: `$mysql::params::client_dev_package_ensure`
-##### `client_dev_package_name`
+##### `client_dev_package_name`
Data type: `Any`
@@ -296,7 +326,7 @@ The name of the client_dev package to install. Only applies if `client_dev => tr
Default value: `$mysql::params::client_dev_package_name`
-##### `client_dev_package_provider`
+##### `client_dev_package_provider`
Data type: `Any`
@@ -304,7 +334,7 @@ The provider to use to install the client_dev package. Only applies if `client_d
Default value: `$mysql::params::client_dev_package_provider`
-##### `daemon_dev_package_ensure`
+##### `daemon_dev_package_ensure`
Data type: `Any`
@@ -312,7 +342,7 @@ Whether the package should be present, absent, or a specific version. Valid valu
Default value: `$mysql::params::daemon_dev_package_ensure`
-##### `daemon_dev_package_name`
+##### `daemon_dev_package_name`
Data type: `Any`
@@ -320,7 +350,7 @@ The name of the daemon_dev package to install. Only applies if `daemon_dev => tr
Default value: `$mysql::params::daemon_dev_package_name`
-##### `daemon_dev_package_provider`
+##### `daemon_dev_package_provider`
Data type: `Any`
@@ -328,7 +358,7 @@ The provider to use to install the daemon_dev package. Only applies if `daemon_d
Default value: `$mysql::params::daemon_dev_package_provider`
-### `mysql::client`
+### `mysql::client`
Installs and configures the MySQL client.
@@ -346,9 +376,19 @@ class {'::mysql::client':
#### Parameters
-The following parameters are available in the `mysql::client` class.
+The following parameters are available in the `mysql::client` class:
+
+* [`bindings_enable`](#bindings_enable)
+* [`install_options`](#install_options)
+* [`package_ensure`](#package_ensure)
+* [`package_manage`](#package_manage)
+* [`service_name`](#service_name)
+* [`service_provider`](#service_provider)
+* [`package_name`](#package_name)
+* [`package_provider`](#package_provider)
+* [`package_source`](#package_source)
-##### `bindings_enable`
+##### `bindings_enable`
Data type: `Any`
@@ -356,7 +396,7 @@ Whether to automatically install all bindings. Valid values are `true`, `false`.
Default value: `$mysql::params::bindings_enable`
-##### `install_options`
+##### `install_options`
Data type: `Any`
@@ -364,7 +404,7 @@ Array of install options for managed package resources. You must pass the approp
Default value: ``undef``
-##### `package_ensure`
+##### `package_ensure`
Data type: `Any`
@@ -372,7 +412,7 @@ Whether the MySQL package should be present, absent, or a specific version. Vali
Default value: `$mysql::params::client_package_ensure`
-##### `package_manage`
+##### `package_manage`
Data type: `Any`
@@ -380,15 +420,15 @@ Whether to manage the MySQL client package. Defaults to `true`.
Default value: `$mysql::params::client_package_manage`
-##### `service_name`
+##### `service_name`
The name of the MySQL server service. Defaults are OS dependent, defined in 'params.pp'.
-##### `service_provider`
+##### `service_provider`
The provider to use to manage the service. For Ubuntu, defaults to 'upstart'; otherwise, default is undefined.
-##### `package_name`
+##### `package_name`
Data type: `Any`
@@ -396,7 +436,7 @@ The name of the MySQL client package to install.
Default value: `$mysql::params::client_package_name`
-##### `package_provider`
+##### `package_provider`
Data type: `Any`
@@ -404,7 +444,7 @@ Data type: `Any`
Default value: ``undef``
-##### `package_source`
+##### `package_source`
Data type: `Any`
@@ -412,7 +452,7 @@ Data type: `Any`
Default value: ``undef``
-### `mysql::server`
+### `mysql::server`
Installs and configures the MySQL server.
@@ -431,9 +471,46 @@ class { '::mysql::server':
#### Parameters
-The following parameters are available in the `mysql::server` class.
-
-##### `config_file`
+The following parameters are available in the `mysql::server` class:
+
+* [`config_file`](#config_file)
+* [`config_file_mode`](#config_file_mode)
+* [`includedir`](#includedir)
+* [`install_options`](#install_options)
+* [`install_secret_file`](#install_secret_file)
+* [`manage_config_file`](#manage_config_file)
+* [`options`](#options)
+* [`override_options`](#override_options)
+* [`package_ensure`](#package_ensure)
+* [`package_manage`](#package_manage)
+* [`package_name`](#package_name)
+* [`package_provider`](#package_provider)
+* [`package_source`](#package_source)
+* [`purge_conf_dir`](#purge_conf_dir)
+* [`remove_default_accounts`](#remove_default_accounts)
+* [`restart`](#restart)
+* [`root_group`](#root_group)
+* [`mysql_group`](#mysql_group)
+* [`mycnf_owner`](#mycnf_owner)
+* [`mycnf_group`](#mycnf_group)
+* [`root_password`](#root_password)
+* [`service_enabled`](#service_enabled)
+* [`service_manage`](#service_manage)
+* [`service_name`](#service_name)
+* [`service_provider`](#service_provider)
+* [`create_root_user`](#create_root_user)
+* [`create_root_my_cnf`](#create_root_my_cnf)
+* [`users`](#users)
+* [`grants`](#grants)
+* [`databases`](#databases)
+* [`enabled`](#enabled)
+* [`manage_service`](#manage_service)
+* [`old_root_password`](#old_root_password)
+* [`managed_dirs`](#managed_dirs)
+* [`create_root_login_file`](#create_root_login_file)
+* [`login_file`](#login_file)
+
+##### `config_file`
Data type: `Any`
@@ -441,7 +518,7 @@ The location, as a path, of the MySQL configuration file.
Default value: `$mysql::params::config_file`
-##### `config_file_mode`
+##### `config_file_mode`
Data type: `Any`
@@ -449,7 +526,7 @@ The MySQL configuration file's permissions mode.
Default value: `$mysql::params::config_file_mode`
-##### `includedir`
+##### `includedir`
Data type: `Any`
@@ -457,7 +534,7 @@ The location, as a path, of !includedir for custom configuration overrides.
Default value: `$mysql::params::includedir`
-##### `install_options`
+##### `install_options`
Data type: `Any`
@@ -465,7 +542,7 @@ Passes [install_options](https://docs.puppetlabs.com/references/latest/type.html
Default value: ``undef``
-##### `install_secret_file`
+##### `install_secret_file`
Data type: `Any`
@@ -473,7 +550,7 @@ Path to secret file containing temporary root password.
Default value: `$mysql::params::install_secret_file`
-##### `manage_config_file`
+##### `manage_config_file`
Data type: `Any`
@@ -481,7 +558,7 @@ Whether the MySQL configuration file should be managed. Valid values are `true`,
Default value: `$mysql::params::manage_config_file`
-##### `options`
+##### `options`
Data type: `Mysql::Options`
@@ -489,7 +566,7 @@ A hash of options structured like the override_options, but not merged with the
Default value: `{}`
-##### `override_options`
+##### `override_options`
Data type: `Any`
@@ -497,7 +574,7 @@ Specifies override options to pass into MySQL. Structured like a hash in the my.
Default value: `{}`
-##### `package_ensure`
+##### `package_ensure`
Data type: `Any`
@@ -505,7 +582,7 @@ Whether the package exists or should be a specific version. Valid values are 'pr
Default value: `$mysql::params::server_package_ensure`
-##### `package_manage`
+##### `package_manage`
Data type: `Any`
@@ -513,7 +590,7 @@ Whether to manage the MySQL server package. Defaults to `true`.
Default value: `$mysql::params::server_package_manage`
-##### `package_name`
+##### `package_name`
Data type: `Any`
@@ -521,7 +598,7 @@ The name of the MySQL server package to install.
Default value: `$mysql::params::server_package_name`
-##### `package_provider`
+##### `package_provider`
Data type: `Any`
@@ -529,7 +606,7 @@ Define a specific provider for package install.
Default value: ``undef``
-##### `package_source`
+##### `package_source`
Data type: `Any`
@@ -537,7 +614,7 @@ The location of the package source (require for some package provider)
Default value: ``undef``
-##### `purge_conf_dir`
+##### `purge_conf_dir`
Data type: `Any`
@@ -545,7 +622,7 @@ Whether the `includedir` directory should be purged. Valid values are `true`, `f
Default value: `$mysql::params::purge_conf_dir`
-##### `remove_default_accounts`
+##### `remove_default_accounts`
Data type: `Any`
@@ -553,7 +630,7 @@ Specifies whether to automatically include `mysql::server::account_security`. Va
Default value: ``false``
-##### `restart`
+##### `restart`
Data type: `Any`
@@ -561,7 +638,7 @@ Whether the service should be restarted when things change. Valid values are `tr
Default value: `$mysql::params::restart`
-##### `root_group`
+##### `root_group`
Data type: `Any`
@@ -569,7 +646,7 @@ The name of the group used for root. Can be a group name or a group ID. See more
Default value: `$mysql::params::root_group`
-##### `mysql_group`
+##### `mysql_group`
Data type: `Any`
@@ -577,7 +654,7 @@ The name of the group of the MySQL daemon user. Can be a group name or a group I
Default value: `$mysql::params::mysql_group`
-##### `mycnf_owner`
+##### `mycnf_owner`
Data type: `Any`
@@ -585,7 +662,7 @@ Name or user-id who owns the mysql-config-file.
Default value: `$mysql::params::mycnf_owner`
-##### `mycnf_group`
+##### `mycnf_group`
Data type: `Any`
@@ -593,7 +670,7 @@ Name or group-id which owns the mysql-config-file.
Default value: `$mysql::params::mycnf_group`
-##### `root_password`
+##### `root_password`
Data type: `Any`
@@ -601,7 +678,7 @@ The MySQL root password. Puppet attempts to set the root password and update `/r
Default value: `$mysql::params::root_password`
-##### `service_enabled`
+##### `service_enabled`
Data type: `Any`
@@ -609,7 +686,7 @@ Specifies whether the service should be enabled. Valid values are `true`, `false
Default value: `$mysql::params::server_service_enabled`
-##### `service_manage`
+##### `service_manage`
Data type: `Any`
@@ -617,7 +694,7 @@ Specifies whether the service should be managed. Valid values are `true`, `false
Default value: `$mysql::params::server_service_manage`
-##### `service_name`
+##### `service_name`
Data type: `Any`
@@ -625,7 +702,7 @@ The name of the MySQL server service. Defaults are OS dependent, defined in 'par
Default value: `$mysql::params::server_service_name`
-##### `service_provider`
+##### `service_provider`
Data type: `Any`
@@ -633,7 +710,7 @@ The provider to use to manage the service. For Ubuntu, defaults to 'upstart'; ot
Default value: `$mysql::params::server_service_provider`
-##### `create_root_user`
+##### `create_root_user`
Data type: `Any`
@@ -641,7 +718,7 @@ Whether root user should be created. Valid values are `true`, `false`. Defaults
Default value: `$mysql::params::create_root_user`
-##### `create_root_my_cnf`
+##### `create_root_my_cnf`
Data type: `Any`
@@ -649,7 +726,7 @@ Whether to create `/root/.my.cnf`. Valid values are `true`, `false`. Defaults to
Default value: `$mysql::params::create_root_my_cnf`
-##### `users`
+##### `users`
Data type: `Any`
@@ -657,7 +734,7 @@ Optional hash of users to create, which are passed to [mysql_user](#mysql_user).
Default value: `{}`
-##### `grants`
+##### `grants`
Data type: `Any`
@@ -665,7 +742,7 @@ Optional hash of grants, which are passed to [mysql_grant](#mysql_grant).
Default value: `{}`
-##### `databases`
+##### `databases`
Data type: `Any`
@@ -673,7 +750,7 @@ Optional hash of databases to create, which are passed to [mysql_database](#mysq
Default value: `{}`
-##### `enabled`
+##### `enabled`
Data type: `Any`
@@ -681,7 +758,7 @@ _Deprecated_
Default value: ``undef``
-##### `manage_service`
+##### `manage_service`
Data type: `Any`
@@ -689,7 +766,7 @@ _Deprecated_
Default value: ``undef``
-##### `old_root_password`
+##### `old_root_password`
Data type: `Any`
@@ -697,7 +774,7 @@ This parameter no longer does anything. It exists only for backwards compatibili
Default value: ``undef``
-##### `managed_dirs`
+##### `managed_dirs`
Data type: `Any`
@@ -705,7 +782,7 @@ Data type: `Any`
Default value: `$mysql::params::managed_dirs`
-##### `create_root_login_file`
+##### `create_root_login_file`
Data type: `Any`
@@ -713,7 +790,7 @@ Data type: `Any`
Default value: `$mysql::params::create_root_login_file`
-##### `login_file`
+##### `login_file`
Data type: `Any`
@@ -721,7 +798,7 @@ Data type: `Any`
Default value: `$mysql::params::login_file`
-### `mysql::server::backup`
+### `mysql::server::backup`
Create and manage a MySQL backup.
@@ -747,9 +824,36 @@ class { 'mysql::server::backup':
#### Parameters
-The following parameters are available in the `mysql::server::backup` class.
-
-##### `backupuser`
+The following parameters are available in the `mysql::server::backup` class:
+
+* [`backupuser`](#backupuser)
+* [`backuppassword`](#backuppassword)
+* [`backupdir`](#backupdir)
+* [`backupdirmode`](#backupdirmode)
+* [`backupdirowner`](#backupdirowner)
+* [`backupdirgroup`](#backupdirgroup)
+* [`backupcompress`](#backupcompress)
+* [`backupmethod`](#backupmethod)
+* [`backup_success_file_path`](#backup_success_file_path)
+* [`backuprotate`](#backuprotate)
+* [`ignore_events`](#ignore_events)
+* [`delete_before_dump`](#delete_before_dump)
+* [`backupdatabases`](#backupdatabases)
+* [`file_per_database`](#file_per_database)
+* [`include_routines`](#include_routines)
+* [`include_triggers`](#include_triggers)
+* [`incremental_backups`](#incremental_backups)
+* [`ensure`](#ensure)
+* [`time`](#time)
+* [`prescript`](#prescript)
+* [`postscript`](#postscript)
+* [`execpath`](#execpath)
+* [`provider`](#provider)
+* [`maxallowedpacket`](#maxallowedpacket)
+* [`optional_args`](#optional_args)
+* [`install_cron`](#install_cron)
+
+##### `backupuser`
Data type: `Any`
@@ -757,7 +861,7 @@ MySQL user to create with backup administrator privileges.
Default value: ``undef``
-##### `backuppassword`
+##### `backuppassword`
Data type: `Any`
@@ -765,7 +869,7 @@ Password to create for `backupuser`.
Default value: ``undef``
-##### `backupdir`
+##### `backupdir`
Data type: `Any`
@@ -773,7 +877,7 @@ Directory to store backup.
Default value: ``undef``
-##### `backupdirmode`
+##### `backupdirmode`
Data type: `Any`
@@ -781,7 +885,7 @@ Permissions applied to the backup directory. This parameter is passed directly t
Default value: `'0700'`
-##### `backupdirowner`
+##### `backupdirowner`
Data type: `Any`
@@ -789,7 +893,7 @@ Owner for the backup directory. This parameter is passed directly to the file re
Default value: `'root'`
-##### `backupdirgroup`
+##### `backupdirgroup`
Data type: `Any`
@@ -797,7 +901,7 @@ Group owner for the backup directory. This parameter is passed directly to the f
Default value: `$mysql::params::root_group`
-##### `backupcompress`
+##### `backupcompress`
Data type: `Any`
@@ -805,7 +909,7 @@ Whether or not to compress the backup (when using the mysqldump or xtrabackup pr
Default value: ``true``
-##### `backupmethod`
+##### `backupmethod`
Data type: `Any`
@@ -813,7 +917,7 @@ The execution binary for backing up. ex. mysqldump, xtrabackup, mariabackup
Default value: ``undef``
-##### `backup_success_file_path`
+##### `backup_success_file_path`
Data type: `Any`
@@ -821,7 +925,7 @@ Specify a path where upon successfull backup a file should be created for checki
Default value: `'/tmp/mysqlbackup_success'`
-##### `backuprotate`
+##### `backuprotate`
Data type: `Any`
@@ -829,7 +933,7 @@ Backup rotation interval in 24 hour periods.
Default value: `30`
-##### `ignore_events`
+##### `ignore_events`
Data type: `Any`
@@ -837,7 +941,7 @@ Ignore the mysql.event table.
Default value: ``true``
-##### `delete_before_dump`
+##### `delete_before_dump`
Data type: `Any`
@@ -845,7 +949,7 @@ Whether to delete old .sql files before backing up. Setting to true deletes old
Default value: ``false``
-##### `backupdatabases`
+##### `backupdatabases`
Data type: `Any`
@@ -853,7 +957,7 @@ Databases to backup (required if using xtrabackup provider). By default `[]` wil
Default value: `[]`
-##### `file_per_database`
+##### `file_per_database`
Data type: `Any`
@@ -861,7 +965,7 @@ Use file per database mode creating one file per database backup.
Default value: ``false``
-##### `include_routines`
+##### `include_routines`
Data type: `Any`
@@ -869,7 +973,7 @@ Dump stored routines (procedures and functions) from dumped databases when doing
Default value: ``false``
-##### `include_triggers`
+##### `include_triggers`
Data type: `Any`
@@ -877,7 +981,7 @@ Dump triggers for each dumped table when doing a `file_per_database` backup.
Default value: ``false``
-##### `incremental_backups`
+##### `incremental_backups`
Data type: `Any`
@@ -885,7 +989,7 @@ A flag to activate/deactivate incremental backups. Currently only supported by t
Default value: ``true``
-##### `ensure`
+##### `ensure`
Data type: `Any`
@@ -893,7 +997,7 @@ Data type: `Any`
Default value: `'present'`
-##### `time`
+##### `time`
Data type: `Any`
@@ -901,7 +1005,7 @@ An array of two elements to set the backup time. Allows ['23', '5'] (i.e., 23:05
Default value: `['23', '5']`
-##### `prescript`
+##### `prescript`
Data type: `Any`
@@ -909,7 +1013,7 @@ A script that is executed before the backup begins.
Default value: ``false``
-##### `postscript`
+##### `postscript`
Data type: `Any`
@@ -917,7 +1021,7 @@ A script that is executed when the backup is finished. This could be used to syn
Default value: ``false``
-##### `execpath`
+##### `execpath`
Data type: `Any`
@@ -925,7 +1029,7 @@ Allows you to set a custom PATH should your MySQL installation be non-standard p
Default value: `'/usr/bin:/usr/sbin:/bin:/sbin'`
-##### `provider`
+##### `provider`
Data type: `Any`
@@ -933,7 +1037,7 @@ Sets the server backup implementation. Valid values are:
Default value: `'mysqldump'`
-##### `maxallowedpacket`
+##### `maxallowedpacket`
Data type: `Any`
@@ -941,7 +1045,7 @@ Defines the maximum SQL statement size for the backup dump script. The default v
Default value: `'1M'`
-##### `optional_args`
+##### `optional_args`
Data type: `Any`
@@ -949,7 +1053,7 @@ Specifies an array of optional arguments which should be passed through to the b
Default value: `[]`
-##### `install_cron`
+##### `install_cron`
Data type: `Any`
@@ -957,15 +1061,19 @@ Manage installation of cron package
Default value: ``true``
-### `mysql::server::monitor`
+### `mysql::server::monitor`
This is a helper class to add a monitoring user to the database
#### Parameters
-The following parameters are available in the `mysql::server::monitor` class.
+The following parameters are available in the `mysql::server::monitor` class:
-##### `mysql_monitor_username`
+* [`mysql_monitor_username`](#mysql_monitor_username)
+* [`mysql_monitor_password`](#mysql_monitor_password)
+* [`mysql_monitor_hostname`](#mysql_monitor_hostname)
+
+##### `mysql_monitor_username`
Data type: `Any`
@@ -973,7 +1081,7 @@ The username to create for MySQL monitoring.
Default value: `''`
-##### `mysql_monitor_password`
+##### `mysql_monitor_password`
Data type: `Any`
@@ -981,7 +1089,7 @@ The password to create for MySQL monitoring.
Default value: `''`
-##### `mysql_monitor_hostname`
+##### `mysql_monitor_hostname`
Data type: `Any`
@@ -989,15 +1097,20 @@ The hostname from which the monitoring user requests are allowed access.
Default value: `''`
-### `mysql::server::mysqltuner`
+### `mysql::server::mysqltuner`
Manage the MySQLTuner package.
#### Parameters
-The following parameters are available in the `mysql::server::mysqltuner` class.
+The following parameters are available in the `mysql::server::mysqltuner` class:
-##### `ensure`
+* [`ensure`](#ensure)
+* [`version`](#version)
+* [`source`](#source)
+* [`tuner_location`](#tuner_location)
+
+##### `ensure`
Data type: `Any`
@@ -1005,7 +1118,7 @@ Ensures that the resource exists. Valid values are 'present', 'absent'. Defaults
Default value: `'present'`
-##### `version`
+##### `version`
Data type: `Any`
@@ -1013,7 +1126,7 @@ The version to install from the major/MySQLTuner-perl github repository. Must be
Default value: `'v1.3.0'`
-##### `source`
+##### `source`
Data type: `Any`
@@ -1021,7 +1134,7 @@ Source path for the mysqltuner package.
Default value: ``undef``
-##### `tuner_location`
+##### `tuner_location`
Data type: `Any`
@@ -1031,7 +1144,7 @@ Default value: `'/usr/local/bin/mysqltuner'`
## Defined types
-### `mysql::db`
+### `mysql::db`
Create and configure a MySQL database.
@@ -1050,21 +1163,37 @@ mysql::db { 'mydb':
#### Parameters
-The following parameters are available in the `mysql::db` defined type.
+The following parameters are available in the `mysql::db` defined type:
-##### `user`
+* [`user`](#user)
+* [`password`](#password)
+* [`tls_options`](#tls_options)
+* [`dbname`](#dbname)
+* [`charset`](#charset)
+* [`collate`](#collate)
+* [`host`](#host)
+* [`grant`](#grant)
+* [`grant_options`](#grant_options)
+* [`sql`](#sql)
+* [`enforce_sql`](#enforce_sql)
+* [`ensure`](#ensure)
+* [`import_timeout`](#import_timeout)
+* [`import_cat_cmd`](#import_cat_cmd)
+* [`mysql_exec_path`](#mysql_exec_path)
+
+##### `user`
Data type: `Any`
The user for the database you're creating.
-##### `password`
+##### `password`
Data type: `Any`
The password for $user for the database you're creating.
-##### `tls_options`
+##### `tls_options`
Data type: `Any`
@@ -1072,7 +1201,7 @@ The tls_options for $user for the database you're creating.
Default value: ``undef``
-##### `dbname`
+##### `dbname`
Data type: `Any`
@@ -1080,7 +1209,7 @@ The name of the database to create.
Default value: `$name`
-##### `charset`
+##### `charset`
Data type: `Any`
@@ -1088,7 +1217,7 @@ The character set for the database.
Default value: `'utf8'`
-##### `collate`
+##### `collate`
Data type: `Any`
@@ -1096,7 +1225,7 @@ The collation for the database.
Default value: `'utf8_general_ci'`
-##### `host`
+##### `host`
Data type: `Any`
@@ -1104,7 +1233,7 @@ The host to use as part of user@host for grants.
Default value: `'localhost'`
-##### `grant`
+##### `grant`
Data type: `Any`
@@ -1112,7 +1241,7 @@ The privileges to be granted for user@host on the database.
Default value: `'ALL'`
-##### `grant_options`
+##### `grant_options`
Data type: `Any`
@@ -1120,7 +1249,7 @@ The grant_options for the grant for user@host on the database.
Default value: ``undef``
-##### `sql`
+##### `sql`
Data type: `Optional[Variant[Array, Hash, String]]`
@@ -1128,7 +1257,7 @@ The path to the sqlfile you want to execute. This can be single file specified a
Default value: ``undef``
-##### `enforce_sql`
+##### `enforce_sql`
Data type: `Any`
@@ -1136,7 +1265,7 @@ Specifies whether executing the sqlfiles should happen on every run. If set to f
Default value: ``false``
-##### `ensure`
+##### `ensure`
Data type: `Enum['absent', 'present']`
@@ -1144,7 +1273,7 @@ Specifies whether to create the database. Valid values are 'present', 'absent'.
Default value: `'present'`
-##### `import_timeout`
+##### `import_timeout`
Data type: `Any`
@@ -1152,7 +1281,7 @@ Timeout, in seconds, for loading the sqlfiles. Defaults to 300.
Default value: `300`
-##### `import_cat_cmd`
+##### `import_cat_cmd`
Data type: `Any`
@@ -1160,7 +1289,7 @@ Command to read the sqlfile for importing the database. Useful for compressed sq
Default value: `'cat'`
-##### `mysql_exec_path`
+##### `mysql_exec_path`
Data type: `Any`
@@ -1170,7 +1299,7 @@ Default value: `$mysql::params::exec_path`
## Resource types
-### `mysql_grant`
+### `mysql_grant`
@summary
Manage a MySQL user's rights.
@@ -1209,18 +1338,21 @@ User to operate on.
The following parameters are available in the `mysql_grant` type.
-##### `name`
+* [`name`](#name)
+* [`provider`](#provider)
+
+##### `name`
namevar
Name to describe the grant.
-##### `provider`
+##### `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`
+### `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.
@@ -1296,7 +1428,10 @@ Username to be entered into the login path.
The following parameters are available in the `mysql_login_path` type.
-##### `name`
+* [`name`](#name)
+* [`owner`](#owner)
+
+##### `name`
namevar
@@ -1304,7 +1439,7 @@ Data type: `String`
Name of the login path you want to manage.
-##### `owner`
+##### `owner`
namevar
@@ -1314,7 +1449,7 @@ The user to whom the logon path should belong.
Default value: `root`
-### `mysql_plugin`
+### `mysql_plugin`
Manage MySQL plugins.
@@ -1350,18 +1485,21 @@ The name of the library
The following parameters are available in the `mysql_plugin` type.
-##### `name`
+* [`name`](#name)
+* [`provider`](#provider)
+
+##### `name`
namevar
The name of the MySQL plugin to manage.
-##### `provider`
+##### `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`
+### `mysql_user`
@summary
Manage a MySQL user. This includes management of users password as well as privileges.
@@ -1422,20 +1560,23 @@ Options to that set the TLS-related REQUIRE attributes for the user.
The following parameters are available in the `mysql_user` type.
-##### `name`
+* [`name`](#name)
+* [`provider`](#provider)
+
+##### `name`
namevar
The name of the user. This uses the 'username@hostname' or username@hostname.
-##### `provider`
+##### `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`
+### `mysql::normalise_and_deepmerge`
Type: Ruby 4.x API
@@ -1481,7 +1622,7 @@ Data type: `Any`
-### `mysql::password`
+### `mysql::password`
Type: Ruby 4.x API
@@ -1500,7 +1641,7 @@ Data type: `String`
Plain text password.
-### `mysql::strip_hash`
+### `mysql::strip_hash`
Type: Ruby 4.x API
@@ -1519,7 +1660,7 @@ Data type: `Hash`
Hash to be stripped
-### `mysql_password`
+### `mysql_password`
Type: Ruby 4.x API
@@ -1539,15 +1680,19 @@ Plain text password.
## Data types
-### `Mysql::Options`
+### `Mysql::Options`
The Mysql::Options data type.
-Alias of `Hash[String, Hash]`
+Alias of
+
+```puppet
+Hash[String, Hash]
+```
## Tasks
-### `export`
+### `export`
Allows you to backup your database to local file.
@@ -1579,7 +1724,7 @@ Data type: `String[1]`
Path to file you want backup to
-### `sql`
+### `sql`
Allows you to execute arbitary SQL
diff --git a/metadata.json b/metadata.json
index cb6754d92..ea3c5f3e4 100644
--- a/metadata.json
+++ b/metadata.json
@@ -1,6 +1,6 @@
{
"name": "puppetlabs-mysql",
- "version": "10.9.1",
+ "version": "10.10.0",
"author": "puppetlabs",
"summary": "Installs, configures, and manages the MySQL service.",
"license": "Apache-2.0",