opuppet/module-puppetlabs-mysql
5
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

DOCS: minor tuneups on README

Browse source
This commit is contained in:
jbondpdx 2015-08-11 10:44:28 -07:00
parent 8dae90d0fa
commit bfcba98859
1 changed files with 112 additions and 121 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

53
README.md
View file

@ -1,10 +1,9 @@
#MySQL # mysql
#### Table of Contents #### Table of Contents
1. [Overview](#overview) 1. [Module Description - What the module does and why it is useful](#module-description)
2. [Module Description - What the module does and why it is useful](#module-description) 2. [Backwards compatibility information](#backwards-compatibility)
3. [Backwards compatibility information](#backwards-compatibility)
3. [Setup - The basics of getting started with mysql](#setup) 3. [Setup - The basics of getting started with mysql](#setup)
* [Beginning with mysql](#beginning-with-mysql) * [Beginning with mysql](#beginning-with-mysql)
4. [Usage - Configuration options and additional functionality](#usage) 4. [Usage - Configuration options and additional functionality](#usage)
@ -12,25 +11,17 @@
* [Creating a Database](#creating-a-database) * [Creating a Database](#creating-a-database)
* [Custom Configuration](#custom-configuration) * [Custom Configuration](#custom-configuration)
5. [Reference - An under-the-hood peek at what the module is doing and how](#reference) 5. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
5. [Limitations - OS compatibility, etc.](#limitations) 6. [Limitations - OS compatibility, etc.](#limitations)
6. [Development - Guide for contributing to the module](#development) 7. [Development - Guide for contributing to the module](#development)
##Overview
The MySQL module installs, configures, and manages the MySQL service.
## Module Description ## Module Description
The MySQL module installs, configures, and manages the MySQL service.
The MySQL module manages both the installation and configuration of MySQL, as well as extending Puppet to allow management of MySQL resources, such as databases, users, and grants. The MySQL module manages both the installation and configuration of MySQL, as well as extending Puppet to allow management of MySQL resources, such as databases, users, and grants.
## Setup ## Setup
###What MySQL affects
* MySQL package
* MySQL configuration files
* MySQL service
### Beginning with MySQL ### Beginning with MySQL
If you want a server installed with the default options you can run If you want a server installed with the default options you can run
@ -148,8 +139,8 @@ To add custom MySQL configuration, drop additional files into
### Working with an existing server ### Working with an existing server
It is possible to use the MySQL module to instantiate databases and You can use the MySQL module to instantiate databases and
users on an existing MySQL server. For this to work, you will need an users on an existing MySQL server. For this to work, you need an
appropriate `.my.cnf` in `root`'s home directory containing the remote appropriate `.my.cnf` in `root`'s home directory containing the remote
server address and credentials. For example: server address and credentials. For example:
@ -158,7 +149,7 @@ server address and credentials. For example:
host=localhost host=localhost
password=secret password=secret
When working with a remote server, you will *not* use the When working with a remote server, do *not* use the
`mysql::server` class in your Puppet manifests. `mysql::server` class in your Puppet manifests.
## Reference ## Reference
@ -166,15 +157,16 @@ When working with a remote server, you will *not* use the
### Classes ### Classes
#### Public classes #### Public classes
* `mysql::server`: Installs and configures MySQL.
* `mysql::server::account_security`: Deletes default MySQL accounts. * [`mysql::server`](#mysqlserver): Installs and configures MySQL.
* `mysql::server::monitor`: Sets up a monitoring user. * [`mysql::server::monitor`](#mysqlservermonitor): Sets up a monitoring user.
* `mysql::server::mysqltuner`: Installs MySQL tuner script. * [`mysql::server::mysqltuner`](#mysqlservermysqltuner): Installs MySQL tuner script.
* `mysql::server::backup`: Sets up MySQL backups via cron. * [`mysql::server::backup`](#mysqlserverbackup): Sets up MySQL backups via cron.
* `mysql::bindings`: Installs various MySQL language bindings. * [`mysql::bindings`](#mysqlbindings): Installs various MySQL language bindings.
* `mysql::client`: Installs MySQL client (for non-servers). * [`mysql::client`](#mysqlclient): Installs MySQL client (for non-servers).
#### Private classes #### Private classes
* `mysql::server::install`: Installs packages. * `mysql::server::install`: Installs packages.
* `mysql::server::config`: Configures MYSQL. * `mysql::server::config`: Configures MYSQL.
* `mysql::server::service`: Manages service. * `mysql::server::service`: Manages service.
@ -219,7 +211,7 @@ This is required if `create_root_user` or `create_root_my_cnf` are 'true'. If `r
Password changes are supported; however, the old password must be set in `/root/.my.cnf`. Effectively, Puppet uses the old password, configured in `/root/my.cnf`, to set the new password in MySQL, and then updates `/root/.my.cnf` with the new password. Password changes are supported; however, the old password must be set in `/root/.my.cnf`. Effectively, Puppet uses the old password, configured in `/root/my.cnf`, to set the new password in MySQL, and then updates `/root/.my.cnf` with the new password.
####`old_root_password` ##### `old_root_password`
This parameter no longer does anything. It exists only for backwards compatibility. See the `root_password` parameter above for details on changing the root password. This parameter no longer does anything. It exists only for backwards compatibility. See the `root_password` parameter above for details on changing the root password.
@ -595,7 +587,7 @@ Whether to manage the MySQL client package. Defaults to true.
The name of the MySQL client package to install. The name of the MySQL client package to install.
###Defined Types ### Defines
#### mysql::db #### mysql::db
@ -656,7 +648,6 @@ Specify whether to create the database. Valid values are 'present', 'absent'. De
Timeout, in seconds, for loading the sqlfiles. Defaults to '300'. Timeout, in seconds, for loading the sqlfiles. Defaults to '300'.
### Types ### Types
#### mysql_database #### mysql_database
@ -730,7 +721,7 @@ Maximum updates per hour for the user. Must be an integer value. A value of '0'
#### mysql_grant #### mysql_grant
`mysql_grant` creates grant permissions to access databases within `mysql_grant` creates grant permissions to access databases within
MySQL. To use it you must create the title of the resource as shown below, MySQL. To create grant permissions to access databases with MySQL, use it you must create the title of the resource as shown below,
following the pattern of `username@hostname/database.table`: following the pattern of `username@hostname/database.table`:
~~~ ~~~
@ -826,7 +817,7 @@ This module has been tested on:
Testing on other platforms has been minimal and cannot be guaranteed. Testing on other platforms has been minimal and cannot be guaranteed.
#Development ## Development
Puppet Labs modules on the Puppet Forge are open projects, and community Puppet Labs modules on the Puppet Forge are open projects, and community
contributions are essential for keeping them great. We can't access the contributions are essential for keeping them great. We can't access the