From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id C6EE3617FA for ; Thu, 9 Jul 2020 14:59:58 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id BBA0512EA4 for ; Thu, 9 Jul 2020 14:59:28 +0200 (CEST) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [212.186.127.180]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS id 08BFF12E99 for ; Thu, 9 Jul 2020 14:59:28 +0200 (CEST) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id C6E7F4449C for ; Thu, 9 Jul 2020 14:59:27 +0200 (CEST) From: Stoiko Ivanov To: pbs-devel@lists.proxmox.com Date: Thu, 9 Jul 2020 12:59:15 +0000 Message-Id: <20200709125915.23270-3-s.ivanov@proxmox.com> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200709125915.23270-1-s.ivanov@proxmox.com> References: <20200709125915.23270-1-s.ivanov@proxmox.com> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment RCVD_IN_DNSWL_MED -2.3 Sender listed at https://www.dnswl.org/, medium trust SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Subject: [pbs-devel] [PATCH proxmox-backup 2/2] docs: expand datastore documentation X-BeenThere: pbs-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Backup Server development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 09 Jul 2020 12:59:58 -0000 document retention settings and schedules per datastore with some minimal examples. Signed-off-by: Stoiko Ivanov --- 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 ` and +:ref:`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