Permalink
Browse files

update documentation for before/after/failed backup commands

  • Loading branch information...
1 parent cdffeed commit 885780894cdd34c24b5f800944c63109ecb83195 @abg abg committed Jan 9, 2013
Showing with 6 additions and 6 deletions.
  1. +6 −6 docs/source/config.rst
View
@@ -143,7 +143,7 @@ put the following at the top of the backup set configuration file::
Either ``holland purge`` must be run externally or an explicit removal of
desired backup directories can be done at some later time.
-**pre-backup-command** = string
+**before-backup-command** = string
Run a shell command before a backup starts. This allows some command to
perform some action before the backup starts such as setting up an
@@ -154,7 +154,7 @@ put the following at the top of the backup set configuration file::
.. versionadded:: 1.0.7
-**post-backup-command** = string
+**after-backup-command** = string
Run a shell command before a backup starts. This allows some command to
perform some action when a backup completes successfully such as sending
@@ -164,7 +164,7 @@ put the following at the top of the backup set configuration file::
.. versionadded:: 1.0.7
-**backup-failure-command** = string
+**failed-backup-command** = string
Run a shell command before a backup starts. This allows some command to
perform some action when a backup fails such as sending out a failure
@@ -176,16 +176,16 @@ put the following at the top of the backup set configuration file::
For all hook commands, Holland will perform simple text substitution substitution
on the three parameters:
- * hook - name of the hook being called (one of: pre-backup-command, post-backup-command, backup-failure-command)
+ * hook - name of the hook being called (one of: before-backup-command, after-backup-command, failed-backup-command)
* backupdir - path to the current backup directory (e.g. /var/spool/holland/mysqldump/YYYYmmdd_HHMMSS)
* backupset - name of the backupset being run (e.g. 'mysql-lvm')
For example::
[holland:backup]
plugin = mysqldump
- pre-backup-command = /usr/local/bin/my-custom-script --hook ${hook} --backupset ${backupset} --backupdir ${backupdir}
- post-backup-command = echo ${backupset} completed successfully. Files are in ${backupdir}
+ before-backup-command = /usr/local/bin/my-custom-script --hook ${hook} --backupset ${backupset} --backupdir ${backupdir}
+ after-backup-command = echo ${backupset} completed successfully. Files are in ${backupdir}
[mysqldump]
...

0 comments on commit 8857808

Please sign in to comment.