2019-02-27 17:35:05 +00:00
|
|
|
Introduction
|
|
|
|
|
============
|
|
|
|
|
|
2019-02-28 18:09:55 +00:00
|
|
|
This documentationm is written in :term:`reStructuredText` and formatted with :term:`Sphinx`.
|
|
|
|
|
|
2019-11-16 10:43:14 +00:00
|
|
|
|
2019-03-02 17:08:00 +00:00
|
|
|
What is Proxmox Backup
|
|
|
|
|
----------------------
|
2019-02-27 17:35:05 +00:00
|
|
|
|
2019-03-02 17:08:00 +00:00
|
|
|
Proxmox Backup is an enterprise class client-server backup software,
|
|
|
|
|
specially optimized for `Proxmox Virtual Environment`_ to backup
|
2019-11-16 10:43:14 +00:00
|
|
|
:term:`virtual machine`\ s and :term:`container`\ s. It is also
|
|
|
|
|
possible to backup physical hosts.
|
|
|
|
|
|
|
|
|
|
It supports deduplication, compression and authenticated encryption
|
2020-01-29 14:14:37 +00:00
|
|
|
(AE_). Using :term:`Rust` as implementation language guarantees high
|
2019-11-16 10:43:14 +00:00
|
|
|
performance, low resource usage, and a safe, high quality code base.
|
|
|
|
|
|
|
|
|
|
Encryption is done at the client side. This makes backups to not fully
|
|
|
|
|
trusted targets possible.
|
|
|
|
|
|
2019-03-02 16:51:18 +00:00
|
|
|
|
2019-11-11 12:26:08 +00:00
|
|
|
Architecture
|
|
|
|
|
------------
|
|
|
|
|
|
|
|
|
|
Proxmox Backup uses a `Client-server model`_. The server is
|
|
|
|
|
responsible to store the backup data, and provides an API to create
|
|
|
|
|
backups and restore data. It is also possible to manage disks and
|
2019-11-16 10:43:14 +00:00
|
|
|
other server side resources using this API.
|
2019-11-11 12:26:08 +00:00
|
|
|
|
|
|
|
|
A backup client uses this API to access the backed up data,
|
|
|
|
|
i.e. ``proxmox-backup-client`` is a command line tool to create
|
|
|
|
|
backups and restore data. We also deliver an integrated client for
|
|
|
|
|
QEMU_ with `Proxmox Virtual Environment`_.
|
|
|
|
|
|
2019-11-17 07:47:22 +00:00
|
|
|
A single backup is allowed to contain several archives. For example,
|
|
|
|
|
when you backup a :term:`virtual machine`, each disk is stored as a
|
|
|
|
|
separate archive inside that backup. The VM configuration also gets an
|
|
|
|
|
extra file. This way, it is easy to access and restore important parts
|
|
|
|
|
of the backup, without having to scan the whole backup.
|
|
|
|
|
|
2019-03-02 16:51:18 +00:00
|
|
|
|
2019-03-02 17:08:00 +00:00
|
|
|
Main features
|
|
|
|
|
-------------
|
2019-03-02 09:31:32 +00:00
|
|
|
|
|
|
|
|
:Proxmox VE: The `Proxmox Virtual Environment`_ is fully
|
|
|
|
|
supported. You can backup :term:`virtual machine`\ s and
|
|
|
|
|
:term:`container`\ s.
|
|
|
|
|
|
|
|
|
|
:GUI: We provide a graphical, web based user interface.
|
|
|
|
|
|
2019-11-16 10:43:14 +00:00
|
|
|
:Deduplication: Incremental backup produces large amounts of duplicate
|
2019-03-02 09:31:32 +00:00
|
|
|
data. The deduplication layer removes that redundancy and makes
|
|
|
|
|
inkremental backup small and space efficient.
|
|
|
|
|
|
2019-03-02 15:56:01 +00:00
|
|
|
:Data Integrity: The built in `SHA-256`_ checksum algorithm assures the
|
2019-12-18 15:56:40 +00:00
|
|
|
accuracy and consistency of your backups.
|
2019-03-02 15:56:01 +00:00
|
|
|
|
2019-03-02 09:31:32 +00:00
|
|
|
:Remote Sync: It is possible to efficently synchronize data to remote
|
|
|
|
|
sites. Only deltas containing new data are transfered.
|
|
|
|
|
|
|
|
|
|
:Performance: The whole software stack is written in :term:`Rust`,
|
|
|
|
|
which provides high speed and memory efficiency.
|
|
|
|
|
|
2019-11-11 18:07:03 +00:00
|
|
|
:Compression: Ultra fast Zstandard_ compression is able to compress
|
2019-03-02 15:56:01 +00:00
|
|
|
several gigabytes of data per second.
|
2019-03-02 09:31:32 +00:00
|
|
|
|
2019-11-11 18:07:03 +00:00
|
|
|
:Encryption: Backups can be encrypted at client side using AES-256 in
|
|
|
|
|
GCM_ mode. This authenticated encryption mode (AE_) provides very
|
|
|
|
|
high performance on modern hardware.
|
|
|
|
|
|
2019-03-02 17:23:48 +00:00
|
|
|
:Open Source: No secrets. You have access to the whole source tree.
|
|
|
|
|
|
|
|
|
|
:Support: Commercial support options available from `Proxmox`_.
|
|
|
|
|
|
2019-11-11 18:07:03 +00:00
|
|
|
|
2019-03-02 17:08:00 +00:00
|
|
|
Why Backup?
|
|
|
|
|
-----------
|
|
|
|
|
|
|
|
|
|
The primary purpose of backup is to protect against data loss. Data
|
|
|
|
|
loss can happen because of faulty hardware, but also by human errors.
|
|
|
|
|
|
|
|
|
|
A common mistake is to delete a file or folder which is still
|
|
|
|
|
required. Virtualization can amplify this problem, because it is now
|
|
|
|
|
easy to delete a whole virtual machine by a single button press.
|
|
|
|
|
|
|
|
|
|
Backups can also serve as a toolkit for administrators to temporarily
|
|
|
|
|
store data. For example, it is common practice to perform full backups
|
|
|
|
|
before installing major software updates. If something goes wrong, you
|
|
|
|
|
can just restore the previous state.
|
|
|
|
|
|
|
|
|
|
Another reason for backups are legal requirements. Some data must be
|
|
|
|
|
kept in a safe place for several years so that you can access it if
|
|
|
|
|
required by law.
|
|
|
|
|
|
2019-12-03 07:18:52 +00:00
|
|
|
Data loss can be very costly as it can severely restrict your
|
|
|
|
|
business. Therefore, make sure that you regularly perform a backup
|
|
|
|
|
and run restore tests.
|
2019-03-02 17:08:00 +00:00
|
|
|
|
|
|
|
|
|
2019-11-11 18:07:03 +00:00
|
|
|
Software Stack
|
|
|
|
|
--------------
|
|
|
|
|
|
2020-01-29 14:14:37 +00:00
|
|
|
.. todo:: Eplain why we use Rust (and Flutter)
|
2019-11-16 10:50:56 +00:00
|
|
|
|
2019-11-11 18:07:03 +00:00
|
|
|
|
|
|
|
|
License
|
|
|
|
|
-------
|
|
|
|
|
|
2019-11-11 18:21:27 +00:00
|
|
|
Copyright (C) 2019 Proxmox Server Solutions GmbH
|
|
|
|
|
|
|
|
|
|
This software is written by Proxmox Server Solutions GmbH <support@proxmox.com>
|
|
|
|
|
|
|
|
|
|
Proxmox Backup is free software: you can redistribute it and/or modify
|
|
|
|
|
it under the terms of the GNU Affero General Public License as
|
|
|
|
|
published by the Free Software Foundation, either version 3 of the
|
|
|
|
|
License, or (at your option) any later version.
|
|
|
|
|
|
|
|
|
|
This program is distributed in the hope that it will be useful, but
|
|
|
|
|
``WITHOUT ANY WARRANTY``; without even the implied warranty of
|
|
|
|
|
``MERCHANTABILITY`` or ``FITNESS FOR A PARTICULAR PURPOSE``. See the GNU
|
|
|
|
|
Affero General Public License for more details.
|
|
|
|
|
|
|
|
|
|
You should have received a copy of the GNU Affero General Public License
|
|
|
|
|
along with this program. If not, see AGPL3_.
|
|
|
|
|
|
2019-03-02 17:08:00 +00:00
|
|
|
|
2019-02-27 17:35:05 +00:00
|
|
|
History
|
|
|
|
|
-------
|
|
|
|
|
|
2019-11-16 10:50:56 +00:00
|
|
|
.. todo:: Add development History of the product
|
|
|
|
|
|
