From: Stoiko Ivanov <s.ivanov@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH proxmox-backup 2/2] docs: expand datastore documentation
Date: Thu, 9 Jul 2020 12:59:15 +0000 [thread overview]
Message-ID: <20200709125915.23270-3-s.ivanov@proxmox.com> (raw)
In-Reply-To: <20200709125915.23270-1-s.ivanov@proxmox.com>
document retention settings and schedules per datastore with
some minimal examples.
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
---
docs/administration-guide.rst | 33 ++++++++++++++++++++++++++++++++-
1 file changed, 32 insertions(+), 1 deletion(-)
diff --git a/docs/administration-guide.rst b/docs/administration-guide.rst
index 37a716c6..165633a7 100644
--- a/docs/administration-guide.rst
+++ b/docs/administration-guide.rst
@@ -146,7 +146,12 @@ Datastore Configuration
You can configure multiple datastores. Minimum one datastore needs to be
configured. The datastore is identified by a simple `name` and points to a
-directory on the filesystem.
+directory on the filesystem. Each datastore also has associated retention
+settings of how many backup snapshots for each interval of ``hourly``,
+``daily``, ``weekly``, ``monthly``, ``yearly`` as well as an time independent
+number of backups to keep in that store. :ref:`Pruning <pruning>` and
+:ref:`garbage collection <garbage-collection>` can also be configured to run
+periodically based on a configured :term:`schedule` per datastore.
The following command creates a new datastore called ``store1`` on :file:`/backup/disk1/store1`
@@ -165,6 +170,30 @@ To list existing datastores run:
│ store1 │ /backup/disk1/store1 │ This is my default storage. │
└────────┴──────────────────────┴─────────────────────────────┘
+You can change settings of a datastore, for example to set a prune and garbage
+collection schedule or retention settings using ``update`` subcommand and view
+a datastore with the ``show`` subcommand:
+
+.. code-block:: console
+
+ # proxmox-backup-manager datastore update store1 --keep-last 7 --prune-schedule daily --gc-schedule 'Tue 04:27'
+ # proxmox-backup-manager datastore show store1
+ ┌────────────────┬─────────────────────────────┐
+ │ Name │ Value │
+ ╞════════════════╪═════════════════════════════╡
+ │ name │ store1 │
+ ├────────────────┼─────────────────────────────┤
+ │ path │ /backup/disk1/store1 │
+ ├────────────────┼─────────────────────────────┤
+ │ comment │ This is my default storage. │
+ ├────────────────┼─────────────────────────────┤
+ │ gc-schedule │ Tue 04:27 │
+ ├────────────────┼─────────────────────────────┤
+ │ keep-last │ 7 │
+ ├────────────────┼─────────────────────────────┤
+ │ prune-schedule │ daily │
+ └────────────────┴─────────────────────────────┘
+
Finally, it is possible to remove the datastore configuration:
.. code-block:: console
@@ -822,6 +851,8 @@ To remove the ticket, issue a logout:
# proxmox-backup-client logout
+.. _pruning:
+
Pruning and Removing Backups
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
--
2.20.1
next prev parent reply other threads:[~2020-07-09 12:59 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-07-09 12:59 [pbs-devel] [PATCH proxmox-backup 0/3] add minimal documentation on schedules, remotes and sync jobs Stoiko Ivanov
2020-07-09 12:59 ` [pbs-devel] [PATCH proxmox-backup 1/2] docs: add remotes and sync-jobs and schedules Stoiko Ivanov
2020-07-09 12:59 ` Stoiko Ivanov [this message]
2020-07-09 13:06 ` [pbs-devel] applied-series: Re: [PATCH proxmox-backup 0/3] add minimal documentation on schedules, remotes and sync jobs Thomas Lamprecht
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200709125915.23270-3-s.ivanov@proxmox.com \
--to=s.ivanov@proxmox.com \
--cc=pbs-devel@lists.proxmox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox