Add option to set exact backup times
Change-Id: I01202d79750b810d4e24571bbf0ecab11bab7398
diff --git a/README.rst b/README.rst
index f539168..ce7c1d9 100644
--- a/README.rst
+++ b/README.rst
@@ -49,6 +49,46 @@
.. note:: full_backups_to_keep param states how many backup will be stored locally on cassandra client
+Backup client at exact times:
+
+..code-block:: yaml
+
+ cassandra:
+ backup:
+ client:
+ enabled: true
+ full_backups_to_keep: 3
+ incr_before_full: 3
+ backup_times:
+ dayOfWeek: 0
+ hour: 4
+ minute: 52
+ compression: true
+ compression_threads: 2
+ database:
+ user: user
+ password: password
+ 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 ``dayOfWeek``, ``dayOfMonth``, ``month``, ``hour`` and ``minute``.
+ Please 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
.. code-block:: yaml
@@ -72,6 +112,43 @@
backup:
restrict_clients: false
+Backup server at exact times:
+
+..code-block:: yaml
+
+ cassandra:
+ backup:
+ server:
+ enabled: true
+ full_backups_to_keep: 3
+ incr_before_full: 3
+ backup_dir: /srv/backup
+ backup_times:
+ dayOfWeek: 0
+ hour: 4
+ minute: 52
+ key:
+ cassandra_pub_key:
+ 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.
+ Available parameters are ``dayOfWeek``, ``dayOfMonth``, ``month``, ``hour`` and ``minute``.
+ Please 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.
+
Client restore from local backup:
.. code-block:: yaml