public inbox for pbs-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Dominik Csapak <d.csapak@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH proxmox-backup v2 13/13] docs: add info about protection flag to client docs
Date: Thu, 23 Sep 2021 13:37:39 +0200	[thread overview]
Message-ID: <20210923113739.4151043-14-d.csapak@proxmox.com> (raw)
In-Reply-To: <20210923113739.4151043-1-d.csapak@proxmox.com>

and mention that sync/pull does not sync the protected flag

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
---
 docs/backup-client.rst | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/docs/backup-client.rst b/docs/backup-client.rst
index 02dae100..f18651ef 100644
--- a/docs/backup-client.rst
+++ b/docs/backup-client.rst
@@ -652,6 +652,25 @@ shows the list of existing snapshots and what actions prune would take.
    in the chunk-store. The chunk-store still contains the data blocks. To free
    space you need to perform :ref:`client_garbage-collection`.
 
+It is also possible to protect single snapshots from being pruned or deleted:
+
+.. code-block:: console
+
+  # proxmox-backup-client snapshot protected update <snapshot> true
+
+This will set the protected flag on the snapshot and prevent pruning or manual
+deletion of this snapshot untilt he flag is removed again with:
+
+.. code-block:: console
+
+  # proxmox-backup-client snapshot protected update <snapshot> false
+
+When a group is with a protected snapshot is deleted, only the non-protected
+ones are removed and the group will remain.
+
+.. note:: This flag will not be synced when using pull or sync jobs. If you
+   want to protect a synced snapshot, you have to manually to this again on
+   the target :ref:`backup server.
 
 .. _client_garbage-collection:
 
-- 
2.30.2





      parent reply	other threads:[~2021-09-23 11:37 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-09-23 11:37 [pbs-devel] [PATCH proxmox-backup v2 00/13] add 'protected' setting for snapshots Dominik Csapak
2021-09-23 11:37 ` [pbs-devel] [PATCH proxmox-backup v2 01/13] pbs-datastore: add protection info to BackupInfo Dominik Csapak
2021-09-23 11:37 ` [pbs-devel] [PATCH proxmox-backup v2 02/13] pbs-datastore: skip protected backups in pruning Dominik Csapak
2021-09-23 11:37 ` [pbs-devel] [PATCH proxmox-backup v2 03/13] add protected info of snapshots to api and task logs Dominik Csapak
2021-09-23 11:37 ` [pbs-devel] [PATCH proxmox-backup v2 04/13] tests/prune: add tests for protecteded backups Dominik Csapak
2021-09-23 11:37 ` [pbs-devel] [PATCH proxmox-backup v2 05/13] backup/datastore: prevent protected snapshots to be removed Dominik Csapak
2021-09-23 11:37 ` [pbs-devel] [PATCH proxmox-backup v2 06/13] pull_store/group: dont try remove locally protected snapshots Dominik Csapak
2021-09-23 11:37 ` [pbs-devel] [PATCH proxmox-backup v2 07/13] api2: datastore/delete_group: throw error for partially removed group Dominik Csapak
2021-09-23 11:37 ` [pbs-devel] [PATCH proxmox-backup v2 08/13] api2/admin/datastore: add get/set_protection Dominik Csapak
2021-09-23 11:37 ` [pbs-devel] [PATCH proxmox-backup v2 09/13] proxmox-backup-client: add 'protected' commands Dominik Csapak
2021-09-23 11:37 ` [pbs-devel] [PATCH proxmox-backup v2 10/13] ui: PruneInputPanel: add keepReason 'protected' for protected backups Dominik Csapak
2021-09-23 11:37 ` [pbs-devel] [PATCH proxmox-backup v2 11/13] ui: add protected icon to snapshots Dominik Csapak
2021-09-23 11:37 ` [pbs-devel] [PATCH proxmox-backup v2 12/13] fix #3602: ui: datastore/Content: add action to set protection status Dominik Csapak
2021-09-23 11:37 ` Dominik Csapak [this message]

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=20210923113739.4151043-14-d.csapak@proxmox.com \
    --to=d.csapak@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
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal