initial commit
Change-Id: I3ef2ec17155991b83f34344a96f9c543f47d2f29
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..a1bec6b
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,181 @@
+
+===================
+xtrabackup formula
+===================
+
+Xtrabackup allows you to backup and restore databases from full backups or full backups and its incrementals.
+
+
+Sample pillars
+==============
+
+Backup client with ssh/rsync remote host
+
+.. code-block:: yaml
+
+ xtrabackup:
+ client:
+ enabled: true
+ full_backups_to_keep: 3
+ hours_before_full: 48
+ hours_before_incr: 12
+ database:
+ user: username
+ password: password
+ target:
+ host: cfg01
+
+ .. note:: full_backups_to_keep param states how many backup will be stored locally on xtrabackup client.
+ More options to relocate local backups can be done using salt-formula-backupninja.
+
+
+Backup client with local backup only
+
+.. code-block:: yaml
+
+ xtrabackup:
+ client:
+ enabled: true
+ full_backups_to_keep: 3
+ hours_before_full: 48
+ hours_before_incr: 12
+ database:
+ user: username
+ password: password
+
+ .. note:: full_backups_to_keep param states how many backup will be stored locally on xtrabackup client
+
+
+Backup client with ssh/rsync remote host with compression:
+
+.. code-block:: yaml
+
+ xtrabackup:
+ client:
+ enabled: true
+ full_backups_to_keep: 3
+ hours_before_full: 48
+ hours_before_incr: 12
+ compression: true
+ compression_threads: 2
+ database:
+ user: username
+ password: password
+ target:
+ host: cfg01
+
+ .. note:: More options to relocate local backups can be done using salt-formula-backupninja.
+
+
+Backup server rsync
+
+.. code-block:: yaml
+
+ xtrabackup:
+ server:
+ enabled: true
+ hours_before_full: 48
+ full_backups_to_keep: 5
+ key:
+ xtrabackup_pub_key:
+ enabled: true
+ key: key
+
+ .. note:: hours_before_full param should have the same value as is stated on xtrabackup client
+
+
+Client restore from local backups:
+
+.. code-block:: yaml
+
+ xtrabackup:
+ client:
+ enabled: true
+ full_backups_to_keep: 5
+ hours_before_full: 48
+ hours_before_incr: 12
+ restore_full_latest: 1
+ restore_from: local
+ compression: true
+ compressThreads: 2
+ database:
+ user: username
+ password: password
+ target:
+ host: cfg01
+ qpress:
+ source: tar
+ name: url
+
+ .. note:: restore_full_latest param with a value of 1 means to restore db from the last full backup and its increments. 2 would mean to restore second latest full backup and its increments
+
+
+Client restore from remote backups:
+
+.. code-block:: yaml
+
+ xtrabackup:
+ client:
+ enabled: true
+ full_backups_to_keep: 5
+ hours_before_full: 48
+ hours_before_incr: 12
+ restore_full_latest: 1
+ restore_from: remote
+ compression: true
+ compressThreads: 2
+ database:
+ user: username
+ password: password
+ target:
+ host: cfg01
+ qpress:
+ source: tar
+ name: url
+
+ .. note:: restore_full_latest param with a value of 1 means to restore db from the last full backup and its increments. 2 would mean to restore second latest full backup and its increments
+
+
+More information
+================
+
+* https://labs.riseup.net/code/projects/xtrabackup/wiki/Configuration
+* http://www.debian-administration.org/articles/351
+* http://duncanlock.net/blog/2013/08/27/comprehensive-linux-backups-with-etckeeper-xtrabackup/
+* https://github.com/riseuplabs/puppet-xtrabackup
+* http://www.ushills.co.uk/2008/02/backup-with-xtrabackup.html
+
+
+Documentation and Bugs
+======================
+
+To learn how to install and update salt-formulas, consult the documentation
+available online at:
+
+ http://salt-formulas.readthedocs.io/
+
+In the unfortunate event that bugs are discovered, they should be reported to
+the appropriate issue tracker. Use Github issue tracker for specific salt
+formula:
+
+ https://github.com/salt-formulas/salt-formula-xtrabackup/issues
+
+For feature requests, bug reports or blueprints affecting entire ecosystem,
+use Launchpad salt-formulas project:
+
+ https://launchpad.net/salt-formulas
+
+You can also join salt-formulas-users team and subscribe to mailing list:
+
+ https://launchpad.net/~salt-formulas-users
+
+Developers wishing to work on the salt-formulas projects should always base
+their work on master branch and submit pull request against specific formula.
+
+ https://github.com/salt-formulas/salt-formula-xtrabackup
+
+Any questions or feedback is always welcome so feel free to join our IRC
+channel:
+
+ #salt-formulas @ irc.freenode.net
+