docs: tape screenshots
Add tape screenshots throughout the tape docs with some references to the GUI Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
BIN
docs/images/screenshots/pbs-gui-tape-backup-jobs-add.png
Normal file
After Width: | Height: | Size: 28 KiB |
BIN
docs/images/screenshots/pbs-gui-tape-backup-jobs.png
Normal file
After Width: | Height: | Size: 75 KiB |
BIN
docs/images/screenshots/pbs-gui-tape-changer-overview.png
Normal file
After Width: | Height: | Size: 121 KiB |
BIN
docs/images/screenshots/pbs-gui-tape-changers-add.png
Normal file
After Width: | Height: | Size: 12 KiB |
BIN
docs/images/screenshots/pbs-gui-tape-changers.png
Normal file
After Width: | Height: | Size: 79 KiB |
BIN
docs/images/screenshots/pbs-gui-tape-crypt-keys.png
Normal file
After Width: | Height: | Size: 72 KiB |
BIN
docs/images/screenshots/pbs-gui-tape-drives-add.png
Normal file
After Width: | Height: | Size: 13 KiB |
BIN
docs/images/screenshots/pbs-gui-tape-drives.png
Normal file
After Width: | Height: | Size: 112 KiB |
BIN
docs/images/screenshots/pbs-gui-tape-pools-add.png
Normal file
After Width: | Height: | Size: 18 KiB |
BIN
docs/images/screenshots/pbs-gui-tape-pools.png
Normal file
After Width: | Height: | Size: 70 KiB |
@ -6,6 +6,10 @@ Tape Backup
|
||||
.. CAUTION:: Tape Backup is a technical preview feature, not meant for
|
||||
production use.
|
||||
|
||||
.. image:: images/screenshots/pbs-gui-tape-changer-overview.png
|
||||
:align: right
|
||||
:alt: Tape Backup: Tape changer overview
|
||||
|
||||
Proxmox tape backup provides an easy way to store datastore content
|
||||
onto magnetic tapes. This increases data safety because you get:
|
||||
|
||||
@ -54,7 +58,7 @@ In general, LTO tapes offer the following advantages:
|
||||
- Cold Media
|
||||
- Movable (storable inside vault)
|
||||
- Multiple vendors (for both media and drives)
|
||||
- Build in AES-GCM Encryption engine
|
||||
- Built in AES-GCM Encryption engine
|
||||
|
||||
Note that `Proxmox Backup Server` already stores compressed data, so using the
|
||||
tape compression feature has no advantage.
|
||||
@ -71,8 +75,8 @@ so all modern tape libraries should work.
|
||||
|
||||
.. Note:: We use a custom user space tape driver written in Rust_. This
|
||||
driver directly communicates with the tape drive using the SCSI
|
||||
generic interface. This may have bad side effects to the old Linux
|
||||
kernel tape driver, so you should not use that driver while using
|
||||
generic interface. This may have negative side effects when used with the old
|
||||
Linux kernel tape driver, so you should not use that driver with
|
||||
Proxmox tape backup.
|
||||
|
||||
|
||||
@ -83,7 +87,7 @@ Current LTO-8 tapes provide read/write speeds of up to 360 MB/s. This means,
|
||||
that it still takes a minimum of 9 hours to completely write or
|
||||
read a single tape (even at maximum speed).
|
||||
|
||||
The only way to speed up that data rate is to use more than one
|
||||
The only way to speed that data rate up is to use more than one
|
||||
drive. That way, you can run several backup jobs in parallel, or run
|
||||
restore jobs while the other dives are used for backups.
|
||||
|
||||
@ -92,7 +96,7 @@ Also consider that you first need to read data from your datastore
|
||||
rate. We measured a maximum rate of about 60MB/s to 100MB/s in practice,
|
||||
so it takes 33 hours to read the 12TB needed to fill up an LTO-8 tape. If you want
|
||||
to write to your tape at full speed, please make sure that the source
|
||||
datastore is able to deliver that performance (e.g, by using SSDs).
|
||||
datastore is able to deliver that performance (for example, by using SSDs).
|
||||
|
||||
|
||||
Terminology
|
||||
@ -175,6 +179,10 @@ same configuration.
|
||||
Tape changers
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
.. image:: images/screenshots/pbs-gui-tape-changers.png
|
||||
:align: right
|
||||
:alt: Tape Backup: Tape Changers
|
||||
|
||||
Tape changers (robots) are part of a `Tape Library`_. You can skip
|
||||
this step if you are using a standalone drive.
|
||||
|
||||
@ -203,6 +211,13 @@ Where ``sl3`` is an arbitrary name you can choose.
|
||||
``/dev/tape/by-id/``. Names like ``/dev/sg0`` may point to a
|
||||
different device after reboot, and that is not what you want.
|
||||
|
||||
.. image:: images/screenshots/pbs-gui-tape-changers-add.png
|
||||
:align: right
|
||||
:alt: Tape Backup: Add a new tape changer
|
||||
|
||||
This operation can also be carried out from the GUI, by navigating to the
|
||||
**Changers** tab of **Tape Backup** and clicking **Add**.
|
||||
|
||||
You can display the final configuration with:
|
||||
|
||||
.. code-block:: console
|
||||
@ -216,7 +231,8 @@ You can display the final configuration with:
|
||||
│ path │ /dev/tape/by-id/scsi-CC2C52 │
|
||||
└──────┴─────────────────────────────┘
|
||||
|
||||
Or simply list all configured changer devices:
|
||||
Or simply list all configured changer devices (as seen in the **Changers** tab
|
||||
of the GUI):
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
@ -227,7 +243,7 @@ Or simply list all configured changer devices:
|
||||
│ sl3 │ /dev/tape/by-id/scsi-CC2C52 │ Quantum │ Superloader3 │ CC2C52 │
|
||||
└──────┴─────────────────────────────┴─────────┴──────────────┴────────────┘
|
||||
|
||||
The Vendor, Model and Serial number are auto detected, but only shown
|
||||
The Vendor, Model and Serial number are auto-detected, but only shown
|
||||
if the device is online.
|
||||
|
||||
To test your setup, please query the status of the changer device with:
|
||||
@ -265,7 +281,7 @@ the status output.
|
||||
|
||||
As a workaround, you can mark some of the normal slots as export
|
||||
slot. The software treats those slots like real ``import-export``
|
||||
slots, and the media inside those slots is considered to be 'offline'
|
||||
slots, and the media inside those slots are considered to be 'offline'
|
||||
(not available for backup):
|
||||
|
||||
.. code-block:: console
|
||||
@ -301,6 +317,10 @@ the status output:
|
||||
Tape drives
|
||||
~~~~~~~~~~~
|
||||
|
||||
.. image:: images/screenshots/pbs-gui-tape-drives.png
|
||||
:align: right
|
||||
:alt: Tape Backup: Drive list
|
||||
|
||||
Linux is able to auto detect tape drives, and you can get a list
|
||||
of available tape drives using:
|
||||
|
||||
@ -313,8 +333,13 @@ of available tape drives using:
|
||||
│ /dev/tape/by-id/scsi-12345-sg │ IBM │ ULT3580-TD4 │ 12345 │
|
||||
└────────────────────────────────┴────────┴─────────────┴────────┘
|
||||
|
||||
.. image:: images/screenshots/pbs-gui-tape-drives-add.png
|
||||
:align: right
|
||||
:alt: Tape Backup: Add a tape drive
|
||||
|
||||
In order to use that drive with Proxmox, you need to create a
|
||||
configuration entry:
|
||||
configuration entry. This can be done through **Tape Backup -> Drives** in the
|
||||
GUI or by using the command below:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
@ -364,7 +389,7 @@ To list all configured drives use:
|
||||
│ mydrive │ /dev/tape/by-id/scsi-12345-sg │ sl3 │ IBM │ ULT3580-TD4 │ 12345 │
|
||||
└──────────┴────────────────────────────────┴─────────┴────────┴─────────────┴────────┘
|
||||
|
||||
The Vendor, Model and Serial number are auto detected, but only shown
|
||||
The Vendor, Model and Serial number are auto detected and only shown
|
||||
if the device is online.
|
||||
|
||||
For testing, you can simply query the drive status with:
|
||||
@ -389,8 +414,12 @@ For testing, you can simply query the drive status with:
|
||||
Media Pools
|
||||
~~~~~~~~~~~
|
||||
|
||||
.. image:: images/screenshots/pbs-gui-tape-pools.png
|
||||
:align: right
|
||||
:alt: Tape Backup: Media Pools
|
||||
|
||||
A media pool is a logical container for tapes. A backup job targets
|
||||
one media pool, so a job only uses tapes from that pool.
|
||||
a single media pool, so a job only uses tapes from that pool.
|
||||
|
||||
.. topic:: Media Set
|
||||
|
||||
@ -509,8 +538,12 @@ one media pool, so a job only uses tapes from that pool.
|
||||
if the sources are from different namespaces with conflicting names
|
||||
(for example, if the sources are from different Proxmox VE clusters).
|
||||
|
||||
.. image:: images/screenshots/pbs-gui-tape-pools-add.png
|
||||
:align: right
|
||||
:alt: Tape Backup: Add a media pool
|
||||
|
||||
The following command creates a new media pool:
|
||||
To create a new media pool, add one from **Tape Backup -> Media Pools** in the
|
||||
GUI, or enter the following command:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
@ -519,7 +552,7 @@ The following command creates a new media pool:
|
||||
# proxmox-tape pool create daily --drive mydrive
|
||||
|
||||
|
||||
Additional option can be set later, using the update command:
|
||||
Additional options can be set later, using the update command:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
@ -542,6 +575,10 @@ To list all configured pools use:
|
||||
Tape Backup Jobs
|
||||
~~~~~~~~~~~~~~~~
|
||||
|
||||
.. image:: images/screenshots/pbs-gui-tape-backup-jobs.png
|
||||
:align: right
|
||||
:alt: Tape Backup: Tape Backup Jobs
|
||||
|
||||
To automate tape backup, you can configure tape backup jobs which
|
||||
write datastore content to a media pool, based on a specific time schedule.
|
||||
The required settings are:
|
||||
@ -617,6 +654,14 @@ To remove a job, please use:
|
||||
|
||||
# proxmox-tape backup-job remove job2
|
||||
|
||||
.. image:: images/screenshots/pbs-gui-tape-backup-jobs-add.png
|
||||
:align: right
|
||||
:alt: Tape Backup: Add a backup job
|
||||
|
||||
This same functionality also exists in the GUI, under the **Backup Jobs** tab of
|
||||
**Tape Backup**, where *Local Datastore* relates to the datastore you want to
|
||||
backup and *Media Pool* is the pool to back up to.
|
||||
|
||||
|
||||
Administration
|
||||
--------------
|
||||
@ -632,7 +677,7 @@ variable:
|
||||
|
||||
You can then omit the ``--drive`` parameter from the command. If the
|
||||
drive has an associated changer device, you may also omit the changer
|
||||
parameter from commands that needs a changer device, for example:
|
||||
parameter from commands that need a changer device, for example:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
@ -706,7 +751,7 @@ can then label all unlabeled tapes with a single command:
|
||||
Run Tape Backups
|
||||
~~~~~~~~~~~~~~~~
|
||||
|
||||
To manually run a backup job use:
|
||||
To manually run a backup job click *Run Now* in the GUI or use the command:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
@ -771,7 +816,14 @@ Restore Catalog
|
||||
Encryption Key Management
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Creating a new encryption key:
|
||||
.. image:: images/screenshots/pbs-gui-tape-crypt-keys.png
|
||||
:align: right
|
||||
:alt: Tape Backup: Encryption Keys
|
||||
|
||||
Proxmox Backup Server also provides an interface for handling encryption keys on
|
||||
the backup server. Encryption keys can be managed from the **Tape Backup ->
|
||||
Encryption Keys** section of the GUI or through the ``proxmox-tape key`` command
|
||||
line tool. To create a new encryption key from the command line:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
|