diff --git a/CHANGELOG.md b/CHANGELOG.md index 241bf5d46..a106d5e93 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,21 @@ 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). +## [v13.1.0](https://github.com/puppetlabs/puppetlabs-mysql/tree/v13.1.0) (2022-12-20) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-mysql/compare/v13.0.1...v13.1.0) + +### Added + +- mysql::db sql parameter support filenames with multiple dots [\#1505](https://github.com/puppetlabs/puppetlabs-mysql/pull/1505) ([skn-bvdh](https://github.com/skn-bvdh)) + +### Fixed + +- \(GH-1518\) Declare minimum Puppet version 6.24.0 [\#1519](https://github.com/puppetlabs/puppetlabs-mysql/pull/1519) ([pmcmaw](https://github.com/pmcmaw)) +- \(GH-1516\) Update sql example to use array [\#1517](https://github.com/puppetlabs/puppetlabs-mysql/pull/1517) ([pmcmaw](https://github.com/pmcmaw)) +- do not emit other ssl directives when ssl = false [\#1513](https://github.com/puppetlabs/puppetlabs-mysql/pull/1513) ([kjetilho](https://github.com/kjetilho)) +- \(GH-1491\) Fix for Ubuntu 22.04 [\#1508](https://github.com/puppetlabs/puppetlabs-mysql/pull/1508) ([david22swan](https://github.com/david22swan)) + ## [v13.0.1](https://github.com/puppetlabs/puppetlabs-mysql/tree/v13.0.1) (2022-10-24) [Full Changelog](https://github.com/puppetlabs/puppetlabs-mysql/compare/v13.0.0...v13.0.1) diff --git a/REFERENCE.md b/REFERENCE.md index 0e6a79e00..fd39717f5 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -8,10 +8,10 @@ #### Public Classes -* [`mysql::bindings`](#mysqlbindings): Parent class for MySQL bindings. -* [`mysql::client`](#mysqlclient): Installs and configures the MySQL client. -* [`mysql::server`](#mysqlserver): Installs and configures the MySQL server. -* [`mysql::server::backup`](#mysqlserverbackup): Create and manage a MySQL backup. +* [`mysql::bindings`](#mysql--bindings): Parent class for MySQL bindings. +* [`mysql::client`](#mysql--client): Installs and configures the MySQL client. +* [`mysql::server`](#mysql--server): Installs and configures the MySQL server. +* [`mysql::server::backup`](#mysql--server--backup): Create and manage a MySQL backup. #### Private Classes @@ -38,7 +38,7 @@ ### Defined types -* [`mysql::db`](#mysqldb): Create and configure a MySQL database. +* [`mysql::db`](#mysql--db): Create and configure a MySQL database. ### Resource types @@ -56,14 +56,14 @@ ### Functions -* [`mysql::normalise_and_deepmerge`](#mysqlnormalise_and_deepmerge): Recursively merges two or more hashes together, normalises keys with differing use of dashes and underscores. -* [`mysql::password`](#mysqlpassword): Hash a string as mysql's "PASSWORD()" function would do it -* [`mysql::strip_hash`](#mysqlstrip_hash): When given a hash this function strips out all blank entries. +* [`mysql::normalise_and_deepmerge`](#mysql--normalise_and_deepmerge): Recursively merges two or more hashes together, normalises keys with differing use of dashes and underscores. +* [`mysql::password`](#mysql--password): Hash a string as mysql's "PASSWORD()" function would do it +* [`mysql::strip_hash`](#mysql--strip_hash): When given a hash this function strips out all blank entries. * [`mysql_password`](#mysql_password): DEPRECATED. Use the namespaced function [`mysql::password`](#mysqlpassword) instead. ### Data types -* [`Mysql::Options`](#mysqloptions): A hash of options structured like the override_options, but not merged with the default options. +* [`Mysql::Options`](#Mysql--Options): A hash of options structured like the override_options, but not merged with the default options. ### Tasks @@ -72,7 +72,7 @@ ## Classes -### `mysql::bindings` +### `mysql::bindings` Parent class for MySQL bindings. @@ -93,101 +93,101 @@ class { 'mysql::bindings': 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` +* [`install_options`](#-mysql--bindings--install_options) +* [`java_enable`](#-mysql--bindings--java_enable) +* [`perl_enable`](#-mysql--bindings--perl_enable) +* [`php_enable`](#-mysql--bindings--php_enable) +* [`python_enable`](#-mysql--bindings--python_enable) +* [`ruby_enable`](#-mysql--bindings--ruby_enable) +* [`client_dev`](#-mysql--bindings--client_dev) +* [`daemon_dev`](#-mysql--bindings--daemon_dev) +* [`java_package_ensure`](#-mysql--bindings--java_package_ensure) +* [`java_package_name`](#-mysql--bindings--java_package_name) +* [`java_package_provider`](#-mysql--bindings--java_package_provider) +* [`perl_package_ensure`](#-mysql--bindings--perl_package_ensure) +* [`perl_package_name`](#-mysql--bindings--perl_package_name) +* [`perl_package_provider`](#-mysql--bindings--perl_package_provider) +* [`php_package_ensure`](#-mysql--bindings--php_package_ensure) +* [`php_package_name`](#-mysql--bindings--php_package_name) +* [`php_package_provider`](#-mysql--bindings--php_package_provider) +* [`python_package_ensure`](#-mysql--bindings--python_package_ensure) +* [`python_package_name`](#-mysql--bindings--python_package_name) +* [`python_package_provider`](#-mysql--bindings--python_package_provider) +* [`ruby_package_ensure`](#-mysql--bindings--ruby_package_ensure) +* [`ruby_package_name`](#-mysql--bindings--ruby_package_name) +* [`ruby_package_provider`](#-mysql--bindings--ruby_package_provider) +* [`client_dev_package_ensure`](#-mysql--bindings--client_dev_package_ensure) +* [`client_dev_package_name`](#-mysql--bindings--client_dev_package_name) +* [`client_dev_package_provider`](#-mysql--bindings--client_dev_package_provider) +* [`daemon_dev_package_ensure`](#-mysql--bindings--daemon_dev_package_ensure) +* [`daemon_dev_package_name`](#-mysql--bindings--daemon_dev_package_name) +* [`daemon_dev_package_provider`](#-mysql--bindings--daemon_dev_package_provider) + +##### `install_options` Data type: `Any` Passes `install_options` array to managed package resources. You must pass the [appropriate options](https://docs.puppetlabs.com/references/latest/type.html#package-attribute-install_options) for the package manager(s). -Default value: ``undef`` +Default value: `undef` -##### `java_enable` +##### `java_enable` Data type: `Any` Specifies whether `::mysql::bindings::java` should be included. Valid values are `true`, `false`. -Default value: ``false`` +Default value: `false` -##### `perl_enable` +##### `perl_enable` Data type: `Any` Specifies whether `mysql::bindings::perl` should be included. Valid values are `true`, `false`. -Default value: ``false`` +Default value: `false` -##### `php_enable` +##### `php_enable` Data type: `Any` Specifies whether `mysql::bindings::php` should be included. Valid values are `true`, `false`. -Default value: ``false`` +Default value: `false` -##### `python_enable` +##### `python_enable` Data type: `Any` Specifies whether `mysql::bindings::python` should be included. Valid values are `true`, `false`. -Default value: ``false`` +Default value: `false` -##### `ruby_enable` +##### `ruby_enable` Data type: `Any` Specifies whether `mysql::bindings::ruby` should be included. Valid values are `true`, `false`. -Default value: ``false`` +Default value: `false` -##### `client_dev` +##### `client_dev` Data type: `Any` Specifies whether `::mysql::bindings::client_dev` should be included. Valid values are `true`', `false`. -Default value: ``false`` +Default value: `false` -##### `daemon_dev` +##### `daemon_dev` Data type: `Any` Specifies whether `::mysql::bindings::daemon_dev` should be included. Valid values are `true`, `false`. -Default value: ``false`` +Default value: `false` -##### `java_package_ensure` +##### `java_package_ensure` Data type: `Any` @@ -195,7 +195,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` @@ -203,7 +203,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` @@ -211,7 +211,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` @@ -219,7 +219,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` @@ -227,7 +227,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` @@ -235,7 +235,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` @@ -243,7 +243,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` @@ -251,7 +251,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` @@ -259,7 +259,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` @@ -267,7 +267,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` @@ -275,7 +275,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` @@ -283,7 +283,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` @@ -291,7 +291,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` @@ -299,7 +299,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` @@ -307,7 +307,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` @@ -315,7 +315,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` @@ -323,7 +323,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` @@ -331,7 +331,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` @@ -339,7 +339,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` @@ -347,7 +347,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` @@ -355,7 +355,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. @@ -375,15 +375,15 @@ class {'::mysql::client': 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) -* [`package_name`](#package_name) -* [`package_provider`](#package_provider) -* [`package_source`](#package_source) +* [`bindings_enable`](#-mysql--client--bindings_enable) +* [`install_options`](#-mysql--client--install_options) +* [`package_ensure`](#-mysql--client--package_ensure) +* [`package_manage`](#-mysql--client--package_manage) +* [`package_name`](#-mysql--client--package_name) +* [`package_provider`](#-mysql--client--package_provider) +* [`package_source`](#-mysql--client--package_source) -##### `bindings_enable` +##### `bindings_enable` Data type: `Any` @@ -391,15 +391,15 @@ Whether to automatically install all bindings. Valid values are `true`, `false`. Default value: `$mysql::params::bindings_enable` -##### `install_options` +##### `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`` +Default value: `undef` -##### `package_ensure` +##### `package_ensure` Data type: `Any` @@ -407,7 +407,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` @@ -415,7 +415,7 @@ Whether to manage the MySQL client package. Defaults to `true`. Default value: `$mysql::params::client_package_manage` -##### `package_name` +##### `package_name` Data type: `Any` @@ -423,23 +423,23 @@ The name of the MySQL client package to install. Default value: `$mysql::params::client_package_name` -##### `package_provider` +##### `package_provider` Data type: `Any` -Default value: ``undef`` +Default value: `undef` -##### `package_source` +##### `package_source` Data type: `Any` -Default value: ``undef`` +Default value: `undef` -### `mysql::server` +### `mysql::server` Installs and configures the MySQL server. @@ -460,43 +460,43 @@ class { '::mysql::server': 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) -* [`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` +* [`config_file`](#-mysql--server--config_file) +* [`config_file_mode`](#-mysql--server--config_file_mode) +* [`includedir`](#-mysql--server--includedir) +* [`install_options`](#-mysql--server--install_options) +* [`manage_config_file`](#-mysql--server--manage_config_file) +* [`options`](#-mysql--server--options) +* [`override_options`](#-mysql--server--override_options) +* [`package_ensure`](#-mysql--server--package_ensure) +* [`package_manage`](#-mysql--server--package_manage) +* [`package_name`](#-mysql--server--package_name) +* [`package_provider`](#-mysql--server--package_provider) +* [`package_source`](#-mysql--server--package_source) +* [`purge_conf_dir`](#-mysql--server--purge_conf_dir) +* [`remove_default_accounts`](#-mysql--server--remove_default_accounts) +* [`restart`](#-mysql--server--restart) +* [`root_group`](#-mysql--server--root_group) +* [`mysql_group`](#-mysql--server--mysql_group) +* [`mycnf_owner`](#-mysql--server--mycnf_owner) +* [`mycnf_group`](#-mysql--server--mycnf_group) +* [`root_password`](#-mysql--server--root_password) +* [`service_enabled`](#-mysql--server--service_enabled) +* [`service_manage`](#-mysql--server--service_manage) +* [`service_name`](#-mysql--server--service_name) +* [`service_provider`](#-mysql--server--service_provider) +* [`create_root_user`](#-mysql--server--create_root_user) +* [`create_root_my_cnf`](#-mysql--server--create_root_my_cnf) +* [`users`](#-mysql--server--users) +* [`grants`](#-mysql--server--grants) +* [`databases`](#-mysql--server--databases) +* [`enabled`](#-mysql--server--enabled) +* [`manage_service`](#-mysql--server--manage_service) +* [`old_root_password`](#-mysql--server--old_root_password) +* [`managed_dirs`](#-mysql--server--managed_dirs) +* [`create_root_login_file`](#-mysql--server--create_root_login_file) +* [`login_file`](#-mysql--server--login_file) + +##### `config_file` Data type: `Any` @@ -504,7 +504,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` @@ -512,7 +512,7 @@ The MySQL configuration file's permissions mode. Default value: `$mysql::params::config_file_mode` -##### `includedir` +##### `includedir` Data type: `Any` @@ -520,15 +520,15 @@ The location, as a path, of !includedir for custom configuration overrides. Default value: `$mysql::params::includedir` -##### `install_options` +##### `install_options` Data type: `Any` Passes [install_options](https://docs.puppetlabs.com/references/latest/type.html#package-attribute-install_options) array to managed package resources. You must pass the appropriate options for the specified package manager -Default value: ``undef`` +Default value: `undef` -##### `manage_config_file` +##### `manage_config_file` Data type: `Any` @@ -536,7 +536,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` @@ -544,7 +544,7 @@ A hash of options structured like the override_options, but not merged with the Default value: `{}` -##### `override_options` +##### `override_options` Data type: `Any` @@ -552,7 +552,7 @@ Specifies override options to pass into MySQL. Structured like a hash in the my. Default value: `{}` -##### `package_ensure` +##### `package_ensure` Data type: `Any` @@ -560,7 +560,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` @@ -568,7 +568,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` @@ -576,23 +576,23 @@ The name of the MySQL server package to install. Default value: `$mysql::params::server_package_name` -##### `package_provider` +##### `package_provider` Data type: `Any` Define a specific provider for package install. -Default value: ``undef`` +Default value: `undef` -##### `package_source` +##### `package_source` Data type: `Any` The location of the package source (require for some package provider) -Default value: ``undef`` +Default value: `undef` -##### `purge_conf_dir` +##### `purge_conf_dir` Data type: `Any` @@ -600,15 +600,15 @@ 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` Specifies whether to automatically include `mysql::server::account_security`. Valid values are `true`, `false`. Defaults to `false`. -Default value: ``false`` +Default value: `false` -##### `restart` +##### `restart` Data type: `Any` @@ -616,7 +616,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` @@ -624,7 +624,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` @@ -632,7 +632,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` @@ -640,7 +640,7 @@ Name or user-id who owns the mysql-config-file. Default value: `$mysql::params::mycnf_owner` -##### `mycnf_group` +##### `mycnf_group` Data type: `Any` @@ -648,7 +648,7 @@ Name or group-id which owns the mysql-config-file. Default value: `$mysql::params::mycnf_group` -##### `root_password` +##### `root_password` Data type: `Variant[String, Sensitive[String]]` @@ -656,7 +656,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` @@ -664,7 +664,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` @@ -672,7 +672,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` @@ -680,7 +680,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` @@ -688,7 +688,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` @@ -696,7 +696,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` @@ -704,7 +704,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` @@ -712,7 +712,7 @@ Optional hash of users to create, which are passed to [mysql_user](#mysql_user). Default value: `{}` -##### `grants` +##### `grants` Data type: `Any` @@ -720,7 +720,7 @@ Optional hash of grants, which are passed to [mysql_grant](#mysql_grant). Default value: `{}` -##### `databases` +##### `databases` Data type: `Any` @@ -728,31 +728,31 @@ Optional hash of databases to create, which are passed to [mysql_database](#mysq Default value: `{}` -##### `enabled` +##### `enabled` Data type: `Any` _Deprecated_ -Default value: ``undef`` +Default value: `undef` -##### `manage_service` +##### `manage_service` Data type: `Any` _Deprecated_ -Default value: ``undef`` +Default value: `undef` -##### `old_root_password` +##### `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`` +Default value: `undef` -##### `managed_dirs` +##### `managed_dirs` Data type: `Any` @@ -760,7 +760,7 @@ Data type: `Any` Default value: `$mysql::params::managed_dirs` -##### `create_root_login_file` +##### `create_root_login_file` Data type: `Any` @@ -768,7 +768,7 @@ Data type: `Any` Default value: `$mysql::params::create_root_login_file` -##### `login_file` +##### `login_file` Data type: `Any` @@ -776,7 +776,7 @@ Data type: `Any` Default value: `$mysql::params::login_file` -### `mysql::server::backup` +### `mysql::server::backup` Create and manage a MySQL backup. @@ -813,62 +813,62 @@ class { 'mysql::server::backup': 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) -* [`compression_command`](#compression_command) -* [`compression_extension`](#compression_extension) -* [`backupmethod_package`](#backupmethod_package) -* [`excludedatabases`](#excludedatabases) - -##### `backupuser` +* [`backupuser`](#-mysql--server--backup--backupuser) +* [`backuppassword`](#-mysql--server--backup--backuppassword) +* [`backupdir`](#-mysql--server--backup--backupdir) +* [`backupdirmode`](#-mysql--server--backup--backupdirmode) +* [`backupdirowner`](#-mysql--server--backup--backupdirowner) +* [`backupdirgroup`](#-mysql--server--backup--backupdirgroup) +* [`backupcompress`](#-mysql--server--backup--backupcompress) +* [`backupmethod`](#-mysql--server--backup--backupmethod) +* [`backup_success_file_path`](#-mysql--server--backup--backup_success_file_path) +* [`backuprotate`](#-mysql--server--backup--backuprotate) +* [`ignore_events`](#-mysql--server--backup--ignore_events) +* [`delete_before_dump`](#-mysql--server--backup--delete_before_dump) +* [`backupdatabases`](#-mysql--server--backup--backupdatabases) +* [`file_per_database`](#-mysql--server--backup--file_per_database) +* [`include_routines`](#-mysql--server--backup--include_routines) +* [`include_triggers`](#-mysql--server--backup--include_triggers) +* [`incremental_backups`](#-mysql--server--backup--incremental_backups) +* [`ensure`](#-mysql--server--backup--ensure) +* [`time`](#-mysql--server--backup--time) +* [`prescript`](#-mysql--server--backup--prescript) +* [`postscript`](#-mysql--server--backup--postscript) +* [`execpath`](#-mysql--server--backup--execpath) +* [`provider`](#-mysql--server--backup--provider) +* [`maxallowedpacket`](#-mysql--server--backup--maxallowedpacket) +* [`optional_args`](#-mysql--server--backup--optional_args) +* [`install_cron`](#-mysql--server--backup--install_cron) +* [`compression_command`](#-mysql--server--backup--compression_command) +* [`compression_extension`](#-mysql--server--backup--compression_extension) +* [`backupmethod_package`](#-mysql--server--backup--backupmethod_package) +* [`excludedatabases`](#-mysql--server--backup--excludedatabases) + +##### `backupuser` Data type: `Any` MySQL user to create with backup administrator privileges. -Default value: ``undef`` +Default value: `undef` -##### `backuppassword` +##### `backuppassword` Data type: `Optional[Variant[String, Sensitive[String]]]` Password to create for `backupuser`. -Default value: ``undef`` +Default value: `undef` -##### `backupdir` +##### `backupdir` Data type: `Any` Directory to store backup. -Default value: ``undef`` +Default value: `undef` -##### `backupdirmode` +##### `backupdirmode` Data type: `Any` @@ -876,7 +876,7 @@ Permissions applied to the backup directory. This parameter is passed directly t Default value: `'0700'` -##### `backupdirowner` +##### `backupdirowner` Data type: `Any` @@ -884,7 +884,7 @@ Owner for the backup directory. This parameter is passed directly to the file re Default value: `'root'` -##### `backupdirgroup` +##### `backupdirgroup` Data type: `Any` @@ -892,23 +892,23 @@ 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` Whether or not to compress the backup (when using the mysqldump or xtrabackup provider) -Default value: ``true`` +Default value: `true` -##### `backupmethod` +##### `backupmethod` Data type: `Any` The execution binary for backing up. ex. mysqldump, xtrabackup, mariabackup -Default value: ``undef`` +Default value: `undef` -##### `backup_success_file_path` +##### `backup_success_file_path` Data type: `Any` @@ -916,7 +916,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` @@ -924,23 +924,23 @@ Backup rotation interval in 24 hour periods. Default value: `30` -##### `ignore_events` +##### `ignore_events` Data type: `Any` Ignore the mysql.event table. -Default value: ``true`` +Default value: `true` -##### `delete_before_dump` +##### `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`` +Default value: `false` -##### `backupdatabases` +##### `backupdatabases` Data type: `Any` @@ -948,39 +948,39 @@ Databases to backup (required if using xtrabackup provider). By default `[]` wil Default value: `[]` -##### `file_per_database` +##### `file_per_database` Data type: `Any` Use file per database mode creating one file per database backup. -Default value: ``false`` +Default value: `false` -##### `include_routines` +##### `include_routines` Data type: `Any` Dump stored routines (procedures and functions) from dumped databases when doing a `file_per_database` backup. -Default value: ``false`` +Default value: `false` -##### `include_triggers` +##### `include_triggers` Data type: `Any` Dump triggers for each dumped table when doing a `file_per_database` backup. -Default value: ``false`` +Default value: `false` -##### `incremental_backups` +##### `incremental_backups` Data type: `Any` A flag to activate/deactivate incremental backups. Currently only supported by the xtrabackup provider. -Default value: ``true`` +Default value: `true` -##### `ensure` +##### `ensure` Data type: `Any` @@ -988,7 +988,7 @@ Data type: `Any` Default value: `'present'` -##### `time` +##### `time` Data type: `Any` @@ -996,23 +996,23 @@ 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` A script that is executed before the backup begins. -Default value: ``false`` +Default value: `false` -##### `postscript` +##### `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`` +Default value: `false` -##### `execpath` +##### `execpath` Data type: `Any` @@ -1020,7 +1020,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` @@ -1028,7 +1028,7 @@ Sets the server backup implementation. Valid values are: xtrabackup, mysqldump, Default value: `'mysqldump'` -##### `maxallowedpacket` +##### `maxallowedpacket` Data type: `Any` @@ -1036,7 +1036,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` @@ -1044,32 +1044,32 @@ Specifies an array of optional arguments which should be passed through to the b Default value: `[]` -##### `install_cron` +##### `install_cron` Data type: `Any` Manage installation of cron package -Default value: ``true`` +Default value: `true` -##### `compression_command` +##### `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`` +Default value: `undef` -##### `compression_extension` +##### `compression_extension` Data type: `Any` Configure the file extension for the compressed backup (when using the mysqldump provider) -Default value: ``undef`` +Default value: `undef` -##### `backupmethod_package` +##### `backupmethod_package` Data type: `Any` @@ -1077,7 +1077,7 @@ The package which provides the binary specified by the backupmethod parameter. Default value: `$mysql::params::xtrabackup_package_name` -##### `excludedatabases` +##### `excludedatabases` Data type: `Array[String]` @@ -1087,7 +1087,7 @@ Default value: `[]` ## Defined types -### `mysql::db` +### `mysql::db` Create and configure a MySQL database. @@ -1108,24 +1108,24 @@ mysql::db { 'mydb': The following parameters are available in the `mysql::db` defined type: -* [`name`](#name) -* [`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) - -##### `name` +* [`name`](#-mysql--db--name) +* [`user`](#-mysql--db--user) +* [`password`](#-mysql--db--password) +* [`tls_options`](#-mysql--db--tls_options) +* [`dbname`](#-mysql--db--dbname) +* [`charset`](#-mysql--db--charset) +* [`collate`](#-mysql--db--collate) +* [`host`](#-mysql--db--host) +* [`grant`](#-mysql--db--grant) +* [`grant_options`](#-mysql--db--grant_options) +* [`sql`](#-mysql--db--sql) +* [`enforce_sql`](#-mysql--db--enforce_sql) +* [`ensure`](#-mysql--db--ensure) +* [`import_timeout`](#-mysql--db--import_timeout) +* [`import_cat_cmd`](#-mysql--db--import_cat_cmd) +* [`mysql_exec_path`](#-mysql--db--mysql_exec_path) + +##### `name` The name of the database to create. Database names must: * be longer than 64 characters. @@ -1133,27 +1133,27 @@ The name of the database to create. Database names must: * not contain characters that are not permitted in file names. * not end with space characters. -##### `user` +##### `user` Data type: `Any` The user for the database you're creating. -##### `password` +##### `password` Data type: `Variant[String, Sensitive[String]]` The password for $user for the database you're creating. -##### `tls_options` +##### `tls_options` Data type: `Any` The tls_options for $user for the database you're creating. -Default value: ``undef`` +Default value: `undef` -##### `dbname` +##### `dbname` Data type: `String` @@ -1161,7 +1161,7 @@ The name of the database to create. Default value: `$name` -##### `charset` +##### `charset` Data type: `Any` @@ -1169,7 +1169,7 @@ The character set for the database. Must have the same value as collate to avoid Default value: `'utf8'` -##### `collate` +##### `collate` Data type: `Any` @@ -1177,7 +1177,7 @@ The collation for the database. Must have the same value as charset to avoid cor Default value: `'utf8_general_ci'` -##### `host` +##### `host` Data type: `Any` @@ -1185,7 +1185,7 @@ The host to use as part of user@host for grants. Default value: `'localhost'` -##### `grant` +##### `grant` Data type: `Any` @@ -1193,31 +1193,31 @@ The privileges to be granted for user@host on the database. Default value: `'ALL'` -##### `grant_options` +##### `grant_options` Data type: `Any` The grant_options for the grant for user@host on the database. -Default value: ``undef`` +Default value: `undef` -##### `sql` +##### `sql` Data type: `Optional[Array]` The path to the sqlfile you want to execute. This can be an array containing one or more file paths. -Default value: ``undef`` +Default value: `undef` -##### `enforce_sql` +##### `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`` +Default value: `false` -##### `ensure` +##### `ensure` Data type: `Enum['absent', 'present']` @@ -1225,7 +1225,7 @@ Specifies whether to create the database. Valid values are 'present', 'absent'. Default value: `'present'` -##### `import_timeout` +##### `import_timeout` Data type: `Any` @@ -1233,7 +1233,7 @@ Timeout, in seconds, for loading the sqlfiles. Defaults to 300. Default value: `300` -##### `import_cat_cmd` +##### `import_cat_cmd` Data type: `Enum['cat', 'zcat', 'bzcat']` @@ -1241,13 +1241,13 @@ 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` -Default value: ``undef`` +Default value: `undef` ## Resource types @@ -1290,16 +1290,16 @@ User to operate on. The following parameters are available in the `mysql_grant` type. -* [`name`](#name) -* [`provider`](#provider) +* [`name`](#-mysql_grant--name) +* [`provider`](#-mysql_grant--provider) -##### `name` +##### `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. @@ -1380,10 +1380,10 @@ Username to be entered into the login path. The following parameters are available in the `mysql_login_path` type. -* [`name`](#name) -* [`owner`](#owner) +* [`name`](#-mysql_login_path--name) +* [`owner`](#-mysql_login_path--owner) -##### `name` +##### `name` namevar @@ -1391,7 +1391,7 @@ Data type: `String` Name of the login path you want to manage. -##### `owner` +##### `owner` namevar @@ -1437,16 +1437,16 @@ The name of the library The following parameters are available in the `mysql_plugin` type. -* [`name`](#name) -* [`provider`](#provider) +* [`name`](#-mysql_plugin--name) +* [`provider`](#-mysql_plugin--provider) -##### `name` +##### `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. @@ -1512,23 +1512,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) -* [`provider`](#provider) +* [`name`](#-mysql_user--name) +* [`provider`](#-mysql_user--provider) -##### `name` +##### `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 @@ -1575,7 +1575,7 @@ Data type: `Any` Hash to be normalised -### `mysql::password` +### `mysql::password` Type: Ruby 4.x API @@ -1600,7 +1600,7 @@ Data type: `Optional[Boolean]` If the Postgresql-Passwordhash should be of Datatype Sensitive[String] -### `mysql::strip_hash` +### `mysql::strip_hash` Type: Ruby 4.x API @@ -1645,15 +1645,11 @@ Data type: `Optional[Boolean]` ## Data types -### `Mysql::Options` +### `Mysql::Options` Use this if you don’t want your options merged with the default options. -Alias of - -```puppet -Hash[String, Hash] -``` +Alias of `Hash[String, Hash]` ## Tasks diff --git a/metadata.json b/metadata.json index 3b1fa718e..19e77ed8a 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-mysql", - "version": "13.0.1", + "version": "13.1.0", "author": "puppetlabs", "summary": "Installs, configures, and manages the MySQL service.", "license": "Apache-2.0",