diff modules/mysql/README.md @ 478:adf6fe9bbc17

Update Puppet modules to latest versions
author IBBoard <dev@ibboard.co.uk>
date Thu, 29 Aug 2024 18:47:29 +0100
parents c6c9a2cfcfbd
children
line wrap: on
line diff
--- a/modules/mysql/README.md	Tue Aug 27 13:35:17 2024 +0100
+++ b/modules/mysql/README.md	Thu Aug 29 18:47:29 2024 +0100
@@ -17,7 +17,8 @@
     * [Use Percona XtraBackup](#use-percona-xtrabackup)
 4. [Reference - An under-the-hood peek at what the module is doing and how](REFERENCE.md)
 5. [Limitations - OS compatibility, etc.](#limitations)
-6. [Development - Guide for contributing to the module](#development)
+6. [License](#license)
+7. [Development - Guide for contributing to the module](#development)
 
 ## Module Description
 
@@ -99,6 +100,10 @@
 If you don’t want to use the default configuration, you can also supply your options to the `$options` parameter instead of `$override_options`.
 Please note that `$options` and `$override_options` are mutually exclusive, you can only use one of them.
 
+By default, the puppet won't reload/restart mysqld when you change an existing
+configuration. If you want to do that, you can set
+`mysql::server::reload_on_config_change` to true.
+
 ### Create a database
 
 To create a database with a user and some assigned privileges:
@@ -654,10 +659,14 @@
 
 ## Limitations
 
-For an extensive list of supported operating systems, see [metadata.json](https://github.com/puppetlabs/puppetlabs-mysql/blob/main/metadata.json)
+This module lacks compatibility with the ARM architecture, for an extensive list of supported operating systems, see [metadata.json](https://github.com/puppetlabs/puppetlabs-mysql/blob/main/metadata.json)
 
 **Note:** The mysqlbackup.sh does not work and is not supported on MySQL 5.7 and greater.
 
+## License
+
+This codebase is licensed under the Apache2.0 licensing, however due to the nature of the codebase the open source dependencies may also use a combination of [AGPL](https://opensource.org/license/agpl-v3/), [BSD-2](https://opensource.org/license/bsd-2-clause/), [BSD-3](https://opensource.org/license/bsd-3-clause/), [GPL2.0](https://opensource.org/license/gpl-2-0/), [LGPL](https://opensource.org/license/lgpl-3-0/), [MIT](https://opensource.org/license/mit/) and [MPL](https://opensource.org/license/mpl-2-0/) Licensing.
+
 ## Development
 
 We are experimenting with a new tool for running acceptance tests. Its name is [puppet_litmus](https://github.com/puppetlabs/puppet_litmus) this replaces beaker as the test runner. To run the acceptance tests follow the [instructions](https://puppetlabs.github.io/litmus/Running-acceptance-tests.html) from the Litmus documentation.