File:Proxmox-Backup-Server-CT-File-Restore.png

2021-07-12T12:04:20Z

Martin: Martin uploaded a new version of File:Proxmox-Backup-Server-CT-File-Restore.png

Installing a Virtual Tape Library

2021-04-15T08:35:13Z

Martin: page created

== Introduction ==

Proxmox Backup Server 1.1 and later include support for tape backup, allowing you to save Datastores to tape, and manage tape libraries and tape pools.

Since testing backup and restore with real tape hardware takes a lot of time, it can be a good idea to use a faster Virtual Tape Library (VTL) for evaluation and for testing
of the correct allocation and retention policies for your use case.

One example of such a VTL is the [https://www.quadstor.com/virtual-tape-library.html QuadStor VTL].
This tutorial will guide you through the installation and configuration of a QuadStor VTL, and also show you how to integrate it into Proxmox Backup Server.

== Installing the QuadStor VTL ==

The QuadStor VTL needs an old SSL library package and dedicated disks. Therefore, it's recommended to install it on a separate Virtual Machine (for example, on a Proxmox VE installation).

This tutorial assumes the use of a VM with Debian 10 (Buster) as the OS and '10.20.1.59' as its IP address.

The installation instructions are based on the [https://www.quadstor.com/vtlsupport/145-installation-on-rhel-centos-sles-debian.html official QuadStor documentation] for Debian 9, but they will also work for Debian 10.

# Install supporting packages:
#:<pre>
#::apt update
#::apt install uuid-runtime build-essential sg3-utils apache2 psmisc linux-headers-`uname -r`
#::a2enmod cgi
#::systemctl restart apache2</pre>
# You must install an older libssl version, otherwise Quadstor VTL will not work:
#:<pre>
#::wget -c https://security.debian.org/debian-security/pool/updates/main/o/openssl/libssl1.0.0_1.0.1t-1+deb8u12_amd64.deb
#::apt install ./libssl1.0.0_1.0.1t-1+deb8u12_amd64.deb</pre>
# Now you can download and install the VTL packages:
#:<pre>
#::wget -c https://www.quadstor.com/vtldownloads/quadstor-vtl-ext-3.0.52-debian-x86_64.deb
#::apt install ./quadstor-vtl-ext-3.0.52-debian-x86_64.deb</pre>
#: Installation can take a while.
# Following this, the daemon should be started/enabled automatically. If not, you can enable and start it manually with: <code>systemctl enable --now quadstorvtl.service</code>
# Finally, the VM needs to be rebooted: <code>reboot</code>

You can now access the VTL configuration interface over HTTP using your browser. In our example we'd use http://10.20.1.59.

== Configuring the VTL ==

These steps are described in more detail in the [https://www.quadstor.com/vtl-documentation.html official QuadStore documentation], but the minimum required steps are repeated here.

# The first thing to configure is the 'Physical Storage'.
#: For this, you need to add a new disk to the VM.
# After that, you can click on 'Physical Storage' and 'Rescan'.
#: Your newly added, empty disks should show up with their Vendor, Model and Serial information.
#: Click on 'Add'.
# Now select a 'Storage Pool' (there should be one called 'Default') and click 'Submit'.
#: This will initialize the disk so that it can be used as a storage target for the virtual tapes.
# Now you can create a Virtual Tape Library (VTL). Click on 'Virtual Libraries' and 'Add VTL'.
#: Give it a name under 'VTL Name' and select:
#:* The Vendor/Model you want to simulate (best if this is as close as possible to your real tape hardware for testing).
#:* The type and number of VDrives (Virtual Drives). These define the actual tape drives inside the library.
#:* The number of VSlots (Virtual Slots), which is the number of slots that can hold tapes.
#:* The number of 'IE Ports' (Import/Export slots).
#::The remaining options are not so important and can be left on their default.
#: For this example, let's choose the name 'MYTAPELIB' and the library 'IBM 3584 Ultra Scalable Library' with 2 VDrives 'IBM 3580 Ultrium 8'.
#* Click on 'Submit'.
# Now you need to add some virtual tapes by clicking 'Add VCartridge'.
#* Choose the number you want (this will matter for the auto-numbering scheme) and a Prefix, for example 'TAPES0', and then click on 'Submit'.
# After this, you can add the newly created VTL to a Proxmox Backup Server instance.

== Adding the VTL to Proxmox Backup Server ==

The following commands must all be executed on the Proxmox Backup Server instance.

=== Making devices available over iSCSI ===

# The VTL will be added to Proxmox Backup Server via iSCSI, so you first need to install the open-iscsi package:
#:<pre>apt install open-iscsi</pre>
# To automatically log in to the iSCSI targets on boot, you have to carry out the following steps:
## modify the iSCSI config in <code>/etc/iscsi/iscsid.conf</code> and change <code>node.startup = manual</code> to <code>node.startup = automatic</code>
## then restart <code>iscsid</code> by executing <code>systemctl restart open-iscsi.service</code>
# Now you need to discover the VTL tape drive and changer devices with <code>iscsiadm</code>. Please do not forget to adapt the IP address, if you chose a different one for the Quadstore VTL VM.
#:<pre>iscsiadm -m discovery -t st -p 10.20.1.59</pre>
#:The resulting output should look like this:
#::<pre>
#:::10.20.1.59:3260,1 iqn.2006-06.com.quadstor.vtl.MYTAPELIB.autoloader
#:::10.20.1.59:3260,1 iqn.2006-06.com.quadstor.vtl.MYTAPELIB.drive2
#:::10.20.1.59:3260,1 iqn.2006-06.com.quadstor.vtl.MYTAPELIB.drive1</pre>
# You have to log in to each of these devices with
#:<pre>
#::iscsiadm -m node --targetname iqn.2006-06.com.quadstor.vtl.MYTAPELIB.autoloader --login
#::iscsiadm -m node --targetname iqn.2006-06.com.quadstor.vtl.MYTAPELIB.drive1 --login
#::iscsiadm -m node --targetname iqn.2006-06.com.quadstor.vtl.MYTAPELIB.drive2 --login</pre>
#: This will populate <code>/dev</code> with the correct devices.

=== Adding the Changer and Drives to Proxmox Backup Server ===

You can now add the devices from the Proxmox Backup Server WebUI:
# Go to 'Tape Backup' -> 'Changers'
# Click on 'Add', give the changer a name, and select the path (should be autofilled).
# Now go to 'Tape Backup' -> 'Drives'
#* For each drive, click on 'Add' and choose a name, the corresponding changer, the index of the drive inside the changer (Drive Number), and the correct path.
#* Verify the index by comparing the serial numbers in the Proxmox Backup Server Web UI and the VTL Web UI.

After adding the drives and changers, you can use the VTL like a normal tape library in Proxmox Backup Server.

[[Category:HOW-TO]]

2020-11-10T15:19:20Z

Martin:

File:Proxmox-Backup-Server-CT-File-Restore.png

2020-11-10T15:13:43Z

Martin: Martin uploaded a new version of File:Proxmox-Backup-Server-CT-File-Restore.png

File:Proxmox-Backup-Server-Dashboard.png

2020-11-10T15:13:23Z

Martin: Martin uploaded a new version of File:Proxmox-Backup-Server-Dashboard.png

Roadmap

2020-11-09T15:30:13Z

Martin: /* Roadmap */

Main Page

2020-10-28T14:08:53Z

Martin: /* Documentation */

__NOTOC__
<TABLE>
<tr valign=top>
<td>

'''Proxmox Backup Server''' is an enterprise-class client-server backup software that backups virtual machines, containers, and physical hosts. It is specially optimized for the Proxmox Virtual Environment platform and allows you to backup and replicate your data securely. It provides easy management with a command line and web-based user interface and is licensed under the GNU Affero General Public License v3 (GNU AGPL, v3).

Proxmox Backup Server supports incremental backups, data deduplication, compression, and authenticated encryption. Using [https://www.rust-lang.org/ Rust] as implementation language guarantees high performance, low resource usage, and a safe, high quality code base. It features strong encryption done on the client side. Thus, it’s possible to backup data to not fully trusted targets.

The project is developed and maintained by [https://www.proxmox.com/ Proxmox Server Solutions GmbH].

=Download=
[https://www.proxmox.com/downloads Download] the latest ISO image files.

Alternate download:http://download.proxmox.com/iso

=Installation=

The installation medium (CD or USB) is a complete operation system, including everything you need to install and run Proxmox Backup Server in only a few minutes. It can be installed bare-metal on dedicated hardware or in a virtual machine on all leading virtualization platforms. You can also install it on top of an existing Debian installation.

=Documentation=
The Proxmox Backup Server documentation is freely available in different formats such as HTML and PDF see [https://pbs.proxmox.com/docs/ Proxmox Backup Server Reference Documentation]
You can access the documentation via the management interface of your Proxmox Backup Server installation by clicking on the contextual help buttons.

The developer documentation explains how to get involved in the development process of the Proxmox Backup Server, see [[Developer Documentation]]

=Release History and Roadmap=
Take a look on the [[Roadmap]] for existing and upcoming features.

</td>
<td>
[[Image:Proxmox-Backup-Server-Dashboard.png|thumb|300px|rightthumb|Proxmox Backup Server Dashboard]]
[[Image:Proxmox-Backup-Server-CT-File-Restore.png|thumb|300px|rightthumb|Proxmox-Backup-Server-CT-File-Restore]]
</td>
</tr>
</TABLE>

Main Page

2020-10-28T14:08:16Z

Martin: /* Documentation */

__NOTOC__
<TABLE>
<tr valign=top>
<td>

'''Proxmox Backup Server''' is an enterprise-class client-server backup software that backups virtual machines, containers, and physical hosts. It is specially optimized for the Proxmox Virtual Environment platform and allows you to backup and replicate your data securely. It provides easy management with a command line and web-based user interface and is licensed under the GNU Affero General Public License v3 (GNU AGPL, v3).

Proxmox Backup Server supports incremental backups, data deduplication, compression, and authenticated encryption. Using [https://www.rust-lang.org/ Rust] as implementation language guarantees high performance, low resource usage, and a safe, high quality code base. It features strong encryption done on the client side. Thus, it’s possible to backup data to not fully trusted targets.

The project is developed and maintained by [https://www.proxmox.com/ Proxmox Server Solutions GmbH].

=Download=
[https://www.proxmox.com/downloads Download] the latest ISO image files.

Alternate download:http://download.proxmox.com/iso

=Installation=

The installation medium (CD or USB) is a complete operation system, including everything you need to install and run Proxmox Backup Server in only a few minutes. It can be installed bare-metal on dedicated hardware or in a virtual machine on all leading virtualization platforms. You can also install it on top of an existing Debian installation.

=Documentation=
The Proxmox Backup Server documentation is freely available in different formats such as HTML and PDF see [https://pbs.proxmox.com/docs/ Proxmox Backup Server Reference Documentation]
You can access the documentation via the management interface of your Proxmox Backup Server installation by clicking on the contextual help buttons.

The developer documentation explains how to get involved in the development process of the Proxmox Backup Server, see [https://pbs.proxmox.com/wiki/index.php/Developer_Documentation Developer Documentation]

=Release History and Roadmap=
Take a look on the [[Roadmap]] for existing and upcoming features.

</td>
<td>
[[Image:Proxmox-Backup-Server-Dashboard.png|thumb|300px|rightthumb|Proxmox Backup Server Dashboard]]
[[Image:Proxmox-Backup-Server-CT-File-Restore.png|thumb|300px|rightthumb|Proxmox-Backup-Server-CT-File-Restore]]
</td>
</tr>
</TABLE>

Template:Note

2020-10-28T09:51:50Z

Martin: page created

<noinclude>This template is used to visually mark out some important note in the text.
</noinclude>{| class="mbox" style="border: 1px solid #7dae96; border-left: 5px solid #7dae96; background: #f7f9fa; margin: 1.5em"
| class="mbox-text" width=100% | '''Note''': {{{1}}}
|}<noinclude>

== Usage ==
Put the following code to your page:

<code><nowiki>{{Note|Some text.}}</nowiki></code>

The result will look like this:
{{Note|Some text.}}
</noinclude>

Developer Documentation

2020-10-28T08:59:53Z

Martin: page created

== Introduction ==

Please communicate you plans with us, before starting any development. It is important to have a common view of the problem and corresponding solution, in order to avoid duplicated work and unnecessary efforts.

Our source code repository is read-only. To contribute code, send it as a patch (git diff) to the pbs-devel mailing list. We will review your patch and apply it (and possible corrections/additions) if the review is successful. Note that we will only include code that meets our quality criteria.

== Mailing List ==

This is the primary communication channel for developers to discuss new features and implementation details. If you are a developer and you want to develop additional features, this is the place to start.

PBS Development List: https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel

Archive: https://lists.proxmox.com/pipermail/pbs-devel/

== Access to Code Repository (git) ==

You can find all of our project repositories at the link below. The repositories relating to Proxmox Backup are under the section titled "rust".

https://git.proxmox.com

== Build instructions ==

You can find build instructions here:

https://git.proxmox.com/?p=proxmox-backup.git;a=blob_plain;f=README.rst;hb=HEAD

== Development Package Repository ==

Some packages required for development can only be found in the ''devel'' repository.
This is a cross-project repository and may be used for all Proxmox projects.

Add the following to the <code>/etc/apt/sources.list</code> file:

deb http://download.proxmox.com/debian/devel/ buster main

== Checking out a git repository ==

To clone a repository, run 'git clone' with the repository name prefixed with the common URL: <nowiki>git://git.proxmox.com/git/</nowiki>
<source lang="bash">
# git clone git://git.proxmox.com/git/proxmox-backup.git
</source>
To update an already cloned project to the current version use:
<source lang="bash">
# git pull
</source>

== Working on the code ==

=== Coding guidelines ===

The codebase is mostly Rust, with JavaScript for the web-interface.

We use the ExtJS framework for the GUI components; its API documentation can be found [http://docs.sencha.com/extjs/6.0.1/index.html here.]

=== Using git ===

If you are not familiar with git, it's worth having a look at this interactive tutorial:
https://try.github.io, and reading the brief introduction chapter from the official git documentation: https://git-scm.com/docs/gittutorial
to gain basic knowledge on it.

First, configure your ''real'' name and email address for git, if not done already:

<source lang="bash">
$ git config --global user.name "John Doe"
$ git config --global user.email john@example.com
</source>

This will be used to sign off commits as your work.

We recommend that you start a feature branch before working on the code locally:

<source lang="bash">
# git checkout -b my_branch master
</source>

After this, you can start working on your improvements. You can compare your changes to the current PBS master branch easily with:
<source lang="bash">
# git diff master..my_branch
</source>

==== Commits and Commit Messages ====

After making changes, commit them (try to make small, self-contained commits) and include a sign-off line (-s).

* Make sure the line length of the commit's message is '''not longer than 70 characters'''. HTTPS links are an exception and should not be split.
* If it fixes a bug, start with that information, in the form: <code>fix #1234: summary here</code>
* If it implements a feature tracked on Bugzilla, use: <code>close #1234: summary here</code>, albeit <code>fix #1234:</code> is commonly used and also fine.
* Add a tag to the beginning, if an obvious choice exists. For example, if you made a change to the datastore API, a possible tag could be <code>api: datastore: summary here</code>
: However, do '''not''' just paste the changed file, including path and file ending as a tag. This has no use and makes it harder to read.

The following command will take all the changes in tracked files and commit them:

<source lang="bash">
# git commit -s -a
</source>

New files won't get added automatically with this command. To stage new or changed files for a commit, use:

<source lang="bash">
# git add newfile1.rs file2.rs
</source>

You can always look at what will be committed with:

<source lang="bash">
# git diff --staged
</source>

== Preparing Patches ==

{{note| We need a valid [[#Software License and Copyright|CLA]] to include your changes|reminder}}

Since we have several projects in our git repository that use the pbs-devel mailing list,
we ask you to clarify which repository your patches are meant for,
by specifying it in the subject prefix, for example, 'proxmox' or 'proxmox-backup'.

Example: Creating the raw patch series for the <tt>proxmox-backup</tt> package:

<source lang="bash">
# rm -rf my-patches/ # to clean left-overs
# git format-patch -o my-patches/ --subject-prefix="PATCH proxmox-backup" master..my_branch --cover-letter
</source>

Explain in the cover letter the aim of your patches:

<source lang="bash">
edit my-patches/0000-cover-letter.patch
</source>

Sending patches:

<source lang="bash">
# git send-email --to=pbs-devel@lists.proxmox.com my-patches/00*.patch
# rm -rf my-patches/ # to clean left-overs
</source>

If you wish to write comments for individual patches, you can do that either in
the cover-letter, or in the patch's ''commit summary section'' (between the line
consisting of 3 consecutive dashes ending your commit message and before the
list of files with their change-counts).

Example:

<pre>
From 12345abcde Mon Sep 12 00:00:00 2001
From: Git Committer <some email address>
Date: Fri, 7 Oct 2020 08:30:17 +0200
Subject: [PATCH proxmox-backup 1/2] Fix #1013: this and that

Here is your commit message.
It explains the bugfix and ends after this line.

Signed-off-by: Firstname Lastname <firstname@lastname.email>
---
***HERE*** you can write your comments.
If this is a new version of an old patch, explain your changes here

src/backup.rs | 2 +-

diff --git a/src/backup.rs b/src/backup.rs
(...)
</pre>

If you want to send several related patches that contain changes to different repositories, you can first iterate over all involved repositories, save the patches into one directory and then do a single git send-email over all generated patches. For example, lets go to a few repos and format the most recent commit as a patch to /tmp/patchq, then send it:

<source lang="bash">
# cd proxmox-backup; git format-patch -s -o /tmp/patchq -1
# cd ../proxmox; git format-patch -s -o /tmp/patchq -1
# git send-email --compose --to=pbs-devel@lists.proxmox.com /tmp/patchq/*
</source>

Using "start-number" and the likes can improve this further, but this is a good start.

=== Versioned Patches ===

If an updated version of your patch series is called for, it should be sent
as a new series, rather than as a reply to the old series.
Always send the entire series, with all patches showing the same version.
Please mark your versions in the subject prefix, with a small 'v', followed by
the version number, like this:

<source lang="bash">
# git format-patch -o my-patches/ --subject-prefix="PATCH v2 proxmox-backup" master..my_branch
</source>

Please list all the changes to the previous versions in the ''commit summary
section'' as shown in the above example.
For patches with no changes to the previous version, you should mention that there were no
changes in the summary section.

If your series has a cover letter, summarize all changes in it as well.

=== Reviewing patches ===

After reviewing patches which affect a subsystem you maintain, you can notify
committers that you have reviewed the patch and are OK with the changes, with:

<pre>
Acked-by: name / email address
</pre>

=== Convenience Settings ===

For convenience, you can store the pbs-devel email address and the repository's
default subject prefixes in your repository clones' configurations as follows:

<source lang="bash">
$ git config --local sendemail.to pbs-devel@lists.proxmox.com
$ git config --local format.subjectprefix 'PATCH proxmox-backup'
$ git config --local format.signoff true
</source>

Now the commands to create and send patches become:

<source lang="bash">
# git format-patch -o my-patches/ master..my_branch
# git send-email --compose my-patches/00*.patch
</source>

== Sending Patches ==

Always use <code>git send-email</code> to send out patches, otherwise the indentation and formatting will get mangled and the patch cannot be applied anymore.

=== Tutorial ===

See https://git-send-email.io/ for an interactive tutorial on setting up <code>git send-email</code>.

=== Using Authenticated SMTP Server ===

<code>git send-email</code> can be instructed to use a specific SMTP server for sending. The following shows an anonymized config section example:

[sendemail]
smtpencryption = tls
smtpserver = webmail.example.com
smtpserverport = 587
smtpuser = j.smith@example.com
smtpsslcertpath =
confirm = always

Add this to your global user <code>~/.gitconfig</code> or to the per project <code>.git/config</code>.
<code>git send-email</code> will then use these settings by default and ask you once for the password when sending.

== Bugtracker (Bugzilla) ==

We use Bugzilla to track bugs and feature requests for our products.

https://bugzilla.proxmox.com

== Software License and Copyright ==

We only include code licensed under GNU Affero General Public License, version 3 http://www.gnu.org/licenses/agpl-3.0.html.

Additionally, we ask contributors to send us a contributor license agreement form by email. This agreement establishes a relationship between us and the contributor, gives details on what it means when the contributor grants permission for their work to be included in a project, and enables us to better maintain these projects.

With the contributor agreement chosen by Proxmox, the [http://www.harmonyagreements.org Harmony CLA], the contributor gives Proxmox a license to use their contributions. The contributor continues to own the copyright in the contribution, with full rights to re-use, re-distribute, and continue modifying the contributed code, allowing them to also share that contribution with other projects.

We've tried to keep the agreement as simple and comprehensible as possible. It comes in two flavors:
* one for [http://www.proxmox.com/downloads/item/proxmox-individual-contributor-license-agreement individual contributors]
* and one for [http://www.proxmox.com/downloads/item/proxmox-entity-contributor-assignment-agreement entities contributors] (companies, foundations, or other organizations).

If you are making a contribution that is not your own work (for example, a patch or library written by someone else), please contact office@proxmox.com for guidance on whether any additional steps are needed.

== See Also ==

* [https://git-scm.com/documentation Git Documentation]

Roadmap

2020-10-09T10:58:49Z

Martin:

Roadmap

We at Proxmox are committed to respecting your online privacy and recognize your need for appropriate protection and management of any personally identifiable information ("personal information") you share with us.

See [https://www.proxmox.com/en/privacy-policy Proxmox privacy policy]