docs: add remotes and sync-jobs and schedules
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
This commit is contained in:
parent
62f6a7e3d9
commit
9634ca07db
|
@ -340,6 +340,64 @@ following roles exist:
|
||||||
Is allowed to read data from a remote.
|
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
|
Backup Client usage
|
||||||
-------------------
|
-------------------
|
||||||
|
|
||||||
|
|
|
@ -46,3 +46,19 @@ Glossary
|
||||||
kernel driver handles filesystem requests and sends them to a
|
kernel driver handles filesystem requests and sends them to a
|
||||||
userspace application.
|
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
|
||||||
|
<https://www.freedesktop.org/software/systemd/man/systemd.time.html#>`_.
|
||||||
|
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.
|
||||||
|
|
Loading…
Reference in New Issue