Mercurial > repos > other > Puppet
annotate modules/mysql/REFERENCE.md @ 482:d83de9b3a62b default tip
Update hiera.yaml within Puppet config
Forgot that we manage it from here. Now has content to match
new packages
| author | IBBoard <dev@ibboard.co.uk> |
|---|---|
| date | Fri, 30 Aug 2024 16:10:36 +0100 |
| parents | adf6fe9bbc17 |
| children |
| rev | line source |
|---|---|
| 244 | 1 # Reference |
| 389 | 2 |
| 244 | 3 <!-- DO NOT EDIT: This document was generated by Puppet Strings --> |
| 4 | |
| 5 ## Table of Contents | |
| 6 | |
| 389 | 7 ### Classes |
| 8 | |
| 9 #### Public Classes | |
| 244 | 10 |
| 443 | 11 * [`mysql::bindings`](#mysql--bindings): Parent class for MySQL bindings. |
| 12 * [`mysql::client`](#mysql--client): Installs and configures the MySQL client. | |
| 13 * [`mysql::server`](#mysql--server): Installs and configures the MySQL server. | |
| 14 * [`mysql::server::backup`](#mysql--server--backup): Create and manage a MySQL backup. | |
| 389 | 15 |
| 16 #### Private Classes | |
| 244 | 17 |
| 18 * `mysql::backup::mysqlbackup`: Manage the mysqlbackup client. | |
| 19 * `mysql::backup::mysqldump`: "Provider" for mysqldump | |
| 20 * `mysql::backup::xtrabackup`: "Provider" for Percona XtraBackup/MariaBackup | |
| 21 * `mysql::bindings::client_dev`: Private class for installing client development bindings | |
| 22 * `mysql::bindings::daemon_dev`: Private class for installing daemon development bindings | |
| 23 * `mysql::bindings::java`: Private class for installing java language bindings. | |
| 24 * `mysql::bindings::perl`: Private class for installing perl language bindings. | |
| 25 * `mysql::bindings::php`: Private class for installing php language bindings | |
| 26 * `mysql::bindings::python`: Private class for installing python language bindings | |
| 27 * `mysql::bindings::ruby`: Private class for installing ruby language bindings | |
| 28 * `mysql::client::install`: Private class for MySQL client install. | |
| 29 * `mysql::params`: Params class. | |
| 30 * `mysql::server::account_security`: Private class for ensuring localhost accounts do not exist | |
| 31 * `mysql::server::config`: Private class for MySQL server configuration. | |
| 32 * `mysql::server::install`: Private class for managing MySQL package. | |
| 33 * `mysql::server::installdb`: Builds initial databases on installation. | |
| 389 | 34 * `mysql::server::managed_dirs`: Binary log configuration requires the mysql user to be present. This must be done after package install. |
| 244 | 35 * `mysql::server::providers`: Convenience class to call each of the three providers with the corresponding hashes provided in mysql::server. |
| 36 * `mysql::server::root_password`: Private class for managing the root password | |
| 37 * `mysql::server::service`: Private class for managing the MySQL service | |
| 38 | |
| 389 | 39 ### Defined types |
| 244 | 40 |
| 443 | 41 * [`mysql::db`](#mysql--db): Create and configure a MySQL database. |
| 244 | 42 |
| 389 | 43 ### Resource types |
| 44 | |
| 45 #### Public Resource types | |
| 244 | 46 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
47 * [`mysql_database`](#mysql_database): Manage a MySQL database. |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
48 * [`mysql_grant`](#mysql_grant): Manage a MySQL user's rights. |
| 389 | 49 * [`mysql_login_path`](#mysql_login_path): Manage a MySQL login path. |
| 244 | 50 * [`mysql_plugin`](#mysql_plugin): Manage MySQL plugins. |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
51 * [`mysql_user`](#mysql_user): Manage a MySQL user. This includes management of users password as well as privileges. |
| 244 | 52 |
| 389 | 53 #### Private Resource types |
| 244 | 54 |
| 55 * `mysql_datadir`: Manage MySQL datadirs with mysql_install_db OR mysqld (5.7.6 and above). | |
| 56 | |
| 389 | 57 ### Functions |
| 58 | |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
59 * [`mysql::innobackupex_args`](#mysql--innobackupex_args): This function populates and returns the string of arguments which later gets injected in template. Arguments that return string holds is conditional and decided by the the input given to function. |
| 443 | 60 * [`mysql::normalise_and_deepmerge`](#mysql--normalise_and_deepmerge): Recursively merges two or more hashes together, normalises keys with differing use of dashes and underscores. |
| 61 * [`mysql::password`](#mysql--password): Hash a string as mysql's "PASSWORD()" function would do it | |
| 62 * [`mysql::strip_hash`](#mysql--strip_hash): When given a hash this function strips out all blank entries. | |
| 389 | 63 * [`mysql_password`](#mysql_password): DEPRECATED. Use the namespaced function [`mysql::password`](#mysqlpassword) instead. |
| 64 | |
| 65 ### Data types | |
| 66 | |
| 443 | 67 * [`Mysql::Options`](#Mysql--Options): A hash of options structured like the override_options, but not merged with the default options. |
| 389 | 68 |
| 69 ### Tasks | |
| 244 | 70 |
| 71 * [`export`](#export): Allows you to backup your database to local file. | |
| 72 * [`sql`](#sql): Allows you to execute arbitary SQL | |
| 73 | |
| 74 ## Classes | |
| 75 | |
| 443 | 76 ### <a name="mysql--bindings"></a>`mysql::bindings` |
| 244 | 77 |
| 78 Parent class for MySQL bindings. | |
| 79 | |
| 80 #### Examples | |
| 81 | |
| 82 ##### Install Ruby language bindings | |
| 83 | |
| 84 ```puppet | |
| 85 class { 'mysql::bindings': | |
| 86 ruby_enable => true, | |
| 87 ruby_package_ensure => 'present', | |
| 88 ruby_package_name => 'ruby-mysql-2.7.1-1mdv2007.0.sparc.rpm', | |
| 89 ruby_package_provider => 'rpm', | |
| 90 } | |
| 91 ``` | |
| 92 | |
| 93 #### Parameters | |
| 94 | |
| 389 | 95 The following parameters are available in the `mysql::bindings` class: |
| 96 | |
| 443 | 97 * [`install_options`](#-mysql--bindings--install_options) |
| 98 * [`java_enable`](#-mysql--bindings--java_enable) | |
| 99 * [`perl_enable`](#-mysql--bindings--perl_enable) | |
| 100 * [`php_enable`](#-mysql--bindings--php_enable) | |
| 101 * [`python_enable`](#-mysql--bindings--python_enable) | |
| 102 * [`ruby_enable`](#-mysql--bindings--ruby_enable) | |
| 103 * [`client_dev`](#-mysql--bindings--client_dev) | |
| 104 * [`daemon_dev`](#-mysql--bindings--daemon_dev) | |
| 105 * [`java_package_ensure`](#-mysql--bindings--java_package_ensure) | |
| 106 * [`java_package_name`](#-mysql--bindings--java_package_name) | |
| 107 * [`java_package_provider`](#-mysql--bindings--java_package_provider) | |
| 108 * [`perl_package_ensure`](#-mysql--bindings--perl_package_ensure) | |
| 109 * [`perl_package_name`](#-mysql--bindings--perl_package_name) | |
| 110 * [`perl_package_provider`](#-mysql--bindings--perl_package_provider) | |
| 111 * [`php_package_ensure`](#-mysql--bindings--php_package_ensure) | |
| 112 * [`php_package_name`](#-mysql--bindings--php_package_name) | |
| 113 * [`php_package_provider`](#-mysql--bindings--php_package_provider) | |
| 114 * [`python_package_ensure`](#-mysql--bindings--python_package_ensure) | |
| 115 * [`python_package_name`](#-mysql--bindings--python_package_name) | |
| 116 * [`python_package_provider`](#-mysql--bindings--python_package_provider) | |
| 117 * [`ruby_package_ensure`](#-mysql--bindings--ruby_package_ensure) | |
| 118 * [`ruby_package_name`](#-mysql--bindings--ruby_package_name) | |
| 119 * [`ruby_package_provider`](#-mysql--bindings--ruby_package_provider) | |
| 120 * [`client_dev_package_ensure`](#-mysql--bindings--client_dev_package_ensure) | |
| 121 * [`client_dev_package_name`](#-mysql--bindings--client_dev_package_name) | |
| 122 * [`client_dev_package_provider`](#-mysql--bindings--client_dev_package_provider) | |
| 123 * [`daemon_dev_package_ensure`](#-mysql--bindings--daemon_dev_package_ensure) | |
| 124 * [`daemon_dev_package_name`](#-mysql--bindings--daemon_dev_package_name) | |
| 125 * [`daemon_dev_package_provider`](#-mysql--bindings--daemon_dev_package_provider) | |
| 126 | |
| 127 ##### <a name="-mysql--bindings--install_options"></a>`install_options` | |
| 244 | 128 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
129 Data type: `Optional[Array[String[1]]]` |
| 244 | 130 |
| 131 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). | |
| 132 | |
| 443 | 133 Default value: `undef` |
| 134 | |
| 135 ##### <a name="-mysql--bindings--java_enable"></a>`java_enable` | |
| 244 | 136 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
137 Data type: `Boolean` |
| 244 | 138 |
| 139 Specifies whether `::mysql::bindings::java` should be included. Valid values are `true`, `false`. | |
| 140 | |
| 443 | 141 Default value: `false` |
| 142 | |
| 143 ##### <a name="-mysql--bindings--perl_enable"></a>`perl_enable` | |
| 244 | 144 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
145 Data type: `Boolean` |
| 244 | 146 |
| 147 Specifies whether `mysql::bindings::perl` should be included. Valid values are `true`, `false`. | |
| 148 | |
| 443 | 149 Default value: `false` |
| 150 | |
| 151 ##### <a name="-mysql--bindings--php_enable"></a>`php_enable` | |
| 244 | 152 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
153 Data type: `Boolean` |
| 244 | 154 |
| 155 Specifies whether `mysql::bindings::php` should be included. Valid values are `true`, `false`. | |
| 156 | |
| 443 | 157 Default value: `false` |
| 158 | |
| 159 ##### <a name="-mysql--bindings--python_enable"></a>`python_enable` | |
| 244 | 160 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
161 Data type: `Boolean` |
| 244 | 162 |
| 163 Specifies whether `mysql::bindings::python` should be included. Valid values are `true`, `false`. | |
| 164 | |
| 443 | 165 Default value: `false` |
| 166 | |
| 167 ##### <a name="-mysql--bindings--ruby_enable"></a>`ruby_enable` | |
| 244 | 168 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
169 Data type: `Boolean` |
| 244 | 170 |
| 171 Specifies whether `mysql::bindings::ruby` should be included. Valid values are `true`, `false`. | |
| 172 | |
| 443 | 173 Default value: `false` |
| 174 | |
| 175 ##### <a name="-mysql--bindings--client_dev"></a>`client_dev` | |
| 244 | 176 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
177 Data type: `Boolean` |
| 244 | 178 |
| 179 Specifies whether `::mysql::bindings::client_dev` should be included. Valid values are `true`', `false`. | |
| 180 | |
| 443 | 181 Default value: `false` |
| 182 | |
| 183 ##### <a name="-mysql--bindings--daemon_dev"></a>`daemon_dev` | |
| 244 | 184 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
185 Data type: `Boolean` |
| 244 | 186 |
| 187 Specifies whether `::mysql::bindings::daemon_dev` should be included. Valid values are `true`, `false`. | |
| 188 | |
| 443 | 189 Default value: `false` |
| 190 | |
| 191 ##### <a name="-mysql--bindings--java_package_ensure"></a>`java_package_ensure` | |
| 244 | 192 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
193 Data type: `Variant[Enum['present','absent'], Pattern[/(\d+)[\.](\d+)[\.](\d+)/]]` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
194 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
195 Whether the package should be present, absent, or a specific version. Valid values are 'present', 'absent', or 'x.y.z'. |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
196 Only applies if `java_enable => true`. |
| 244 | 197 |
| 389 | 198 Default value: `$mysql::params::java_package_ensure` |
| 199 | |
| 443 | 200 ##### <a name="-mysql--bindings--java_package_name"></a>`java_package_name` |
| 244 | 201 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
202 Data type: `String[1]` |
| 244 | 203 |
| 204 The name of the Java package to install. Only applies if `java_enable => true`. | |
| 205 | |
| 389 | 206 Default value: `$mysql::params::java_package_name` |
| 207 | |
| 443 | 208 ##### <a name="-mysql--bindings--java_package_provider"></a>`java_package_provider` |
| 244 | 209 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
210 Data type: `Optional[String[1]]` |
| 244 | 211 |
| 212 The provider to use to install the Java package. Only applies if `java_enable => true`. | |
| 213 | |
| 389 | 214 Default value: `$mysql::params::java_package_provider` |
| 215 | |
| 443 | 216 ##### <a name="-mysql--bindings--perl_package_ensure"></a>`perl_package_ensure` |
| 244 | 217 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
218 Data type: `Variant[Enum['present','absent'], Pattern[/(\d+)[\.](\d+)[\.](\d+)/]]` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
219 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
220 Whether the package should be present, absent, or a specific version. Valid values are 'present', 'absent', or 'x.y.z'. |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
221 Only applies if `perl_enable => true`. |
| 244 | 222 |
| 389 | 223 Default value: `$mysql::params::perl_package_ensure` |
| 224 | |
| 443 | 225 ##### <a name="-mysql--bindings--perl_package_name"></a>`perl_package_name` |
| 244 | 226 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
227 Data type: `String[1]` |
| 244 | 228 |
| 229 The name of the Perl package to install. Only applies if `perl_enable => true`. | |
| 230 | |
| 389 | 231 Default value: `$mysql::params::perl_package_name` |
| 232 | |
| 443 | 233 ##### <a name="-mysql--bindings--perl_package_provider"></a>`perl_package_provider` |
| 244 | 234 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
235 Data type: `Optional[String[1]]` |
| 244 | 236 |
| 237 The provider to use to install the Perl package. Only applies if `perl_enable => true`. | |
| 238 | |
| 389 | 239 Default value: `$mysql::params::perl_package_provider` |
| 240 | |
| 443 | 241 ##### <a name="-mysql--bindings--php_package_ensure"></a>`php_package_ensure` |
| 244 | 242 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
243 Data type: `Variant[Enum['present','absent'], Pattern[/(\d+)[\.](\d+)[\.](\d+)/]]` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
244 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
245 Whether the package should be present, absent, or a specific version. Valid values are 'present', 'absent', or 'x.y.z'. |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
246 Only applies if `php_enable => true`. |
| 244 | 247 |
| 389 | 248 Default value: `$mysql::params::php_package_ensure` |
| 249 | |
| 443 | 250 ##### <a name="-mysql--bindings--php_package_name"></a>`php_package_name` |
| 244 | 251 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
252 Data type: `String[1]` |
| 244 | 253 |
| 254 The name of the PHP package to install. Only applies if `php_enable => true`. | |
| 255 | |
| 389 | 256 Default value: `$mysql::params::php_package_name` |
| 257 | |
| 443 | 258 ##### <a name="-mysql--bindings--php_package_provider"></a>`php_package_provider` |
| 244 | 259 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
260 Data type: `Optional[String[1]]` |
| 244 | 261 |
| 262 The provider to use to install the PHP package. Only applies if `php_enable => true`. | |
| 263 | |
| 389 | 264 Default value: `$mysql::params::php_package_provider` |
| 265 | |
| 443 | 266 ##### <a name="-mysql--bindings--python_package_ensure"></a>`python_package_ensure` |
| 244 | 267 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
268 Data type: `Variant[Enum['present','absent'], Pattern[/(\d+)[\.](\d+)[\.](\d+)/]]` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
269 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
270 Whether the package should be present, absent, or a specific version. Valid values are 'present', 'absent', or 'x.y.z'. |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
271 Only applies if `python_enable => true`. |
| 244 | 272 |
| 389 | 273 Default value: `$mysql::params::python_package_ensure` |
| 274 | |
| 443 | 275 ##### <a name="-mysql--bindings--python_package_name"></a>`python_package_name` |
| 244 | 276 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
277 Data type: `String[1]` |
| 244 | 278 |
| 279 The name of the Python package to install. Only applies if `python_enable => true`. | |
| 280 | |
| 389 | 281 Default value: `$mysql::params::python_package_name` |
| 282 | |
| 443 | 283 ##### <a name="-mysql--bindings--python_package_provider"></a>`python_package_provider` |
| 244 | 284 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
285 Data type: `Optional[String[1]]` |
| 244 | 286 |
| 287 The provider to use to install the Python package. Only applies if `python_enable => true`. | |
| 288 | |
| 389 | 289 Default value: `$mysql::params::python_package_provider` |
| 290 | |
| 443 | 291 ##### <a name="-mysql--bindings--ruby_package_ensure"></a>`ruby_package_ensure` |
| 244 | 292 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
293 Data type: `Variant[Enum['present','absent'], Pattern[/(\d+)[\.](\d+)[\.](\d+)/]]` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
294 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
295 Whether the package should be present, absent, or a specific version. Valid values are 'present', 'absent', or 'x.y.z'. |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
296 Only applies if `ruby_enable => true`. |
| 244 | 297 |
| 389 | 298 Default value: `$mysql::params::ruby_package_ensure` |
| 299 | |
| 443 | 300 ##### <a name="-mysql--bindings--ruby_package_name"></a>`ruby_package_name` |
| 244 | 301 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
302 Data type: `String[1]` |
| 244 | 303 |
| 304 The name of the Ruby package to install. Only applies if `ruby_enable => true`. | |
| 305 | |
| 389 | 306 Default value: `$mysql::params::ruby_package_name` |
| 307 | |
| 443 | 308 ##### <a name="-mysql--bindings--ruby_package_provider"></a>`ruby_package_provider` |
| 244 | 309 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
310 Data type: `Optional[String[1]]` |
| 244 | 311 |
| 312 What provider should be used to install the package. | |
| 313 | |
| 389 | 314 Default value: `$mysql::params::ruby_package_provider` |
| 315 | |
| 443 | 316 ##### <a name="-mysql--bindings--client_dev_package_ensure"></a>`client_dev_package_ensure` |
| 244 | 317 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
318 Data type: `Variant[Enum['present','absent'], Pattern[/(\d+)[\.](\d+)[\.](\d+)/]]` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
319 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
320 Whether the package should be present, absent, or a specific version. Valid values are 'present', 'absent', or 'x.y.z'. |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
321 Only applies if `client_dev => true`. |
| 244 | 322 |
| 389 | 323 Default value: `$mysql::params::client_dev_package_ensure` |
| 324 | |
| 443 | 325 ##### <a name="-mysql--bindings--client_dev_package_name"></a>`client_dev_package_name` |
| 244 | 326 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
327 Data type: `Optional[String[1]]` |
| 244 | 328 |
| 329 The name of the client_dev package to install. Only applies if `client_dev => true`. | |
| 330 | |
| 389 | 331 Default value: `$mysql::params::client_dev_package_name` |
| 332 | |
| 443 | 333 ##### <a name="-mysql--bindings--client_dev_package_provider"></a>`client_dev_package_provider` |
| 244 | 334 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
335 Data type: `Optional[String[1]]` |
| 244 | 336 |
| 337 The provider to use to install the client_dev package. Only applies if `client_dev => true`. | |
| 338 | |
| 389 | 339 Default value: `$mysql::params::client_dev_package_provider` |
| 340 | |
| 443 | 341 ##### <a name="-mysql--bindings--daemon_dev_package_ensure"></a>`daemon_dev_package_ensure` |
| 244 | 342 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
343 Data type: `Variant[Enum['present','absent'], Pattern[/(\d+)[\.](\d+)[\.](\d+)/]]` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
344 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
345 Whether the package should be present, absent, or a specific version. Valid values are 'present', 'absent', or 'x.y.z'. |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
346 Only applies if `daemon_dev => true`. |
| 244 | 347 |
| 389 | 348 Default value: `$mysql::params::daemon_dev_package_ensure` |
| 349 | |
| 443 | 350 ##### <a name="-mysql--bindings--daemon_dev_package_name"></a>`daemon_dev_package_name` |
| 244 | 351 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
352 Data type: `String[1]` |
| 244 | 353 |
| 354 The name of the daemon_dev package to install. Only applies if `daemon_dev => true`. | |
| 355 | |
| 389 | 356 Default value: `$mysql::params::daemon_dev_package_name` |
| 357 | |
| 443 | 358 ##### <a name="-mysql--bindings--daemon_dev_package_provider"></a>`daemon_dev_package_provider` |
| 244 | 359 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
360 Data type: `Optional[String[1]]` |
| 244 | 361 |
| 362 The provider to use to install the daemon_dev package. Only applies if `daemon_dev => true`. | |
| 363 | |
| 389 | 364 Default value: `$mysql::params::daemon_dev_package_provider` |
| 365 | |
| 443 | 366 ### <a name="mysql--client"></a>`mysql::client` |
| 244 | 367 |
| 368 Installs and configures the MySQL client. | |
| 369 | |
| 370 #### Examples | |
| 371 | |
| 372 ##### Install the MySQL client | |
| 373 | |
| 374 ```puppet | |
| 375 class {'::mysql::client': | |
| 376 package_name => 'mysql-client', | |
| 377 package_ensure => 'present', | |
| 378 bindings_enable => true, | |
| 379 } | |
| 380 ``` | |
| 381 | |
| 382 #### Parameters | |
| 383 | |
| 389 | 384 The following parameters are available in the `mysql::client` class: |
| 385 | |
| 443 | 386 * [`bindings_enable`](#-mysql--client--bindings_enable) |
| 387 * [`install_options`](#-mysql--client--install_options) | |
| 388 * [`package_ensure`](#-mysql--client--package_ensure) | |
| 389 * [`package_manage`](#-mysql--client--package_manage) | |
| 390 * [`package_name`](#-mysql--client--package_name) | |
| 391 * [`package_provider`](#-mysql--client--package_provider) | |
| 392 * [`package_source`](#-mysql--client--package_source) | |
| 393 | |
| 394 ##### <a name="-mysql--client--bindings_enable"></a>`bindings_enable` | |
| 244 | 395 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
396 Data type: `Boolean` |
| 244 | 397 |
| 398 Whether to automatically install all bindings. Valid values are `true`, `false`. Default to `false`. | |
| 399 | |
| 389 | 400 Default value: `$mysql::params::bindings_enable` |
| 401 | |
| 443 | 402 ##### <a name="-mysql--client--install_options"></a>`install_options` |
| 244 | 403 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
404 Data type: `Optional[Array[String[1]]]` |
| 244 | 405 |
| 406 Array of install options for managed package resources. You must pass the appropriate options for the package manager. | |
| 407 | |
| 443 | 408 Default value: `undef` |
| 409 | |
| 410 ##### <a name="-mysql--client--package_ensure"></a>`package_ensure` | |
| 244 | 411 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
412 Data type: `Variant[Enum['present','absent'], Pattern[/(\d+)[\.](\d+)[\.](\d+)/]]` |
| 244 | 413 |
| 414 Whether the MySQL package should be present, absent, or a specific version. Valid values are 'present', 'absent', or 'x.y.z'. | |
| 415 | |
| 389 | 416 Default value: `$mysql::params::client_package_ensure` |
| 417 | |
| 443 | 418 ##### <a name="-mysql--client--package_manage"></a>`package_manage` |
| 244 | 419 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
420 Data type: `Boolean` |
| 244 | 421 |
| 422 Whether to manage the MySQL client package. Defaults to `true`. | |
| 423 | |
| 389 | 424 Default value: `$mysql::params::client_package_manage` |
| 425 | |
| 443 | 426 ##### <a name="-mysql--client--package_name"></a>`package_name` |
| 244 | 427 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
428 Data type: `String[1]` |
| 244 | 429 |
| 430 The name of the MySQL client package to install. | |
| 431 | |
| 389 | 432 Default value: `$mysql::params::client_package_name` |
| 433 | |
| 443 | 434 ##### <a name="-mysql--client--package_provider"></a>`package_provider` |
| 389 | 435 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
436 Data type: `Optional[String[1]]` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
437 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
438 Specify the provider of the package. Optional. Valid value is a String. |
| 389 | 439 |
| 443 | 440 Default value: `undef` |
| 441 | |
| 442 ##### <a name="-mysql--client--package_source"></a>`package_source` | |
| 389 | 443 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
444 Data type: `Optional[String[1]]` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
445 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
446 Specify the path to the package source. Optional. Valid value is a String |
| 389 | 447 |
| 443 | 448 Default value: `undef` |
| 449 | |
| 450 ### <a name="mysql--server"></a>`mysql::server` | |
| 244 | 451 |
| 452 Installs and configures the MySQL server. | |
| 453 | |
| 454 #### Examples | |
| 455 | |
| 456 ##### Install MySQL Server | |
| 457 | |
| 458 ```puppet | |
| 459 class { '::mysql::server': | |
| 460 package_name => 'mysql-server', | |
| 461 package_ensure => '5.7.1+mysql~trusty', | |
| 462 root_password => 'strongpassword', | |
| 463 remove_default_accounts => true, | |
| 464 } | |
| 465 ``` | |
| 466 | |
| 467 #### Parameters | |
| 468 | |
| 389 | 469 The following parameters are available in the `mysql::server` class: |
| 470 | |
| 443 | 471 * [`config_file`](#-mysql--server--config_file) |
| 472 * [`config_file_mode`](#-mysql--server--config_file_mode) | |
| 473 * [`includedir`](#-mysql--server--includedir) | |
| 474 * [`install_options`](#-mysql--server--install_options) | |
| 475 * [`manage_config_file`](#-mysql--server--manage_config_file) | |
| 476 * [`options`](#-mysql--server--options) | |
| 477 * [`override_options`](#-mysql--server--override_options) | |
| 478 * [`package_ensure`](#-mysql--server--package_ensure) | |
| 479 * [`package_manage`](#-mysql--server--package_manage) | |
| 480 * [`package_name`](#-mysql--server--package_name) | |
| 481 * [`package_provider`](#-mysql--server--package_provider) | |
| 482 * [`package_source`](#-mysql--server--package_source) | |
| 483 * [`purge_conf_dir`](#-mysql--server--purge_conf_dir) | |
| 484 * [`remove_default_accounts`](#-mysql--server--remove_default_accounts) | |
| 485 * [`restart`](#-mysql--server--restart) | |
| 486 * [`root_group`](#-mysql--server--root_group) | |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
487 * [`managed_dirs`](#-mysql--server--managed_dirs) |
| 443 | 488 * [`mysql_group`](#-mysql--server--mysql_group) |
| 489 * [`mycnf_owner`](#-mysql--server--mycnf_owner) | |
| 490 * [`mycnf_group`](#-mysql--server--mycnf_group) | |
| 491 * [`root_password`](#-mysql--server--root_password) | |
| 492 * [`service_enabled`](#-mysql--server--service_enabled) | |
| 493 * [`service_manage`](#-mysql--server--service_manage) | |
| 494 * [`service_name`](#-mysql--server--service_name) | |
| 495 * [`service_provider`](#-mysql--server--service_provider) | |
| 496 * [`create_root_user`](#-mysql--server--create_root_user) | |
| 497 * [`create_root_my_cnf`](#-mysql--server--create_root_my_cnf) | |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
498 * [`create_root_login_file`](#-mysql--server--create_root_login_file) |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
499 * [`login_file`](#-mysql--server--login_file) |
| 443 | 500 * [`users`](#-mysql--server--users) |
| 501 * [`grants`](#-mysql--server--grants) | |
| 502 * [`databases`](#-mysql--server--databases) | |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
503 * [`reload_on_config_change`](#-mysql--server--reload_on_config_change) |
| 443 | 504 * [`enabled`](#-mysql--server--enabled) |
| 505 * [`manage_service`](#-mysql--server--manage_service) | |
| 506 * [`old_root_password`](#-mysql--server--old_root_password) | |
| 507 | |
| 508 ##### <a name="-mysql--server--config_file"></a>`config_file` | |
| 244 | 509 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
510 Data type: `String[1]` |
| 244 | 511 |
| 512 The location, as a path, of the MySQL configuration file. | |
| 513 | |
| 389 | 514 Default value: `$mysql::params::config_file` |
| 515 | |
| 443 | 516 ##### <a name="-mysql--server--config_file_mode"></a>`config_file_mode` |
| 389 | 517 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
518 Data type: `String[1]` |
| 389 | 519 |
| 520 The MySQL configuration file's permissions mode. | |
| 521 | |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
522 Default value: `'0644'` |
| 389 | 523 |
| 443 | 524 ##### <a name="-mysql--server--includedir"></a>`includedir` |
| 244 | 525 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
526 Data type: `Optional[String]` |
| 244 | 527 |
| 528 The location, as a path, of !includedir for custom configuration overrides. | |
| 529 | |
| 389 | 530 Default value: `$mysql::params::includedir` |
| 531 | |
| 443 | 532 ##### <a name="-mysql--server--install_options"></a>`install_options` |
| 244 | 533 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
534 Data type: `Optional[Array[String[1]]]` |
| 244 | 535 |
| 536 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 | |
| 537 | |
| 443 | 538 Default value: `undef` |
| 539 | |
| 540 ##### <a name="-mysql--server--manage_config_file"></a>`manage_config_file` | |
| 244 | 541 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
542 Data type: `Variant[Boolean, String[1]]` |
| 244 | 543 |
| 544 Whether the MySQL configuration file should be managed. Valid values are `true`, `false`. Defaults to `true`. | |
| 545 | |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
546 Default value: `true` |
| 389 | 547 |
| 443 | 548 ##### <a name="-mysql--server--options"></a>`options` |
| 389 | 549 |
| 550 Data type: `Mysql::Options` | |
| 551 | |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
552 A hash of options structured like the override_options, but not merged with the default options. |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
553 Use this if you don't want your options merged with the default options. |
| 389 | 554 |
| 555 Default value: `{}` | |
| 556 | |
| 443 | 557 ##### <a name="-mysql--server--override_options"></a>`override_options` |
| 244 | 558 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
559 Data type: `Hash` |
| 244 | 560 |
| 561 Specifies override options to pass into MySQL. Structured like a hash in the my.cnf file: See above for usage details. | |
| 562 | |
| 389 | 563 Default value: `{}` |
| 564 | |
| 443 | 565 ##### <a name="-mysql--server--package_ensure"></a>`package_ensure` |
| 244 | 566 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
567 Data type: `Variant[Enum['present','absent'], Pattern[/(\d+)[\.](\d+)[\.](\d+)/]]` |
| 244 | 568 |
| 569 Whether the package exists or should be a specific version. Valid values are 'present', 'absent', or 'x.y.z'. Defaults to 'present'. | |
| 570 | |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
571 Default value: `'present'` |
| 389 | 572 |
| 443 | 573 ##### <a name="-mysql--server--package_manage"></a>`package_manage` |
| 244 | 574 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
575 Data type: `Boolean` |
| 244 | 576 |
| 577 Whether to manage the MySQL server package. Defaults to `true`. | |
| 578 | |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
579 Default value: `true` |
| 389 | 580 |
| 443 | 581 ##### <a name="-mysql--server--package_name"></a>`package_name` |
| 244 | 582 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
583 Data type: `String[1]` |
| 244 | 584 |
| 585 The name of the MySQL server package to install. | |
| 586 | |
| 389 | 587 Default value: `$mysql::params::server_package_name` |
| 588 | |
| 443 | 589 ##### <a name="-mysql--server--package_provider"></a>`package_provider` |
| 389 | 590 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
591 Data type: `Optional[String[1]]` |
| 389 | 592 |
| 593 Define a specific provider for package install. | |
| 594 | |
| 443 | 595 Default value: `undef` |
| 596 | |
| 597 ##### <a name="-mysql--server--package_source"></a>`package_source` | |
| 389 | 598 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
599 Data type: `Optional[String[1]]` |
| 389 | 600 |
| 601 The location of the package source (require for some package provider) | |
| 602 | |
| 443 | 603 Default value: `undef` |
| 604 | |
| 605 ##### <a name="-mysql--server--purge_conf_dir"></a>`purge_conf_dir` | |
| 244 | 606 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
607 Data type: `Variant[Boolean, String[1]]` |
| 244 | 608 |
| 609 Whether the `includedir` directory should be purged. Valid values are `true`, `false`. Defaults to `false`. | |
| 610 | |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
611 Default value: `false` |
| 389 | 612 |
| 443 | 613 ##### <a name="-mysql--server--remove_default_accounts"></a>`remove_default_accounts` |
| 244 | 614 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
615 Data type: `Variant[Boolean, String[1]]` |
| 244 | 616 |
| 617 Specifies whether to automatically include `mysql::server::account_security`. Valid values are `true`, `false`. Defaults to `false`. | |
| 618 | |
| 443 | 619 Default value: `false` |
| 620 | |
| 621 ##### <a name="-mysql--server--restart"></a>`restart` | |
| 244 | 622 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
623 Data type: `Variant[Boolean, String[1]]` |
| 244 | 624 |
| 625 Whether the service should be restarted when things change. Valid values are `true`, `false`. Defaults to `false`. | |
| 626 | |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
627 Default value: `false` |
| 389 | 628 |
| 443 | 629 ##### <a name="-mysql--server--root_group"></a>`root_group` |
| 244 | 630 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
631 Data type: `String[1]` |
| 244 | 632 |
| 633 The name of the group used for root. Can be a group name or a group ID. See more about the [group](https://docs.puppetlabs.com/references/latest/type.html#file-attribute-group). | |
| 634 | |
| 389 | 635 Default value: `$mysql::params::root_group` |
| 636 | |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
637 ##### <a name="-mysql--server--managed_dirs"></a>`managed_dirs` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
638 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
639 Data type: `Optional[Array[String[1]]]` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
640 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
641 An array containing all directories to be managed. |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
642 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
643 Default value: `$mysql::params::managed_dirs` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
644 |
| 443 | 645 ##### <a name="-mysql--server--mysql_group"></a>`mysql_group` |
| 244 | 646 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
647 Data type: `String[1]` |
| 244 | 648 |
| 649 The name of the group of the MySQL daemon user. Can be a group name or a group ID. See more about the [group](https://docs.puppetlabs.com/references/latest/type.html#file-attribute-group). | |
| 650 | |
| 389 | 651 Default value: `$mysql::params::mysql_group` |
| 652 | |
| 443 | 653 ##### <a name="-mysql--server--mycnf_owner"></a>`mycnf_owner` |
| 389 | 654 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
655 Data type: `Optional[String[1]]` |
| 389 | 656 |
| 657 Name or user-id who owns the mysql-config-file. | |
| 658 | |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
659 Default value: `undef` |
| 389 | 660 |
| 443 | 661 ##### <a name="-mysql--server--mycnf_group"></a>`mycnf_group` |
| 244 | 662 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
663 Data type: `Optional[String[1]]` |
| 244 | 664 |
| 389 | 665 Name or group-id which owns the mysql-config-file. |
| 666 | |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
667 Default value: `undef` |
| 389 | 668 |
| 443 | 669 ##### <a name="-mysql--server--root_password"></a>`root_password` |
| 389 | 670 |
| 671 Data type: `Variant[String, Sensitive[String]]` | |
| 672 | |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
673 The MySQL root password. Puppet attempts to set the root password and update `/root/.my.cnf` with it. This is required |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
674 if `create_root_user` or `create_root_my_cnf` are true. If `root_password` is 'UNSET', then `create_root_user` and |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
675 `create_root_my_cnf` are assumed to be false --- that is, the MySQL root user and `/root/.my.cnf` are not created. |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
676 Password changes are supported; however, the old password must be set in `/root/.my.cnf`. Effectively, Puppet uses the old |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
677 password, configured in `/root/my.cnf`, to set the new password in MySQL, and then updates `/root/.my.cnf` with the new password. |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
678 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
679 Default value: `'UNSET'` |
| 389 | 680 |
| 443 | 681 ##### <a name="-mysql--server--service_enabled"></a>`service_enabled` |
| 244 | 682 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
683 Data type: `Variant[Boolean, String[1]]` |
| 244 | 684 |
| 685 Specifies whether the service should be enabled. Valid values are `true`, `false`. Defaults to `true`. | |
| 686 | |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
687 Default value: `true` |
| 389 | 688 |
| 443 | 689 ##### <a name="-mysql--server--service_manage"></a>`service_manage` |
| 244 | 690 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
691 Data type: `Variant[Boolean, String[1]]` |
| 244 | 692 |
| 693 Specifies whether the service should be managed. Valid values are `true`, `false`. Defaults to `true`. | |
| 694 | |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
695 Default value: `true` |
| 389 | 696 |
| 443 | 697 ##### <a name="-mysql--server--service_name"></a>`service_name` |
| 244 | 698 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
699 Data type: `String[1]` |
| 244 | 700 |
| 701 The name of the MySQL server service. Defaults are OS dependent, defined in 'params.pp'. | |
| 702 | |
| 389 | 703 Default value: `$mysql::params::server_service_name` |
| 704 | |
| 443 | 705 ##### <a name="-mysql--server--service_provider"></a>`service_provider` |
| 244 | 706 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
707 Data type: `Optional[String[1]]` |
| 244 | 708 |
| 709 The provider to use to manage the service. For Ubuntu, defaults to 'upstart'; otherwise, default is undefined. | |
| 710 | |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
711 Default value: `undef` |
| 389 | 712 |
| 443 | 713 ##### <a name="-mysql--server--create_root_user"></a>`create_root_user` |
| 244 | 714 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
715 Data type: `Boolean` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
716 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
717 Whether root user should be created. Valid values are `true`, `false`. Defaults to `true`. |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
718 This is useful for a cluster setup with Galera. The root user has to be created only once. |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
719 You can set this parameter true on one node and set it to false on the remaining nodes. |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
720 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
721 Default value: `true` |
| 389 | 722 |
| 443 | 723 ##### <a name="-mysql--server--create_root_my_cnf"></a>`create_root_my_cnf` |
| 244 | 724 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
725 Data type: `Boolean` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
726 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
727 Whether to create `/root/.my.cnf`. Valid values are `true`, `false`. Defaults to `true`. |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
728 `create_root_my_cnf` allows creation of `/root/.my.cnf` independently of `create_root_user`. |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
729 You can use this for a cluster setup with Galera where you want `/root/.my.cnf` to exist on all nodes. |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
730 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
731 Default value: `true` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
732 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
733 ##### <a name="-mysql--server--create_root_login_file"></a>`create_root_login_file` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
734 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
735 Data type: `Boolean` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
736 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
737 Whether to create a login file for root. Valid values are 'true', 'false'. |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
738 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
739 Default value: `false` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
740 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
741 ##### <a name="-mysql--server--login_file"></a>`login_file` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
742 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
743 Data type: `Optional[String[1]]` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
744 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
745 Specify the login file. |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
746 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
747 Default value: `undef` |
| 389 | 748 |
| 443 | 749 ##### <a name="-mysql--server--users"></a>`users` |
| 244 | 750 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
751 Data type: `Hash` |
| 244 | 752 |
| 753 Optional hash of users to create, which are passed to [mysql_user](#mysql_user). | |
| 754 | |
| 389 | 755 Default value: `{}` |
| 756 | |
| 443 | 757 ##### <a name="-mysql--server--grants"></a>`grants` |
| 244 | 758 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
759 Data type: `Hash` |
| 244 | 760 |
| 761 Optional hash of grants, which are passed to [mysql_grant](#mysql_grant). | |
| 762 | |
| 389 | 763 Default value: `{}` |
| 764 | |
| 443 | 765 ##### <a name="-mysql--server--databases"></a>`databases` |
| 244 | 766 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
767 Data type: `Hash` |
| 244 | 768 |
| 769 Optional hash of databases to create, which are passed to [mysql_database](#mysql_database). | |
| 770 | |
| 389 | 771 Default value: `{}` |
| 772 | |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
773 ##### <a name="-mysql--server--reload_on_config_change"></a>`reload_on_config_change` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
774 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
775 Data type: `Boolean` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
776 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
777 By default, a my.cnf change won't reload/restart the database. Turn this flag to true to enable it |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
778 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
779 Default value: `false` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
780 |
| 443 | 781 ##### <a name="-mysql--server--enabled"></a>`enabled` |
| 244 | 782 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
783 Data type: `Optional[Variant[String[1], Boolean]]` |
| 244 | 784 |
| 785 _Deprecated_ | |
| 786 | |
| 443 | 787 Default value: `undef` |
| 788 | |
| 789 ##### <a name="-mysql--server--manage_service"></a>`manage_service` | |
| 244 | 790 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
791 Data type: `Optional[Variant[String[1], Boolean]]` |
| 244 | 792 |
| 793 _Deprecated_ | |
| 794 | |
| 443 | 795 Default value: `undef` |
| 796 | |
| 797 ##### <a name="-mysql--server--old_root_password"></a>`old_root_password` | |
| 244 | 798 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
799 Data type: `Optional[Variant[String, Sensitive[String]]]` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
800 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
801 This parameter no longer does anything. It exists only for backwards compatibility. |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
802 See the `root_password` parameter above for details on changing the root password. |
| 244 | 803 |
| 443 | 804 Default value: `undef` |
| 805 | |
| 806 ### <a name="mysql--server--backup"></a>`mysql::server::backup` | |
| 244 | 807 |
| 808 Create and manage a MySQL backup. | |
| 809 | |
| 810 #### Examples | |
| 811 | |
| 812 ##### Create a basic MySQL backup: | |
| 813 | |
| 814 ```puppet | |
| 815 class { 'mysql::server': | |
| 443 | 816 root_password => 'password' |
| 244 | 817 } |
| 818 class { 'mysql::server::backup': | |
| 443 | 819 backupuser => 'myuser', |
| 820 backuppassword => 'mypassword', | |
| 821 backupdir => '/tmp/backups', | |
| 822 } | |
| 823 ``` | |
| 824 | |
| 825 ##### Create a basic MySQL backup using mariabackup: | |
| 826 | |
| 827 ```puppet | |
| 828 class { 'mysql::server': | |
| 829 root_password => 'password' | |
| 244 | 830 } |
| 831 class { 'mysql::server::backup': | |
| 443 | 832 backupmethod => 'mariabackup', |
| 833 backupmethod_package => 'mariadb-backup' | |
| 834 provider => 'xtrabackup', | |
| 835 backupdir => '/tmp/backups', | |
| 244 | 836 } |
| 837 ``` | |
| 838 | |
| 839 #### Parameters | |
| 840 | |
| 389 | 841 The following parameters are available in the `mysql::server::backup` class: |
| 842 | |
| 443 | 843 * [`backupuser`](#-mysql--server--backup--backupuser) |
| 844 * [`backuppassword`](#-mysql--server--backup--backuppassword) | |
| 845 * [`backupdir`](#-mysql--server--backup--backupdir) | |
| 846 * [`backupdirmode`](#-mysql--server--backup--backupdirmode) | |
| 847 * [`backupdirowner`](#-mysql--server--backup--backupdirowner) | |
| 848 * [`backupdirgroup`](#-mysql--server--backup--backupdirgroup) | |
| 849 * [`backupcompress`](#-mysql--server--backup--backupcompress) | |
| 850 * [`backupmethod`](#-mysql--server--backup--backupmethod) | |
| 851 * [`backup_success_file_path`](#-mysql--server--backup--backup_success_file_path) | |
| 852 * [`backuprotate`](#-mysql--server--backup--backuprotate) | |
| 853 * [`ignore_events`](#-mysql--server--backup--ignore_events) | |
| 854 * [`delete_before_dump`](#-mysql--server--backup--delete_before_dump) | |
| 855 * [`backupdatabases`](#-mysql--server--backup--backupdatabases) | |
| 856 * [`file_per_database`](#-mysql--server--backup--file_per_database) | |
| 857 * [`include_routines`](#-mysql--server--backup--include_routines) | |
| 858 * [`include_triggers`](#-mysql--server--backup--include_triggers) | |
| 859 * [`incremental_backups`](#-mysql--server--backup--incremental_backups) | |
| 860 * [`ensure`](#-mysql--server--backup--ensure) | |
| 861 * [`time`](#-mysql--server--backup--time) | |
| 862 * [`prescript`](#-mysql--server--backup--prescript) | |
| 863 * [`postscript`](#-mysql--server--backup--postscript) | |
| 864 * [`execpath`](#-mysql--server--backup--execpath) | |
| 865 * [`provider`](#-mysql--server--backup--provider) | |
| 866 * [`maxallowedpacket`](#-mysql--server--backup--maxallowedpacket) | |
| 867 * [`optional_args`](#-mysql--server--backup--optional_args) | |
| 868 * [`install_cron`](#-mysql--server--backup--install_cron) | |
| 869 * [`compression_command`](#-mysql--server--backup--compression_command) | |
| 870 * [`compression_extension`](#-mysql--server--backup--compression_extension) | |
| 871 * [`backupmethod_package`](#-mysql--server--backup--backupmethod_package) | |
| 872 * [`excludedatabases`](#-mysql--server--backup--excludedatabases) | |
| 873 | |
| 874 ##### <a name="-mysql--server--backup--backupuser"></a>`backupuser` | |
| 244 | 875 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
876 Data type: `Optional[String[1]]` |
| 244 | 877 |
| 389 | 878 MySQL user to create with backup administrator privileges. |
| 879 | |
| 443 | 880 Default value: `undef` |
| 881 | |
| 882 ##### <a name="-mysql--server--backup--backuppassword"></a>`backuppassword` | |
| 389 | 883 |
| 884 Data type: `Optional[Variant[String, Sensitive[String]]]` | |
| 885 | |
| 886 Password to create for `backupuser`. | |
| 887 | |
| 443 | 888 Default value: `undef` |
| 889 | |
| 890 ##### <a name="-mysql--server--backup--backupdir"></a>`backupdir` | |
| 244 | 891 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
892 Data type: `Optional[String[1]]` |
| 244 | 893 |
| 894 Directory to store backup. | |
| 895 | |
| 443 | 896 Default value: `undef` |
| 897 | |
| 898 ##### <a name="-mysql--server--backup--backupdirmode"></a>`backupdirmode` | |
| 244 | 899 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
900 Data type: `String[1]` |
| 244 | 901 |
| 902 Permissions applied to the backup directory. This parameter is passed directly to the file resource. | |
| 903 | |
| 389 | 904 Default value: `'0700'` |
| 905 | |
| 443 | 906 ##### <a name="-mysql--server--backup--backupdirowner"></a>`backupdirowner` |
| 244 | 907 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
908 Data type: `String[1]` |
| 244 | 909 |
| 910 Owner for the backup directory. This parameter is passed directly to the file resource. | |
| 911 | |
| 389 | 912 Default value: `'root'` |
| 913 | |
| 443 | 914 ##### <a name="-mysql--server--backup--backupdirgroup"></a>`backupdirgroup` |
| 244 | 915 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
916 Data type: `String[1]` |
| 244 | 917 |
| 918 Group owner for the backup directory. This parameter is passed directly to the file resource. | |
| 919 | |
| 389 | 920 Default value: `$mysql::params::root_group` |
| 921 | |
| 443 | 922 ##### <a name="-mysql--server--backup--backupcompress"></a>`backupcompress` |
| 244 | 923 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
924 Data type: `Boolean` |
| 244 | 925 |
| 389 | 926 Whether or not to compress the backup (when using the mysqldump or xtrabackup provider) |
| 927 | |
| 443 | 928 Default value: `true` |
| 929 | |
| 930 ##### <a name="-mysql--server--backup--backupmethod"></a>`backupmethod` | |
| 244 | 931 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
932 Data type: `Optional[String[1]]` |
| 244 | 933 |
| 934 The execution binary for backing up. ex. mysqldump, xtrabackup, mariabackup | |
| 935 | |
| 443 | 936 Default value: `undef` |
| 937 | |
| 938 ##### <a name="-mysql--server--backup--backup_success_file_path"></a>`backup_success_file_path` | |
| 244 | 939 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
940 Data type: `String[1]` |
| 244 | 941 |
| 942 Specify a path where upon successfull backup a file should be created for checking purposes. | |
| 943 | |
| 389 | 944 Default value: `'/tmp/mysqlbackup_success'` |
| 945 | |
| 443 | 946 ##### <a name="-mysql--server--backup--backuprotate"></a>`backuprotate` |
| 244 | 947 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
948 Data type: `Variant[String[1], Integer]` |
| 244 | 949 |
| 950 Backup rotation interval in 24 hour periods. | |
| 951 | |
| 389 | 952 Default value: `30` |
| 953 | |
| 443 | 954 ##### <a name="-mysql--server--backup--ignore_events"></a>`ignore_events` |
| 244 | 955 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
956 Data type: `Boolean` |
| 244 | 957 |
| 958 Ignore the mysql.event table. | |
| 959 | |
| 443 | 960 Default value: `true` |
| 961 | |
| 962 ##### <a name="-mysql--server--backup--delete_before_dump"></a>`delete_before_dump` | |
| 244 | 963 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
964 Data type: `Boolean` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
965 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
966 Whether to delete old .sql files before backing up. |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
967 Setting to true deletes old files before backing up, while setting to false deletes them after backup. |
| 244 | 968 |
| 443 | 969 Default value: `false` |
| 970 | |
| 971 ##### <a name="-mysql--server--backup--backupdatabases"></a>`backupdatabases` | |
| 244 | 972 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
973 Data type: `Array[String[1]]` |
| 244 | 974 |
| 975 Databases to backup (required if using xtrabackup provider). By default `[]` will back up all databases. | |
| 976 | |
| 389 | 977 Default value: `[]` |
| 978 | |
| 443 | 979 ##### <a name="-mysql--server--backup--file_per_database"></a>`file_per_database` |
| 244 | 980 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
981 Data type: `Boolean` |
| 244 | 982 |
| 983 Use file per database mode creating one file per database backup. | |
| 984 | |
| 443 | 985 Default value: `false` |
| 986 | |
| 987 ##### <a name="-mysql--server--backup--include_routines"></a>`include_routines` | |
| 244 | 988 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
989 Data type: `Boolean` |
| 244 | 990 |
| 991 Dump stored routines (procedures and functions) from dumped databases when doing a `file_per_database` backup. | |
| 992 | |
| 443 | 993 Default value: `false` |
| 994 | |
| 995 ##### <a name="-mysql--server--backup--include_triggers"></a>`include_triggers` | |
| 244 | 996 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
997 Data type: `Boolean` |
| 244 | 998 |
| 999 Dump triggers for each dumped table when doing a `file_per_database` backup. | |
| 1000 | |
| 443 | 1001 Default value: `false` |
| 1002 | |
| 1003 ##### <a name="-mysql--server--backup--incremental_backups"></a>`incremental_backups` | |
| 244 | 1004 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1005 Data type: `Boolean` |
| 244 | 1006 |
| 389 | 1007 A flag to activate/deactivate incremental backups. Currently only supported by the xtrabackup provider. |
| 1008 | |
| 443 | 1009 Default value: `true` |
| 1010 | |
| 1011 ##### <a name="-mysql--server--backup--ensure"></a>`ensure` | |
| 389 | 1012 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1013 Data type: `Variant[Enum['present','absent'], Pattern[/(\d+)[\.](\d+)[\.](\d+)/]]` |
| 389 | 1014 |
| 1015 | |
| 1016 | |
| 1017 Default value: `'present'` | |
| 1018 | |
| 443 | 1019 ##### <a name="-mysql--server--backup--time"></a>`time` |
| 244 | 1020 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1021 Data type: `Variant[Array[String[1]], Array[Integer]]` |
| 244 | 1022 |
| 1023 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. | |
| 1024 | |
| 389 | 1025 Default value: `['23', '5']` |
| 1026 | |
| 443 | 1027 ##### <a name="-mysql--server--backup--prescript"></a>`prescript` |
| 244 | 1028 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1029 Data type: `Variant[Boolean, String[1], Array[String[1]]]` |
| 244 | 1030 |
| 1031 A script that is executed before the backup begins. | |
| 1032 | |
| 443 | 1033 Default value: `false` |
| 1034 | |
| 1035 ##### <a name="-mysql--server--backup--postscript"></a>`postscript` | |
| 244 | 1036 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1037 Data type: `Variant[Boolean, String[1], Array[String[1]]]` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1038 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1039 A script that is executed when the backup is finished. This could be used to sync the backup to a central store. |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1040 This script can be either a single line that is directly executed or a number of lines supplied as an array. |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1041 It could also be one or more externally managed (executable) files. |
| 244 | 1042 |
| 443 | 1043 Default value: `false` |
| 1044 | |
| 1045 ##### <a name="-mysql--server--backup--execpath"></a>`execpath` | |
| 244 | 1046 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1047 Data type: `String[1]` |
| 244 | 1048 |
| 1049 Allows you to set a custom PATH should your MySQL installation be non-standard places. Defaults to `/usr/bin:/usr/sbin:/bin:/sbin`. | |
| 1050 | |
| 389 | 1051 Default value: `'/usr/bin:/usr/sbin:/bin:/sbin'` |
| 1052 | |
| 443 | 1053 ##### <a name="-mysql--server--backup--provider"></a>`provider` |
| 244 | 1054 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1055 Data type: `Enum['xtrabackup', 'mysqldump', 'mysqlbackup']` |
| 244 | 1056 |
| 443 | 1057 Sets the server backup implementation. Valid values are: xtrabackup, mysqldump, mysqlbackup |
| 244 | 1058 |
| 389 | 1059 Default value: `'mysqldump'` |
| 1060 | |
| 443 | 1061 ##### <a name="-mysql--server--backup--maxallowedpacket"></a>`maxallowedpacket` |
| 244 | 1062 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1063 Data type: `String[1]` |
| 244 | 1064 |
| 1065 Defines the maximum SQL statement size for the backup dump script. The default value is 1MB, as this is the default MySQL Server value. | |
| 1066 | |
| 389 | 1067 Default value: `'1M'` |
| 1068 | |
| 443 | 1069 ##### <a name="-mysql--server--backup--optional_args"></a>`optional_args` |
| 244 | 1070 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1071 Data type: `Array[String[1]]` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1072 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1073 Specifies an array of optional arguments which should be passed through to the backup tool. |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1074 (Supported by the xtrabackup and mysqldump providers.) |
| 244 | 1075 |
| 389 | 1076 Default value: `[]` |
| 1077 | |
| 443 | 1078 ##### <a name="-mysql--server--backup--install_cron"></a>`install_cron` |
| 244 | 1079 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1080 Data type: `Boolean` |
| 244 | 1081 |
| 389 | 1082 Manage installation of cron package |
| 1083 | |
| 443 | 1084 Default value: `true` |
| 1085 | |
| 1086 ##### <a name="-mysql--server--backup--compression_command"></a>`compression_command` | |
| 244 | 1087 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1088 Data type: `Optional[String[1]]` |
| 244 | 1089 |
| 389 | 1090 Configure the command used to compress the backup (when using the mysqldump provider). Make sure the command exists |
| 1091 on the target system. Packages for it are NOT automatically installed. | |
| 1092 | |
| 443 | 1093 Default value: `undef` |
| 1094 | |
| 1095 ##### <a name="-mysql--server--backup--compression_extension"></a>`compression_extension` | |
| 244 | 1096 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1097 Data type: `Optional[String[1]]` |
| 244 | 1098 |
| 389 | 1099 Configure the file extension for the compressed backup (when using the mysqldump provider) |
| 1100 | |
| 443 | 1101 Default value: `undef` |
| 1102 | |
| 1103 ##### <a name="-mysql--server--backup--backupmethod_package"></a>`backupmethod_package` | |
| 1104 | |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1105 Data type: `String[1]` |
| 443 | 1106 |
| 1107 The package which provides the binary specified by the backupmethod parameter. | |
| 1108 | |
| 1109 Default value: `$mysql::params::xtrabackup_package_name` | |
| 1110 | |
| 1111 ##### <a name="-mysql--server--backup--excludedatabases"></a>`excludedatabases` | |
| 1112 | |
| 1113 Data type: `Array[String]` | |
| 1114 | |
| 1115 Give a list of excluded databases when using file_per_database, e.g.: [ 'information_schema', 'performance_schema' ] | |
| 1116 | |
| 1117 Default value: `[]` | |
| 244 | 1118 |
| 1119 ## Defined types | |
| 1120 | |
| 443 | 1121 ### <a name="mysql--db"></a>`mysql::db` |
| 244 | 1122 |
| 1123 Create and configure a MySQL database. | |
| 1124 | |
| 1125 #### Examples | |
| 1126 | |
| 1127 ##### Create a database | |
| 1128 | |
| 1129 ```puppet | |
| 1130 mysql::db { 'mydb': | |
| 1131 user => 'myuser', | |
| 1132 password => 'mypass', | |
| 1133 host => 'localhost', | |
| 1134 grant => ['SELECT', 'UPDATE'], | |
| 1135 } | |
| 1136 ``` | |
| 1137 | |
| 1138 #### Parameters | |
| 1139 | |
| 389 | 1140 The following parameters are available in the `mysql::db` defined type: |
| 1141 | |
| 443 | 1142 * [`name`](#-mysql--db--name) |
| 1143 * [`user`](#-mysql--db--user) | |
| 1144 * [`password`](#-mysql--db--password) | |
| 1145 * [`tls_options`](#-mysql--db--tls_options) | |
| 1146 * [`dbname`](#-mysql--db--dbname) | |
| 1147 * [`charset`](#-mysql--db--charset) | |
| 1148 * [`collate`](#-mysql--db--collate) | |
| 1149 * [`host`](#-mysql--db--host) | |
| 1150 * [`grant`](#-mysql--db--grant) | |
| 1151 * [`grant_options`](#-mysql--db--grant_options) | |
| 1152 * [`sql`](#-mysql--db--sql) | |
| 1153 * [`enforce_sql`](#-mysql--db--enforce_sql) | |
| 1154 * [`ensure`](#-mysql--db--ensure) | |
| 1155 * [`import_timeout`](#-mysql--db--import_timeout) | |
| 1156 * [`import_cat_cmd`](#-mysql--db--import_cat_cmd) | |
| 1157 * [`mysql_exec_path`](#-mysql--db--mysql_exec_path) | |
| 1158 | |
| 1159 ##### <a name="-mysql--db--name"></a>`name` | |
| 1160 | |
| 1161 The name of the database to create. Database names must: | |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1162 * not be longer than 64 characters. |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1163 * not contain '/' '\' or '.' characters. |
| 443 | 1164 * not contain characters that are not permitted in file names. |
| 1165 * not end with space characters. | |
| 1166 | |
| 1167 ##### <a name="-mysql--db--user"></a>`user` | |
| 244 | 1168 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1169 Data type: `String[1]` |
| 244 | 1170 |
| 1171 The user for the database you're creating. | |
| 1172 | |
| 443 | 1173 ##### <a name="-mysql--db--password"></a>`password` |
| 389 | 1174 |
| 1175 Data type: `Variant[String, Sensitive[String]]` | |
| 244 | 1176 |
| 1177 The password for $user for the database you're creating. | |
| 1178 | |
| 443 | 1179 ##### <a name="-mysql--db--tls_options"></a>`tls_options` |
| 244 | 1180 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1181 Data type: `Optional[Array[String[1]]]` |
| 244 | 1182 |
| 1183 The tls_options for $user for the database you're creating. | |
| 1184 | |
| 443 | 1185 Default value: `undef` |
| 1186 | |
| 1187 ##### <a name="-mysql--db--dbname"></a>`dbname` | |
| 1188 | |
| 1189 Data type: `String` | |
| 244 | 1190 |
| 1191 The name of the database to create. | |
| 1192 | |
| 389 | 1193 Default value: `$name` |
| 1194 | |
| 443 | 1195 ##### <a name="-mysql--db--charset"></a>`charset` |
| 244 | 1196 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1197 Data type: `String[1]` |
| 244 | 1198 |
| 443 | 1199 The character set for the database. Must have the same value as collate to avoid corrective changes. See https://dev.mysql.com/doc/refman/8.0/en/charset-mysql.html for charset and collation pairs. |
| 244 | 1200 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1201 Default value: `'utf8mb3'` |
| 389 | 1202 |
| 443 | 1203 ##### <a name="-mysql--db--collate"></a>`collate` |
| 244 | 1204 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1205 Data type: `String[1]` |
| 244 | 1206 |
| 443 | 1207 The collation for the database. Must have the same value as charset to avoid corrective changes. See https://dev.mysql.com/doc/refman/8.0/en/charset-mysql.html for charset and collation pairs. |
| 244 | 1208 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1209 Default value: `'utf8mb3_general_ci'` |
| 389 | 1210 |
| 443 | 1211 ##### <a name="-mysql--db--host"></a>`host` |
| 244 | 1212 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1213 Data type: `String[1]` |
| 244 | 1214 |
| 1215 The host to use as part of user@host for grants. | |
| 1216 | |
| 389 | 1217 Default value: `'localhost'` |
| 1218 | |
| 443 | 1219 ##### <a name="-mysql--db--grant"></a>`grant` |
| 244 | 1220 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1221 Data type: `Variant[String[1], Array[String[1]]]` |
| 244 | 1222 |
| 1223 The privileges to be granted for user@host on the database. | |
| 1224 | |
| 389 | 1225 Default value: `'ALL'` |
| 1226 | |
| 443 | 1227 ##### <a name="-mysql--db--grant_options"></a>`grant_options` |
| 244 | 1228 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1229 Data type: `Optional[Variant[String[1], Array[String[1]]]]` |
| 244 | 1230 |
| 1231 The grant_options for the grant for user@host on the database. | |
| 1232 | |
| 443 | 1233 Default value: `undef` |
| 1234 | |
| 1235 ##### <a name="-mysql--db--sql"></a>`sql` | |
| 1236 | |
| 1237 Data type: `Optional[Array]` | |
| 1238 | |
| 1239 The path to the sqlfile you want to execute. This can be an array containing one or more file paths. | |
| 1240 | |
| 1241 Default value: `undef` | |
| 1242 | |
| 1243 ##### <a name="-mysql--db--enforce_sql"></a>`enforce_sql` | |
| 244 | 1244 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1245 Data type: `Boolean` |
| 244 | 1246 |
| 1247 Specifies whether executing the sqlfiles should happen on every run. If set to false, sqlfiles only run once. | |
| 1248 | |
| 443 | 1249 Default value: `false` |
| 1250 | |
| 1251 ##### <a name="-mysql--db--ensure"></a>`ensure` | |
| 244 | 1252 |
| 1253 Data type: `Enum['absent', 'present']` | |
| 1254 | |
| 1255 Specifies whether to create the database. Valid values are 'present', 'absent'. Defaults to 'present'. | |
| 1256 | |
| 389 | 1257 Default value: `'present'` |
| 1258 | |
| 443 | 1259 ##### <a name="-mysql--db--import_timeout"></a>`import_timeout` |
| 244 | 1260 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1261 Data type: `Integer` |
| 244 | 1262 |
| 1263 Timeout, in seconds, for loading the sqlfiles. Defaults to 300. | |
| 1264 | |
| 389 | 1265 Default value: `300` |
| 1266 | |
| 443 | 1267 ##### <a name="-mysql--db--import_cat_cmd"></a>`import_cat_cmd` |
| 1268 | |
| 1269 Data type: `Enum['cat', 'zcat', 'bzcat']` | |
| 244 | 1270 |
| 1271 Command to read the sqlfile for importing the database. Useful for compressed sqlfiles. For example, you can use 'zcat' for .gz files. | |
| 1272 | |
| 389 | 1273 Default value: `'cat'` |
| 1274 | |
| 443 | 1275 ##### <a name="-mysql--db--mysql_exec_path"></a>`mysql_exec_path` |
| 244 | 1276 |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1277 Data type: `Optional[String]` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1278 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1279 Specify the path in which mysql has been installed if done in the non-standard bin/sbin path. |
| 244 | 1280 |
| 443 | 1281 Default value: `undef` |
| 244 | 1282 |
| 1283 ## Resource types | |
| 1284 | |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1285 ### <a name="mysql_database"></a>`mysql_database` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1286 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1287 Manage a MySQL database. |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1288 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1289 #### Properties |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1290 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1291 The following properties are available in the `mysql_database` type. |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1292 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1293 ##### `charset` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1294 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1295 Valid values: `%r{^\S+$}` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1296 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1297 The CHARACTER SET setting for the database |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1298 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1299 Default value: `utf8` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1300 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1301 ##### `collate` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1302 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1303 Valid values: `%r{^\S+$}` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1304 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1305 The COLLATE setting for the database |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1306 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1307 Default value: `utf8_general_ci` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1308 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1309 ##### `ensure` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1310 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1311 Valid values: `present`, `absent` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1312 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1313 The basic property that the resource should be in. |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1314 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1315 Default value: `present` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1316 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1317 #### Parameters |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1318 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1319 The following parameters are available in the `mysql_database` type. |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1320 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1321 * [`name`](#-mysql_database--name) |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1322 * [`provider`](#-mysql_database--provider) |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1323 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1324 ##### <a name="-mysql_database--name"></a>`name` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1325 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1326 namevar |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1327 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1328 The name of the MySQL database to manage. |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1329 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1330 ##### <a name="-mysql_database--provider"></a>`provider` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1331 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1332 The specific backend to use for this `mysql_database` resource. You will seldom need to specify this --- Puppet will |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1333 usually discover the appropriate provider for your platform. |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1334 |
| 389 | 1335 ### <a name="mysql_grant"></a>`mysql_grant` |
| 244 | 1336 |
| 1337 Manage a MySQL user's rights. | |
| 1338 | |
| 1339 #### Properties | |
| 1340 | |
| 1341 The following properties are available in the `mysql_grant` type. | |
| 1342 | |
| 1343 ##### `ensure` | |
| 1344 | |
| 389 | 1345 Valid values: `present`, `absent` |
| 244 | 1346 |
| 1347 The basic property that the resource should be in. | |
| 1348 | |
| 389 | 1349 Default value: `present` |
| 1350 | |
| 1351 ##### `options` | |
| 1352 | |
| 1353 Options to grant. | |
| 244 | 1354 |
| 1355 ##### `privileges` | |
| 1356 | |
| 1357 Privileges for user | |
| 1358 | |
| 1359 ##### `table` | |
| 1360 | |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1361 Valid values: `%r{.*\..*}`, `%r{^[0-9a-zA-Z$_]*@[\w%.:\-/]*$}` |
| 244 | 1362 |
| 1363 Table to apply privileges to. | |
| 1364 | |
| 1365 ##### `user` | |
| 1366 | |
| 1367 User to operate on. | |
| 1368 | |
| 1369 #### Parameters | |
| 1370 | |
| 1371 The following parameters are available in the `mysql_grant` type. | |
| 1372 | |
| 443 | 1373 * [`name`](#-mysql_grant--name) |
| 1374 * [`provider`](#-mysql_grant--provider) | |
| 1375 | |
| 1376 ##### <a name="-mysql_grant--name"></a>`name` | |
| 244 | 1377 |
| 1378 namevar | |
| 1379 | |
| 1380 Name to describe the grant. | |
| 1381 | |
| 443 | 1382 ##### <a name="-mysql_grant--provider"></a>`provider` |
| 389 | 1383 |
| 1384 The specific backend to use for this `mysql_grant` resource. You will seldom need to specify this --- Puppet will | |
| 1385 usually discover the appropriate provider for your platform. | |
| 1386 | |
| 1387 ### <a name="mysql_login_path"></a>`mysql_login_path` | |
| 1388 | |
| 1389 This type provides Puppet with the capabilities to store authentication credentials in an obfuscated login path file | |
| 1390 named .mylogin.cnf created with the mysql_config_editor utility. Supports only MySQL Community Edition > v5.6.6. | |
| 1391 | |
| 1392 * **See also** | |
| 1393 * https://dev.mysql.com/doc/refman/8.0/en/mysql-config-editor.html | |
| 1394 | |
| 1395 #### Examples | |
| 1396 | |
| 1397 ##### | |
| 1398 | |
| 1399 ```puppet | |
| 1400 mysql_login_path { 'local_socket': | |
| 1401 owner => 'root', | |
| 1402 host => 'localhost', | |
| 1403 user => 'root', | |
| 1404 password => Sensitive('secure'), | |
| 1405 socket => '/var/run/mysql/mysql.sock', | |
| 1406 ensure => present, | |
| 1407 } | |
| 1408 | |
| 1409 mysql_login_path { 'local_tcp': | |
| 1410 owner => 'root', | |
| 1411 host => '127.0.0.1', | |
| 1412 user => 'root', | |
| 1413 password => Sensitive('more_secure'), | |
| 1414 port => 3306, | |
| 1415 ensure => present, | |
| 1416 } | |
| 1417 ``` | |
| 1418 | |
| 1419 #### Properties | |
| 1420 | |
| 1421 The following properties are available in the `mysql_login_path` type. | |
| 1422 | |
| 1423 ##### `ensure` | |
| 1424 | |
| 1425 Data type: `Enum[present, absent]` | |
| 1426 | |
| 1427 Whether this resource should be present or absent on the target system. | |
| 1428 | |
| 1429 ##### `host` | |
| 1430 | |
| 1431 Data type: `Optional[String]` | |
| 1432 | |
| 1433 Host name to be entered into the login path. | |
| 1434 | |
| 1435 ##### `password` | |
| 1436 | |
| 1437 Data type: `Optional[Sensitive[String[1]]]` | |
| 1438 | |
| 1439 Password to be entered into login path | |
| 1440 | |
| 1441 ##### `port` | |
| 1442 | |
| 1443 Data type: `Optional[Integer[0,65535]]` | |
| 1444 | |
| 1445 Port number to be entered into login path. | |
| 1446 | |
| 1447 ##### `socket` | |
| 1448 | |
| 1449 Data type: `Optional[String]` | |
| 1450 | |
| 1451 Socket path to be entered into login path | |
| 1452 | |
| 1453 ##### `user` | |
| 1454 | |
| 1455 Data type: `Optional[String]` | |
| 1456 | |
| 1457 Username to be entered into the login path. | |
| 1458 | |
| 1459 #### Parameters | |
| 1460 | |
| 1461 The following parameters are available in the `mysql_login_path` type. | |
| 1462 | |
| 443 | 1463 * [`name`](#-mysql_login_path--name) |
| 1464 * [`owner`](#-mysql_login_path--owner) | |
| 1465 | |
| 1466 ##### <a name="-mysql_login_path--name"></a>`name` | |
| 389 | 1467 |
| 1468 namevar | |
| 1469 | |
| 1470 Data type: `String` | |
| 1471 | |
| 1472 Name of the login path you want to manage. | |
| 1473 | |
| 443 | 1474 ##### <a name="-mysql_login_path--owner"></a>`owner` |
| 389 | 1475 |
| 1476 namevar | |
| 1477 | |
| 1478 Data type: `String` | |
| 1479 | |
| 1480 The user to whom the logon path should belong. | |
| 1481 | |
| 1482 Default value: `root` | |
| 1483 | |
| 1484 ### <a name="mysql_plugin"></a>`mysql_plugin` | |
| 244 | 1485 |
| 1486 Manage MySQL plugins. | |
| 1487 | |
| 1488 #### Examples | |
| 1489 | |
| 1490 ##### | |
| 1491 | |
| 1492 ```puppet | |
| 1493 mysql_plugin { 'some_plugin': | |
| 1494 soname => 'some_pluginlib.so', | |
| 1495 } | |
| 1496 ``` | |
| 1497 | |
| 1498 #### Properties | |
| 1499 | |
| 1500 The following properties are available in the `mysql_plugin` type. | |
| 1501 | |
| 1502 ##### `ensure` | |
| 1503 | |
| 389 | 1504 Valid values: `present`, `absent` |
| 244 | 1505 |
| 1506 The basic property that the resource should be in. | |
| 1507 | |
| 389 | 1508 Default value: `present` |
| 244 | 1509 |
| 1510 ##### `soname` | |
| 1511 | |
| 389 | 1512 Valid values: `%r{^\w+\.\w+$}` |
| 244 | 1513 |
| 1514 The name of the library | |
| 1515 | |
| 1516 #### Parameters | |
| 1517 | |
| 1518 The following parameters are available in the `mysql_plugin` type. | |
| 1519 | |
| 443 | 1520 * [`name`](#-mysql_plugin--name) |
| 1521 * [`provider`](#-mysql_plugin--provider) | |
| 1522 | |
| 1523 ##### <a name="-mysql_plugin--name"></a>`name` | |
| 244 | 1524 |
| 1525 namevar | |
| 1526 | |
| 1527 The name of the MySQL plugin to manage. | |
| 1528 | |
| 443 | 1529 ##### <a name="-mysql_plugin--provider"></a>`provider` |
| 389 | 1530 |
| 1531 The specific backend to use for this `mysql_plugin` resource. You will seldom need to specify this --- Puppet will | |
| 1532 usually discover the appropriate provider for your platform. | |
| 1533 | |
| 1534 ### <a name="mysql_user"></a>`mysql_user` | |
| 244 | 1535 |
| 1536 Manage a MySQL user. This includes management of users password as well as privileges. | |
| 1537 | |
| 1538 #### Properties | |
| 1539 | |
| 1540 The following properties are available in the `mysql_user` type. | |
| 1541 | |
| 1542 ##### `ensure` | |
| 1543 | |
| 389 | 1544 Valid values: `present`, `absent` |
| 244 | 1545 |
| 1546 The basic property that the resource should be in. | |
| 1547 | |
| 389 | 1548 Default value: `present` |
| 244 | 1549 |
| 1550 ##### `max_connections_per_hour` | |
| 1551 | |
| 389 | 1552 Valid values: `%r{\d+}` |
| 244 | 1553 |
| 1554 Max connections per hour for the user. 0 means no (or global) limit. | |
| 1555 | |
| 1556 ##### `max_queries_per_hour` | |
| 1557 | |
| 389 | 1558 Valid values: `%r{\d+}` |
| 244 | 1559 |
| 1560 Max queries per hour for the user. 0 means no (or global) limit. | |
| 1561 | |
| 1562 ##### `max_updates_per_hour` | |
| 1563 | |
| 389 | 1564 Valid values: `%r{\d+}` |
| 244 | 1565 |
| 1566 Max updates per hour for the user. 0 means no (or global) limit. | |
| 1567 | |
| 389 | 1568 ##### `max_user_connections` |
| 1569 | |
| 1570 Valid values: `%r{\d+}` | |
| 1571 | |
| 1572 Max concurrent connections for the user. 0 means no (or global) limit. | |
| 1573 | |
| 1574 ##### `password_hash` | |
| 1575 | |
| 1576 Valid values: `%r{\w*}` | |
| 1577 | |
| 1578 The password hash of the user. Use mysql::password() for creating such a hash. | |
| 1579 | |
| 1580 ##### `plugin` | |
| 1581 | |
| 1582 Valid values: `%r{\w+}` | |
| 1583 | |
| 1584 The authentication plugin of the user. | |
| 1585 | |
| 244 | 1586 ##### `tls_options` |
| 1587 | |
| 1588 Options to that set the TLS-related REQUIRE attributes for the user. | |
| 1589 | |
| 1590 #### Parameters | |
| 1591 | |
| 1592 The following parameters are available in the `mysql_user` type. | |
| 1593 | |
| 443 | 1594 * [`name`](#-mysql_user--name) |
| 1595 * [`provider`](#-mysql_user--provider) | |
| 1596 | |
| 1597 ##### <a name="-mysql_user--name"></a>`name` | |
| 244 | 1598 |
| 1599 namevar | |
| 1600 | |
| 1601 The name of the user. This uses the 'username@hostname' or username@hostname. | |
| 1602 | |
| 443 | 1603 ##### <a name="-mysql_user--provider"></a>`provider` |
| 389 | 1604 |
| 1605 The specific backend to use for this `mysql_user` resource. You will seldom need to specify this --- Puppet will usually | |
| 1606 discover the appropriate provider for your platform. | |
| 1607 | |
| 244 | 1608 ## Functions |
| 1609 | |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1610 ### <a name="mysql--innobackupex_args"></a>`mysql::innobackupex_args` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1611 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1612 Type: Ruby 4.x API |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1613 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1614 This function populates and returns the string of arguments which later gets injected in template. Arguments that return string holds is conditional and decided by the the input given to function. |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1615 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1616 #### `mysql::innobackupex_args(Optional[String] $backupuser, Boolean $backupcompress, Optional[Variant[String, Sensitive[String]]] $backuppassword_unsensitive, Array[String[1]] $backupdatabases, Array[String[1]] $optional_args)` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1617 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1618 The mysql::innobackupex_args function. |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1619 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1620 Returns: `Variant[String]` String |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1621 Generated on the basis of provided values. |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1622 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1623 ##### `backupuser` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1624 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1625 Data type: `Optional[String]` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1626 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1627 The user to use for the backup. |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1628 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1629 ##### `backupcompress` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1630 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1631 Data type: `Boolean` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1632 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1633 If the backup should be compressed. |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1634 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1635 ##### `backuppassword_unsensitive` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1636 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1637 Data type: `Optional[Variant[String, Sensitive[String]]]` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1638 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1639 The password to use for the backup. |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1640 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1641 ##### `backupdatabases` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1642 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1643 Data type: `Array[String[1]]` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1644 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1645 The databases to backup. |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1646 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1647 ##### `optional_args` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1648 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1649 Data type: `Array[String[1]]` |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1650 |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1651 Additional arguments to pass to innobackupex. |
|
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1652 |
| 443 | 1653 ### <a name="mysql--normalise_and_deepmerge"></a>`mysql::normalise_and_deepmerge` |
| 244 | 1654 |
| 1655 Type: Ruby 4.x API | |
| 1656 | |
| 1657 - When there is a duplicate key that is a hash, they are recursively merged. | |
| 1658 - When there is a duplicate key that is not a hash, the key in the rightmost hash will "win." | |
| 1659 - When there are conficting uses of dashes and underscores in two keys (which mysql would otherwise equate), the rightmost style will win. | |
| 1660 | |
| 1661 #### Examples | |
| 1662 | |
| 1663 ##### | |
| 1664 | |
| 1665 ```puppet | |
| 1666 $hash1 = {'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } } | |
| 1667 $hash2 = {'two' => 'dos', 'three' => { 'five' => 5 } } | |
| 1668 $merged_hash = mysql::normalise_and_deepmerge($hash1, $hash2) | |
| 1669 # The resulting hash is equivalent to: | |
| 1670 # $merged_hash = { 'one' => 1, 'two' => 'dos', 'three' => { 'four' => 4, 'five' => 5 } } | |
| 1671 ``` | |
| 1672 | |
| 1673 #### `mysql::normalise_and_deepmerge(Any *$args)` | |
| 1674 | |
| 1675 - When there is a duplicate key that is a hash, they are recursively merged. | |
| 1676 - When there is a duplicate key that is not a hash, the key in the rightmost hash will "win." | |
| 1677 - When there are conficting uses of dashes and underscores in two keys (which mysql would otherwise equate), the rightmost style will win. | |
| 1678 | |
| 389 | 1679 Returns: `Any` hash |
| 1680 The given hash normalised | |
| 244 | 1681 |
| 1682 ##### Examples | |
| 1683 | |
| 1684 ###### | |
| 1685 | |
| 1686 ```puppet | |
| 1687 $hash1 = {'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } } | |
| 1688 $hash2 = {'two' => 'dos', 'three' => { 'five' => 5 } } | |
| 1689 $merged_hash = mysql::normalise_and_deepmerge($hash1, $hash2) | |
| 1690 # The resulting hash is equivalent to: | |
| 1691 # $merged_hash = { 'one' => 1, 'two' => 'dos', 'three' => { 'four' => 4, 'five' => 5 } } | |
| 1692 ``` | |
| 1693 | |
| 1694 ##### `*args` | |
| 1695 | |
| 1696 Data type: `Any` | |
| 1697 | |
| 389 | 1698 Hash to be normalised |
| 1699 | |
| 443 | 1700 ### <a name="mysql--password"></a>`mysql::password` |
| 244 | 1701 |
| 1702 Type: Ruby 4.x API | |
| 1703 | |
| 1704 Hash a string as mysql's "PASSWORD()" function would do it | |
| 1705 | |
| 389 | 1706 #### `mysql::password(Variant[String, Sensitive[String]] $password, Optional[Boolean] $sensitive)` |
| 1707 | |
| 1708 Hash a string as mysql's "PASSWORD()" function would do it | |
| 1709 | |
| 1710 Returns: `Variant[String, Sensitive[String]]` hash | |
| 244 | 1711 The mysql password hash from the clear text password. |
| 1712 | |
| 1713 ##### `password` | |
| 1714 | |
| 389 | 1715 Data type: `Variant[String, Sensitive[String]]` |
| 244 | 1716 |
| 1717 Plain text password. | |
| 1718 | |
| 389 | 1719 ##### `sensitive` |
| 1720 | |
| 1721 Data type: `Optional[Boolean]` | |
| 1722 | |
| 443 | 1723 If the mysql password hash should be of datatype Sensitive[String] |
| 1724 | |
| 1725 ### <a name="mysql--strip_hash"></a>`mysql::strip_hash` | |
| 244 | 1726 |
| 1727 Type: Ruby 4.x API | |
| 1728 | |
| 1729 When given a hash this function strips out all blank entries. | |
| 1730 | |
| 1731 #### `mysql::strip_hash(Hash $hash)` | |
| 1732 | |
| 1733 The mysql::strip_hash function. | |
| 1734 | |
| 1735 Returns: `Hash` hash | |
| 1736 The given hash with all blank entries removed | |
| 1737 | |
| 1738 ##### `hash` | |
| 1739 | |
| 1740 Data type: `Hash` | |
| 1741 | |
| 1742 Hash to be stripped | |
| 1743 | |
| 389 | 1744 ### <a name="mysql_password"></a>`mysql_password` |
| 1745 | |
| 1746 Type: Ruby 4.x API | |
| 1747 | |
| 1748 DEPRECATED. Use the namespaced function [`mysql::password`](#mysqlpassword) instead. | |
| 1749 | |
| 1750 #### `mysql_password(Variant[String, Sensitive[String]] $password, Optional[Boolean] $sensitive)` | |
| 244 | 1751 |
| 1752 The mysql_password function. | |
| 1753 | |
| 389 | 1754 Returns: `Variant[String, Sensitive[String]]` The mysql password hash from the 4.x function mysql::password. |
| 244 | 1755 |
| 1756 ##### `password` | |
| 1757 | |
| 389 | 1758 Data type: `Variant[String, Sensitive[String]]` |
| 244 | 1759 |
| 1760 Plain text password. | |
| 1761 | |
| 389 | 1762 ##### `sensitive` |
| 1763 | |
| 1764 Data type: `Optional[Boolean]` | |
| 1765 | |
|
478
adf6fe9bbc17
Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents:
443
diff
changeset
|
1766 If the mysql password hash should be of datatype Sensitive[String] |
| 389 | 1767 |
| 1768 ## Data types | |
| 1769 | |
| 443 | 1770 ### <a name="Mysql--Options"></a>`Mysql::Options` |
| 389 | 1771 |
| 1772 Use this if you don’t want your options merged with the default options. | |
| 1773 | |
| 443 | 1774 Alias of `Hash[String, Hash]` |
| 389 | 1775 |
| 244 | 1776 ## Tasks |
| 1777 | |
| 389 | 1778 ### <a name="export"></a>`export` |
| 244 | 1779 |
| 1780 Allows you to backup your database to local file. | |
| 1781 | |
| 1782 **Supports noop?** false | |
| 1783 | |
| 1784 #### Parameters | |
| 1785 | |
| 1786 ##### `database` | |
| 1787 | |
| 1788 Data type: `Optional[String[1]]` | |
| 1789 | |
| 1790 Database to connect to | |
| 1791 | |
| 1792 ##### `user` | |
| 1793 | |
| 1794 Data type: `Optional[String[1]]` | |
| 1795 | |
| 1796 The user | |
| 1797 | |
| 1798 ##### `password` | |
| 1799 | |
| 1800 Data type: `Optional[String[1]]` | |
| 1801 | |
| 1802 The password | |
| 1803 | |
| 1804 ##### `file` | |
| 1805 | |
| 1806 Data type: `String[1]` | |
| 1807 | |
| 1808 Path to file you want backup to | |
| 1809 | |
| 389 | 1810 ### <a name="sql"></a>`sql` |
| 244 | 1811 |
| 1812 Allows you to execute arbitary SQL | |
| 1813 | |
| 1814 **Supports noop?** false | |
| 1815 | |
| 1816 #### Parameters | |
| 1817 | |
| 1818 ##### `database` | |
| 1819 | |
| 1820 Data type: `Optional[String[1]]` | |
| 1821 | |
| 1822 Database to connect to | |
| 1823 | |
| 1824 ##### `user` | |
| 1825 | |
| 1826 Data type: `Optional[String[1]]` | |
| 1827 | |
| 1828 The user | |
| 1829 | |
| 1830 ##### `password` | |
| 1831 | |
| 1832 Data type: `Optional[String[1]]` | |
| 1833 | |
| 1834 The password | |
| 1835 | |
| 1836 ##### `sql` | |
| 1837 | |
| 1838 Data type: `String[1]` | |
| 1839 | |
| 1840 The SQL you want to execute | |
| 1841 |