Mod: update readme

Author: lermit

README.md

@@ -25,20 +25,66 @@ For detailed info about the logic and usage patterns of Example42 modules read R
 * Set a random password ( saved in /root/.my.cnf )
 
         class { "mysql":
-          root_password => 'auto',          
+          root_password => 'auto',
         }
 
-* Create a new grant and database. mysql_db_init_query_file is optional and will run only once.
+* Create a new grant and database
+
+### Create database and manage GRANT
+
+The simplest way to create database is the following.
+
+        mysql::grant { 'db1':
+          mysql_username => 'myusername',
+          mysql_password => 'mypassword',
+        }
+
+This will create a MySQL database named 'db1' with a MySQL grant allowing full access to user 'myusername' with 'mypassword' password on local host.
+
+#### Customize host source
+If you want to customize the host the new user can connect from you have to use the 'mysql\_host'.
+
+        mysql::grant { 'db1':
+          mysql_username => 'myusername',
+          mysql_password => 'mypassword',
+          mysql_host     => '10.42.42.0/255.255.255.0',
+        }
+
+Here the whole 10.42.42.0/24 can connect.
+
+#### Customize privileges
+For privileges customization there is the 'mysql\_privileges' parameter.
 
         mysql::grant { 'db1':
-          mysql_privileges => 'ALL',
-          mysql_password => 'pwd',
-          mysql_db => 'db1',
-          mysql_user => 'db1',
-          mysql_host => 'host',
+          mysql_username   => 'myusername',
+          mysql_password   => 'mypassword',
+          mysql_privileges => 'SELECT',
+        }
+
+The default grant privileges is 'ALL'.
+
+#### Remove GRANT
+Like for standard puppet resource you can use the 'ensure' parameter in order to remove a grant.
+
+        mysql::grant { 'db1':
+          ensure         => 'absent',
+          mysql_username => 'myusername',
+          mysql_password => 'mypassword',
+        }
+
+This will ensure the 'myusername@localhost' grant is absent but not the database.
+
+#### Load initial data
+The mysql\_db\_init\_query\_file is an optional parameter allowing to specify a sql file. The execution of this SQL file will be triger only once at the creation time.
+
+        mysql::grant { 'db1':
+          ensure                   => 'absent',
+          mysql_username           => 'myusername',
+          mysql_password           => 'mypassword',
           mysql_db_init_query_file => '/full/path/to/the/schema.sql',
         }
 
+__NOTE__: The SQL file should already be uploaded on mysql server host.
 
 ## USAGE - Basic management
 
@@ -78,10 +124,10 @@ For detailed info about the logic and usage patterns of Example42 modules read R
 
 
 ## USAGE - Overrides and Customizations
-* Use custom sources for main config file 
+* Use custom sources for main config file
 
         class { "mysql":
-          source => [ "puppet:///modules/lab42/mysql/mysql.conf-${hostname}" , "puppet:///modules/lab42/mysql/mysql.conf" ], 
+          source => [ "puppet:///modules/lab42/mysql/mysql.conf-${hostname}" , "puppet:///modules/lab42/mysql/mysql.conf" ],
         }
 
 
@@ -92,17 +138,17 @@ For detailed info about the logic and usage patterns of Example42 modules read R
           source_dir_purge => false, # Set to true to purge any existing file not present in $source_dir
         }
 
-* Use custom template for main config file 
+* Use custom template for main config file
 
         class { "mysql":
-          template => "example42/mysql/mysql.conf.erb",      
+          template => "example42/mysql/mysql.conf.erb",
         }
 
 * Define custom options that can be used in a custom template without the
   need to add parameters to the mysql class
 
         class { "mysql":
-          template => "example42/mysql/mysql.conf.erb",    
+          template => "example42/mysql/mysql.conf.erb",
           options  => {
             'LogLevel' => 'INFO',
             'UsePAM'   => 'yes',
@@ -116,20 +162,20 @@ For detailed info about the logic and usage patterns of Example42 modules read R
         }
 
 
-## USAGE - Example42 extensions management 
+## USAGE - Example42 extensions management
 * Activate puppi (recommended, but disabled by default)
   Note that this option requires the usage of Example42 puppi module
 
-        class { "mysql": 
+        class { "mysql":
           puppi    => true,
         }
 
 * Activate puppi and use a custom puppi_helper template (to be provided separately with
-  a puppi::helper define ) to customize the output of puppi commands 
+  a puppi::helper define ) to customize the output of puppi commands
 
         class { "mysql":
           puppi        => true,
-          puppi_helper => "myhelper", 
+          puppi_helper => "myhelper",
         }
 
 * Activate automatic monitoring (recommended, but disabled by default)
@@ -140,10 +186,10 @@ For detailed info about the logic and usage patterns of Example42 modules read R
           monitor_tool => [ "nagios" , "monit" , "munin" ],
         }
 
-* Activate automatic firewalling 
+* Activate automatic firewalling
   This option requires the usage of Example42 firewall and relevant firewall tools modules
 
-        class { "mysql":       
+        class { "mysql":
           firewall      => true,
           firewall_tool => "iptables",
           firewall_src  => "10.42.0.0/24",