From c4f1b69f4e3497c11a54b20b79e4ae56a76ce254 Mon Sep 17 00:00:00 2001 From: Dietmar Maurer Date: Fri, 15 Nov 2019 13:24:45 +0100 Subject: [PATCH] docs: add sysadmin.rst, cleanups --- docs/administration-guide.rst | 3 +++ docs/command-line-tools.rst | 4 ++-- docs/conf.py | 1 + docs/epilog.rst | 2 ++ docs/index.rst | 2 +- docs/services.rst | 2 +- docs/sysadmin.rst | 29 +++++++++++++++++++++++++++++ 7 files changed, 39 insertions(+), 4 deletions(-) create mode 100644 docs/sysadmin.rst diff --git a/docs/administration-guide.rst b/docs/administration-guide.rst index f89c88848..1b53e8662 100644 --- a/docs/administration-guide.rst +++ b/docs/administration-guide.rst @@ -3,6 +3,9 @@ Administration Guide The administartion guide. +.. include:: sysadmin.rst + + Backup Server Management ------------------------ diff --git a/docs/command-line-tools.rst b/docs/command-line-tools.rst index 9ab5d12d0..5638065fb 100644 --- a/docs/command-line-tools.rst +++ b/docs/command-line-tools.rst @@ -2,12 +2,12 @@ Command Line Tools ------------------ ``proxmox-backup-client`` -^^^^^^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~~~~~~ .. include:: proxmox-backup-client/description.rst ``proxmox-backup-manager`` -^^^^^^^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~~~~~~~ .. include:: proxmox-backup-manager/description.rst diff --git a/docs/conf.py b/docs/conf.py index 658daeb70..28c22e086 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -91,6 +91,7 @@ exclude_patterns = [ 'proxmox-backup-proxy/man1.rst', 'epilog.rst', 'pbs-copyright.rst', + 'sysadmin.rst', 'package-repositories.rst', ] diff --git a/docs/epilog.rst b/docs/epilog.rst index db35163d3..eaab67a20 100644 --- a/docs/epilog.rst +++ b/docs/epilog.rst @@ -26,6 +26,8 @@ .. _GCM: https://en.wikipedia.org/wiki/Galois/Counter_Mode .. _AGPL3: https://www.gnu.org/licenses/agpl-3.0.en.html .. _Debian: https://www.debian.org/index.html +.. _Debian Administrator's Handbook: https://debian-handbook.info/download/stable/debian-handbook.pdf + .. _LVM: https://en.wikipedia.org/wiki/Logical_Volume_Manager_(Linux) .. _ZFS: https://en.wikipedia.org/wiki/ZFS .. _Proxmox VE: https://pve.proxmox.com diff --git a/docs/index.rst b/docs/index.rst index 1a0832410..ad2d4a1bc 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -19,7 +19,7 @@ Documentation License". introduction.rst installation.rst administration-guide.rst - + .. raw:: latex \appendix diff --git a/docs/services.rst b/docs/services.rst index f4af44460..fa8600b53 100644 --- a/docs/services.rst +++ b/docs/services.rst @@ -2,7 +2,7 @@ Service Daemons --------------- ``proxmox-backup-proxy`` -^^^^^^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~~~~~ .. include:: proxmox-backup-proxy/description.rst diff --git a/docs/sysadmin.rst b/docs/sysadmin.rst new file mode 100644 index 000000000..3ae4dc9ef --- /dev/null +++ b/docs/sysadmin.rst @@ -0,0 +1,29 @@ +Host System Administration +-------------------------- + +`Proxmox Backup`_ is based on the famous Debian_ Linux +distribution. That means that you have access to the whole world of +Debian packages, and the base system is well documented. The `Debian +Administrator's Handbook`_ is available online, and provides a +comprehensive introduction to the Debian operating system. + +A standard `Proxmox Backup`_ installation uses the default +repositories from Debian, so you get bug fixes and security updates +through that channel. In addition, we provide our own package +repository to roll out all Proxmox related packages. This includes +updates to some Debian packages when necessary. + +We also deliver a specially optimized Linux kernel, where we enable +all required virtualization and container features. That kernel +includes drivers for ZFS_, and several hardware drivers. For example, +we ship Intel network card drivers to support their newest hardware. + +The following sections will concentrate on backup related topics. They +either explain things which are different on `Proxmox Backup`_, or +tasks which are commonly used on `Proxmox Backup`_. For other topics, +please refer to the standard Debian documentation. + +ZFS +~~~ + +TODO