Improved documentation

Modulefile

@@ -1,5 +1,5 @@
 name    'desalvo-percona'
-version '0.1.0'
+version '0.1.2'
 source 'https://github.com/desalvo/puppet-percona'
 author 'desalvo'
 license 'Apache License, Version 2.0'

README.md

@@ -12,6 +12,47 @@ Overview
 This module is intended to be used to manage the Percona XtraDB system configuration.
 [Percona XtraDB](http://www.percona.com/software/percona-xtradb) is an enhanced version of the InnoDB storage engine for MySQL® and MariaDB®.
 
+Parameters
+----------
+
+The following parameters are supported:
+
+* **mysql_version**: the Percona mysql version to be used. Currently 5.5 or 5.6 [default: 5.5]
+* **root_password**: the root password of the database [default: unset]
+* **old_passwords**: set this to true to support the old mysql 3.x hashes for the passwords [default: false]
+* **datadir**: the mysql data directory [default: /var/lib/mysql]
+* **server_id**: the server id [default: 1]
+* **skip_slave_start**: set this to true to skip the slave startup on boot [default: true]
+* **ist_recv_addr**: the IST receiver address for WSREP [default: ipaddress]
+* **wsrep_max_ws_size**: the WSREP max working set size [default: 2G]
+* **wsrep_cluster_address**: the WSREP cluster address list, like gcomm://<ip1>:4010,<ip2>:4010 [default: gcomm://]
+* **wsrep_provider**: the WSREP provider [default: libgalera_smm.so]
+* **wsrep_max_ws_rows**: the WSREP max working set rows [default: 1024000]
+* **wsrep_sst_receive_address**: the SST receiver address [default: ipaddress:4020]
+* **wsrep_slave_threads**: number of WSREP slave threads [default: 2]
+* **wsrep_sst_method**: the WSREP SST method, like rsync or xtrabackup [default: rsync]
+* **wsrep_sst_auth**: the auth string for SST, if needed [default: undef]
+* **wsrep_cluster_name**: the WSREP cluster name [default: default]
+* **binlog_format**: the binlog format [default: ROW]
+* **default_storage_engine**: the default storage engine [default: InnoDB]
+* **innodb_autoinc_lock_mode**: the innodb lock mode [default: 2]
+* **innodb_locks_unsafe_for_binlog**: set this to true if you want to use unsafe locks for the binlogs [default: 1]
+* **innodb_buffer_pool_size**: the innodb buffer pool size [default: 128M]
+* **innodb_log_file_size**: the innodb log file size [default: 256M]
+* **bulk_insert_buffer_size**: the size of the insert buffer [default: 128M]
+* **innodb_flush_log_at_trx_commit**: set this to allow flushing of logs at transaction commit [default: 2]
+* **innodb_file_per_table**: set this to true to allow using sepafate files for the innodb tablespace [default: true]
+* **innodb_file_format**: the file format for innodb [default: Barracuda]
+* **innodb_file_format_max**: the higher level of file formats for innodb [default: Barracuda]
+* **sort_buffer_size**: the size of the sort buffer [default: 64M]
+* **read_buffer_size**: the size of the read buffer [default: 64M]
+* **read_rnd_buffer_size**: the size of the rnd buffer [default: 64M]
+* **key_buffer_size**: size of keys [default: 64M]
+* **myisam_sort_buffer_size**: the myisam sort buffer size [default: 64M]
+* **thread_cache**: the number of thread caches [default: 2]
+* **query_cache_size**: the size of the query cache [default: 64M]
+* **thread_concurrency**: number of allowed concurrent threads [default: 2]
+
 Usage
 -----
 
@@ -39,6 +80,10 @@ Contributors
 Release Notes
 -------------
 
+**0.1.2**
+
+* Improved documentation
+
 **0.1.1**
 
 * Added support for Ubuntu/Debian.

manifests/init.pp

@@ -4,17 +4,14 @@
 #
 # === Parameters
 #
-# [*gcomm*]
-#   The galera wsrep_cluster_address parameters
-#
 # [*mysql_version*]
 #   The Percona mysql version to be used. Currently 5.5 or 5.6
 #
 # [*root_password*]
 #   The root password of the database
 #
 # [*old_passwords*]
-#   Set this to tru to support the old mysql 3.x hashes for the passwords
+#   Set this to true to support the old mysql 3.x hashes for the passwords
 #
 # [*datadir*]
 #   The mysql data directory, defaults to /var/lib/mysql
@@ -80,7 +77,7 @@
 #   Set this to allow flushing of logs at transaction commit
 #
 # [*innodb_file_per_table*]
-#   Set this to tru to allow using sepafate files for the innodb tablespace
+#   Set this to true to allow using sepafate files for the innodb tablespace
 #
 # [*innodb_file_format*]
 #   The file format for innodb