tyler
/
proxmox-backup
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: rework and add a bit to introduction 

Contributed-by: Daniela Häsler <daniela@proxmox.com>
[ discussed and edited some parts live with me, Thomas ]
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
Thomas Lamprecht 2020-07-03 18:58:14 +02:00
parent 27f86f997e
commit d2c7ef09ba
1 changed files with 63 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

122
docs/introduction.rst
View File

@ -1,57 +1,61 @@
Introduction Introduction
============ ============
This documentation is written in :term:`reStructuredText` and formatted with :term:`Sphinx`. This documentation is written in :term:`reStructuredText` and formatted with
:term:`Sphinx`.
What is Proxmox Backup What is Proxmox Backup Server
---------------------- -----------------------------
Proxmox Backup is an enterprise class client-server backup software, Proxmox Backup Server is an enterprise-class client-server backup software that
specially optimized for the `Proxmox Virtual Environment`_ to backup backups :term:`virtual machine`\ s, :term:`container`\ s, and physical hosts.
:term:`virtual machine`\ s and :term:`container`\ s. It is also It is specially optimized for the `Proxmox Virtual Environment`_ platform and
possible to backup physical hosts. allows you to backup your data securely, even between remote sites, providing
easy management with a web-based user interface.
It supports deduplication, compression and authenticated encryption Proxmox Backup Server supports deduplication, compression, and authenticated
(AE_). Using :term:`Rust` as implementation language guarantees high encryption (AE_). Using :term:`Rust` as implementation language guarantees high
performance, low resource usage, and a safe, high quality code base. performance, low resource usage, and a safe, high quality code base.
Encryption is done at the client side. This makes backups to not fully It features strong encryption done on the client side. Thus, it's possible to
trusted targets possible. backup data to not fully trusted targets.
Architecture Architecture
------------ ------------
Proxmox Backup uses a `Client-server model`_. The server is Proxmox Backup Server uses a `client-server model`_. The server stores the
responsible to store the backup data and provides an API to create backup data and provides an API to create backups and restore data. With the
backups and restore data. It is possible to manage disks and API it's also possible to manage disks and other server side resources.
other server side resources using this API.
A backup client uses this API to access the backed up data, The backup client uses this API to access the backed up data. With the command
i.e. ``proxmox-backup-client`` is a command line tool to create line tool ``proxmox-backup-client`` you can create backups and restore data.
backups and restore data. We deliver an integrated client for For QEMU_ with `Proxmox Virtual Environment`_ we deliver an integrated client.
QEMU_ with `Proxmox Virtual Environment`_.
A single backup is allowed to contain several archives. For example, A single backup is allowed to contain several archives. For example, when you
when you backup a :term:`virtual machine`, each disk is stored as a backup a :term:`virtual machine`, each disk is stored as a separate archive
separate archive inside that backup. The VM configuration also gets an inside that backup. The VM configuration itself is stored as an extra file.
extra file. This way, it is easy to access and restore important parts This way, it is easy to access and restore only important parts of the backup
of the backup without having to scan the whole backup. without the need to scan the whole backup.
Main Features Main Features
------------- -------------
:Proxmox VE: The `Proxmox Virtual Environment`_ is fully :Support for Proxmox VE: The `Proxmox Virtual Environment`_ is fully
supported. You can backup :term:`virtual machine`\ s and supported and you can easily backup :term:`virtual machine`\ s and
:term:`container`\ s. :term:`container`\ s.
:GUI: We provide a graphical, web based user interface. :Performance: The whole software stack is written in :term:`Rust`,
to provide high speed and memory efficiency.
:Deduplication: Incremental backups produce large amounts of duplicate :Deduplication: Periodic backups produce large amounts of duplicate
data. The deduplication layer removes that redundancy and makes data. The deduplication layer avoids redundancy and minimizes the used
incremental backups small and space efficient. storage space.
:Incremental backups: Changes between backups are typically low. Reading and
sending only the delta reduces storage and network impact of backups.
:Data Integrity: The built in `SHA-256`_ checksum algorithm assures the :Data Integrity: The built in `SHA-256`_ checksum algorithm assures the
accuracy and consistency of your backups. accuracy and consistency of your backups.
@ -59,43 +63,43 @@ Main Features
:Remote Sync: It is possible to efficiently synchronize data to remote :Remote Sync: It is possible to efficiently synchronize data to remote
sites. Only deltas containing new data are transferred. sites. Only deltas containing new data are transferred.
:Performance: The whole software stack is written in :term:`Rust`, :Compression: The ultra fast Zstandard_ compression is able to compress
to provide high speed and memory efficiency.
:Compression: Ultra fast Zstandard_ compression is able to compress
several gigabytes of data per second. several gigabytes of data per second.
:Encryption: Backups can be encrypted client-side using AES-256 in :Encryption: Backups can be encrypted on the client-side using AES-256 in
GCM_ mode. This authenticated encryption mode (AE_) provides very GCM_ mode. This authenticated encryption mode (AE_) provides very
high performance on modern hardware. high performance on modern hardware.
:Open Source: No secrets. You have access to all the source code. :Web interface: Manage Proxmox backups with the integrated web-based user
interface.
:Support: Commercial support options are available from `Proxmox`_. :Open Source: No secrets. Proxmox Backup Server is free and open-source
software. The source code is licensed under AGPL, v3.
:Support: Enterprise support is available from `Proxmox`_.
Why Backup? Reasons for Data Backup?
----------- ------------------------
The primary purpose of a backup is to protect against data loss. Data The main purpose of a backup is to protect against data loss. Data loss can be
loss can be caused by faulty hardware, but also by human error. caused by faulty hardware but also by human error.
A common mistake is to delete a file or folder which is still A common mistake is to accidentally delete a file or folder which is still
required. Virtualization can amplify this problem. It is now required. Virtualization can even amplify this problem; it easily happens that
easy to delete a whole virtual machine by pressing a single button. a whole virtual machine is deleted by just pressing a single button.
Backups can serve as a toolkit for administrators to temporarily For administrators, backups can serve as a useful toolkit for temporarily
store data. For example, it is common practice to perform full backups storing data. For example, it is common practice to perform full backups before
before installing major software updates. If something goes wrong, you installing major software updates. If something goes wrong, you can easily
can restore the previous state. restore the previous state.
Another reason for backups are legal requirements. Some data must be Another reason for backups are legal requirements. Some data, especially
kept in a safe place for several years by law, so that it can be accessed if business records, must be kept in a safe place for several years by law, so
required. that they can be accessed if required.
Data loss can be very costly as it can severely restrict your In general, data loss is very costly as it can severely damage your business.
business. Therefore, make sure that you perform a backup regularly Therefore, ensure that you perform regular backups and run restore tests.
and run restore tests.
Software Stack Software Stack
@ -107,14 +111,14 @@ Software Stack
License License
------- -------
Copyright (C) 2019 Proxmox Server Solutions GmbH Copyright (C) 2020 Proxmox Server Solutions GmbH
This software is written by Proxmox Server Solutions GmbH <support@proxmox.com> This software is written by Proxmox Server Solutions GmbH <support@proxmox.com>
Proxmox Backup is free software: you can redistribute it and/or modify Proxmox Backup Server is free and open source software: you can use it,
it under the terms of the GNU Affero General Public License as redistribute it, and/or modify it under the terms of the GNU Affero General
published by the Free Software Foundation, either version 3 of the Public License as published by the Free Software Foundation, either version 3
License, or (at your option) any later version. of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but This program is distributed in the hope that it will be useful, but
``WITHOUT ANY WARRANTY``; without even the implied warranty of ``WITHOUT ANY WARRANTY``; without even the implied warranty of