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 EB814617FF for ; Thu, 9 Jul 2020 14:59:59 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id DD31B12EC3 for ; Thu, 9 Jul 2020 14:59:29 +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 BEC7E12EA5 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 8C9E74449C for ; Thu, 9 Jul 2020 14:59:28 +0200 (CEST) From: Stoiko Ivanov To: pbs-devel@lists.proxmox.com Date: Thu, 9 Jul 2020 12:59:14 +0000 Message-Id: <20200709125915.23270-2-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 1/2] docs: add remotes and sync-jobs and schedules 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 13:00:00 -0000 Signed-off-by: Stoiko Ivanov --- docs/administration-guide.rst | 58 +++++++++++++++++++++++++++++++++++ docs/glossary.rst | 16 ++++++++++ 2 files changed, 74 insertions(+) diff --git a/docs/administration-guide.rst b/docs/administration-guide.rst index ae14ac4b..37a716c6 100644 --- a/docs/administration-guide.rst +++ b/docs/administration-guide.rst @@ -340,6 +340,64 @@ following roles exist: Is allowed to read data from a remote. +:term:`Remote` +~~~~~~~~~~~~~~ + +A remote is a different Proxmox Backup Server installation and a user on that +installation, from which you can `sync` datastores to a local datastore with a +`Sync Job`. + +For adding a remote you need its hostname or ip, a userid and password on the +remote and its certificate fingerprint to add it. To get the fingerprint use +the ``proxmox-backup-manager cert info`` command on the remote. + +.. code-block:: console + + # proxmox-backup-manager cert info |grep Fingerprint + Fingerprint (sha256): 64:d3:ff:3a:50:38:53:5a:9b:f7:50:...:ab:fe + +With the needed information add the remote with: + +.. code-block:: console + + # proxmox-backup-manager remote create pbs2 --host pbs2.mydomain.example --userid sync@pam --password 'SECRET' --fingerprint 64:d3:ff:3a:50:38:53:5a:9b:f7:50:...:ab:fe + +Use the ``list``, ``show``, ``update``, ``remove`` subcommands of +``proxmox-backup-manager remote`` to manage your remotes: + +.. code-block:: console + + # proxmox-backup-manager remote update pbs2 --host pbs2.example + # proxmox-backup-manager remote list + ┌──────┬──────────────┬──────────┬───────────────────────────────────────────┬─────────┐ + │ name │ host │ userid │ fingerprint │ comment │ + ╞══════╪══════════════╪══════════╪═══════════════════════════════════════════╪═════════╡ + │ pbs2 │ pbs2.example │ sync@pam │64:d3:ff:3a:50:38:53:5a:9b:f7:50:...:ab:fe │ │ + └──────┴──────────────┴──────────┴───────────────────────────────────────────┴─────────┘ + # proxmox-backup-manager remote remove pbs2 + + +Sync Jobs +~~~~~~~~~ + +Sync jobs are configured to pull the contents of a datastore on a `Remote` to a +local datastore. You can either start the sync job manually on the GUI or +provide it with a :term:`schedule` to run regularly. The +``proxmox-backup-manager sync-job`` command is used to manage sync jobs: + +.. code-block:: console + + # proxmox-backup-manager sync-job create pbs2-local --remote pbs2 --remote-store local --store local --schedule 'Wed 02:30' + # proxmox-backup-manager sync-job update pbs2-local --comment 'offsite' + # proxmox-backup-manager sync-job list + ┌────────────┬───────┬────────┬──────────────┬───────────┬─────────┐ + │ id │ store │ remote │ remote-store │ schedule │ comment │ + ╞════════════╪═══════╪════════╪══════════════╪═══════════╪═════════╡ + │ pbs2-local │ local │ pbs2 │ local │ Wed 02:30 │ offsite │ + └────────────┴───────┴────────┴──────────────┴───────────┴─────────┘ + # proxmox-backup-manager sync-job remove pbs2-local + + Backup Client usage ------------------- diff --git a/docs/glossary.rst b/docs/glossary.rst index 78a78d91..b831bea3 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -46,3 +46,19 @@ Glossary kernel driver handles filesystem requests and sends them to a userspace application. + Remote + + A remote Proxmox Backup Server installation and credentials for a user on it. + You can pull datastores from a remote to a local datastore in order to + have redundant backups. + + Schedule + + Certain tasks, for example pruning and garbage collection, need to be + performed on a regular basis. Proxmox Backup Server uses a subset of the + `systemd Time and Date Specification + `_. + The subset currently supports time of day specifications and weekdays, in + addition to the shorthand expressions 'minutely', 'hourly', 'daily'. + There is no support for specifying timezones, the tasks are run in the + timezone configured on the server. -- 2.20.1