README update
Change-Id: I617ae6380e15383ff9288871cbbef8206fbbecb6
diff --git a/README.rst b/README.rst
index 6a003ea..d34e14e 100644
--- a/README.rst
+++ b/README.rst
@@ -1,15 +1,15 @@
===================
-xtrabackup formula
+Usage
===================
-Xtrabackup allows you to backup and restore databases from full backups or full backups and its incrementals.
-
+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
+Backup client with ssh/rsync remote host:
.. code-block:: yaml
@@ -25,11 +25,11 @@
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.
+.. note:: The ``full_backups_to_keep`` parameter 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
+Backup client with local backup only:
.. code-block:: yaml
@@ -43,10 +43,11 @@
user: username
password: password
- .. note:: full_backups_to_keep param states how many backup will be stored locally on xtrabackup client
+.. note:: The ``full_backups_to_keep`` parameter states how many backup will
+ be stored locally on xtrabackup client.
-
-Backup client with ssh/rsync to remote host with compression and non-default backup directory on server:
+Backup client with ssh/rsync to remote host with compression and non-default
+backup directory on server:
.. code-block:: yaml
@@ -67,15 +68,15 @@
enabled: false
backup_dir: /srv/backup
- .. note:: More options to relocate local backups can be done using salt-formula-backupninja.
+.. note:: More options to relocate local backups can be done using
+ ``salt-formula-backupninja``.
- .. note:: If the ``server`` section is ommited backups will be made to
- default location, same on both client and server side.
-
+.. note:: If the ``server`` section is ommited, backups will be made to
+ default location, same on both client and server side.
Backup client at exact times:
-..code-block:: yaml
+.. code-block:: yaml
xtrabackup:
client:
@@ -95,23 +96,31 @@
target:
host: host01
- .. note:: Parameters in ``backup_times`` section can be used to set up exact
- time the cron job should be executed. In this example, the backup job
- would be executed every Sunday at 4:52 AM. If any of the individual
- ``backup_times`` parameters is not defined, the defalut ``*`` value will be
- used. For example, if minute parameter is ``*``, it will run the backup every minute,
- which is ususally not desired.
- Available parameters are ``day_of_week``, ``day_of_month``, ``month``, ``hour`` and ``minute``.
- Please see the crontab reference for further info on how to set these parameters.
+.. note:: Parameters in ``backup_times`` section can be used to set up exact
+ time the cron job should be executed. In this example, the backup job
+ would be executed every Sunday at 4:52 AM. If any of the individual
+ ``backup_times`` parameters is not defined, the defalut ``*`` value will
+ be used. For example, if minute parameter is ``*``, it will run the backup
+ every minute, which is ususally not desired.
- .. note:: Please be aware that only ``backup_times`` section OR
- ``hours_before_full(incr)`` can be defined. If both are defined, The
- ``backup_times`` section will be peferred.
+ Available parameters include:
- .. note:: New parameter ``incr_before_full`` needs to be defined. This
- number sets number of incremental backups to be run, before a full backup
- is performed.
+ * ``day_of_week``
+ * ``day_of_month``
+ * ``month``
+ * ``hour``
+ * ``minute``.
+ See the crontab reference for further info on how to set these
+ parameters.
+
+.. note:: Please be aware that only ``backup_times`` section OR
+ ``hours_before_full(incr)`` can be defined. If both are defined. The
+ ``backup_times`` section will be peferred.
+
+.. note:: New parameter ``incr_before_full`` needs to be defined. This
+ number sets number of incremental backups to be run, before a full backup
+ is performed.
Backup server rsync and non-default backup directory:
@@ -128,13 +137,13 @@
key: key
backup_dir: /srv/backup
- .. note:: hours_before_full param should have the same value as is stated on xtrabackup client
+.. note:: The ``hours_before_full`` parameter should have the same value as
+ is stated on xtrabackup client
- .. note:: If the ``backup_dir`` argument is ommited backups will be made to
- default location, same on both client and server side.
+.. note:: If the ``backup_dir`` argument is ommited backups will be made to
+ default location, same on both client and server side.
-
-Backup server without strict client restriction
+Backup server without strict client restriction:
.. code-block:: yaml
@@ -142,10 +151,9 @@
server:
restrict_clients: false
-
Backup server at exact times:
-..code-block:: yaml
+.. code-block:: yaml
xtrabackup:
server:
@@ -162,21 +170,22 @@
enabled: true
key: key
- .. note:: Parameters in ``backup_times`` section can be used to set up exact
- time the cron job should be executed. In this example, the backup job
- would be executed every Sunday at 4:52 AM. If any of the individual
- ``backup_times`` parameters is not defined, the defalut ``*`` value will be
- used. For example, if minute parameter is ``*``, it will run the backup every minute,
- which is ususally not desired.
- Please see the crontab reference for further info on how to set these parameters.
+.. note:: Parameters in ``backup_times`` section can be used to set up exact
+ time the cron job should be executed. In this example, the backup job
+ would be executed every Sunday at 4:52 AM. If any of the individual
+ ``backup_times`` parameters is not defined, the defalut ``*`` value will
+ be used. For example, if minute parameter is ``*``, it will run the backup
+ every minute, which is ususally not desired.
- .. note:: Please be aware that only ``backup_times`` section OR
- ``hours_before_full(incr)`` can be defined. If both are defined, The
- ``backup_times`` section will be peferred.
+ See the crontab reference for further info on how to set these parameters.
- .. note:: New parameter ``incr_before_full`` needs to be defined. This
- number sets number of incremental backups to be run, before a full backup
- is performed.
+.. note:: Please be aware that only ``backup_times`` section OR
+ ``hours_before_full(incr)`` can be defined. If both are defined. The
+ ``backup_times`` section will be peferred.
+
+.. note:: New parameter ``incr_before_full`` needs to be defined. This
+ number sets number of incremental backups to be run, before a full backup
+ is performed.
Client restore from local backups:
@@ -201,8 +210,9 @@
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
-
+.. 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:
@@ -227,11 +237,12 @@
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
+.. note:: The ``restore_full_latest`` parameter 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
-================
+Read more
+=========
* https://labs.riseup.net/code/projects/xtrabackup/wiki/Configuration
* http://www.debian-administration.org/articles/351
@@ -239,37 +250,29 @@
* 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/
+ Learn how to install and update salt-formulas
- http://salt-formulas.readthedocs.io/
+* https://github.com/salt-formulas/salt-formula-xtrabackup/issues
+ In the unfortunate event that bugs are discovered, report the issue to the
+ appropriate issue tracker. Use the Github issue tracker for a specific salt
+ formula
-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://launchpad.net/salt-formulas
+ For feature requests, bug reports, or blueprints affecting the entire
+ ecosystem, use the Launchpad salt-formulas project
- https://github.com/salt-formulas/salt-formula-xtrabackup/issues
+* https://launchpad.net/~salt-formulas-users
+ Join the salt-formulas-users team and subscribe to mailing list if required
-For feature requests, bug reports or blueprints affecting entire ecosystem,
-use Launchpad salt-formulas project:
+* https://github.com/salt-formulas/salt-formula-xtrabackup
+ Develop the salt-formulas projects in the master branch and then submit pull
+ requests against a specific formula
- 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
+* #salt-formulas @ irc.freenode.net
+ Use this IRC channel in case of any questions or feedback which is always
+ welcome