pve-docs/sysadmin.adoc

[[chapter_system_administration]]
Host System Administration
==========================
ifndef::manvolnum[]
:pve-toplevel:
endif::manvolnum[]

The following sections will focus on common virtualization tasks and explain the
{pve} specifics regarding the administration and management of the host machine.

{pve} is based on https://www.debian.org/[Debian GNU/Linux] with additional
repositories to provide the {pve} related packages. This means that the full
range of Debian packages is available including security updates and bug fixes.
{pve} provides its own Linux kernel based on the Ubuntu kernel. It has all the
necessary virtualization and container features enabled and includes
https://zfsonlinux.org[ZFS] and several extra hardware drivers.

For other topics not included in the following sections, please refer to the
Debian documentation. The
https://debian-handbook.info/get[Debian
Administrator\'s Handbook] is available online, and provides a comprehensive
introduction to the Debian operating system (see xref:Hertzog13[]).

ifdef::wiki[]

See Also
--------

* link:/wiki/Package_Repositories[Package Repositories]

* link:/wiki/Network_Configuration[Network Configuration]

* link:/wiki/System_Software_Updates[System Software Updates]

* link:/wiki/Firmware_Updates[Firmware Updates]

* link:/wiki/Host_Bootloader[Host Bootloader]

* link:/wiki/Time_Synchronization[Time Synchronization]

* link:/wiki/External_Metric_Server[External Metric Server]

* link:/wiki/Disk_Health_Monitoring[Disk Health Monitoring]

* link:/wiki/Logical_Volume_Manager_(LVM)[Logical Volume Manager (LVM)]

* link:/wiki/ZFS_on_Linux[ZFS on Linux]

* link:/wiki/BTRFS[BTRFS]

* link:/wiki/Certificate_Management[Certificate Management]

* link:/wiki/Kernel_Samepage_Merging_(KSM)[Kernel Samepage Merging (KSM)]

endif::wiki[]


ifndef::wiki[]

include::pve-package-repos.adoc[]

include::system-software-updates.adoc[]

include::firmware-updates.adoc[]

include::pve-network.adoc[]

include::system-timesync.adoc[]

include::pve-external-metric-server.adoc[]

include::pve-disk-health-monitoring.adoc[]

include::local-lvm.adoc[]

include::local-zfs.adoc[]

include::local-btrfs.adoc[]

include::pvenode.adoc[]

include::certificate-management.adoc[]

include::system-booting.adoc[]

include::kernel-samepage-merging.adoc[]

endif::wiki[]


////
TODO:

Working with 'systemd'
----------------------

Journal and syslog
~~~~~~~~~~~~~~~~~~

TODO: explain persistent journal...

////
use/define more/better block IDs 2016-10-13 09:40:48 +03:00			`[[chapter_system_administration]]`
add sysadmin docs 2016-01-05 12:24:31 +03:00			`Host System Administration`
			`==========================`
generate default output file mappings automatically 2016-10-14 08:18:04 +03:00			`ifndef::manvolnum[]`
mark toplevel docs 2016-10-08 18:22:48 +03:00			`:pve-toplevel:`
generate default output file mappings automatically 2016-10-14 08:18:04 +03:00			`endif::manvolnum[]`
mark toplevel docs 2016-10-08 18:22:48 +03:00
Overhaul Sysadmin improve phrasing Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com> 2020-02-11 11:55:42 +03:00			`The following sections will focus on common virtualization tasks and explain the`
			`{pve} specifics regarding the administration and management of the host machine.`
add sysadmin docs 2016-01-05 12:24:31 +03:00
Overhaul Sysadmin improve phrasing Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com> 2020-02-11 11:55:42 +03:00			`{pve} is based on https://www.debian.org/[Debian GNU/Linux] with additional`
			`repositories to provide the {pve} related packages. This means that the full`
			`range of Debian packages is available including security updates and bug fixes.`
it's -> its because it isn't 'it is' Signed-off-by: Matthias Heiserer <m.heiserer@proxmox.com> Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com> 2022-11-09 14:58:27 +03:00			`{pve} provides its own Linux kernel based on the Ubuntu kernel. It has all the`
Overhaul Sysadmin improve phrasing Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com> 2020-02-11 11:55:42 +03:00			`necessary virtualization and container features enabled and includes`
			`https://zfsonlinux.org[ZFS] and several extra hardware drivers.`
add sysadmin docs 2016-01-05 12:24:31 +03:00
Overhaul Sysadmin improve phrasing Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com> 2020-02-11 11:55:42 +03:00			`For other topics not included in the following sections, please refer to the`
			`Debian documentation. The`
update link to debian handbook to avoid 404 seems like Bullseye is not yet ready, so the download for current stable is 404, link to general "get book" page, which also provides a donation option and so better for the project. Signed-off-by: Matthias Heiserer <m.heiserer@proxmox.com> Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com> 2022-11-09 14:58:28 +03:00			`https://debian-handbook.info/get[Debian`
Overhaul Sysadmin improve phrasing Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com> 2020-02-11 11:55:42 +03:00			`Administrator\'s Handbook] is available online, and provides a comprehensive`
			`introduction to the Debian operating system (see xref:Hertzog13[]).`
add sysadmin docs 2016-01-05 12:24:31 +03:00
use/install separate wiki pages for sysadmin.adoc includes 2016-09-12 11:42:02 +03:00			`ifdef::wiki[]`

			`See Also`
			`--------`

			`* link:/wiki/Package_Repositories[Package Repositories]`

Fix whitespace and line length Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com> 2020-02-11 11:55:45 +03:00			`* link:/wiki/Network_Configuration[Network Configuration]`
use/install separate wiki pages for sysadmin.adoc includes 2016-09-12 11:42:02 +03:00
			`* link:/wiki/System_Software_Updates[System Software Updates]`

sysadmin: add section 'Firmware Updates' and references Firmware updates are important, their existence should not be checked only when there are already noticeable problems. Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com> Reviewed-by: Dominik Csapak <d.csapak@proxmox.com> 2023-07-28 16:21:12 +03:00			`* link:/wiki/Firmware_Updates[Firmware Updates]`

sysadmin: update links for ifdef::wiki Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com> 2022-05-04 12:23:58 +03:00			`* link:/wiki/Host_Bootloader[Host Bootloader]`

sysadmin: add missing btrfs & time sync links for wiki Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com> 2022-08-25 09:01:44 +03:00			`* link:/wiki/Time_Synchronization[Time Synchronization]`

add external metric server to sysadmin.adoc this did only exist as a wiki article, but since we ship with it, this should be in the reference documentation Signed-off-by: Dominik Csapak <d.csapak@proxmox.com> 2016-10-20 12:58:33 +03:00			`* link:/wiki/External_Metric_Server[External Metric Server]`

add section disk health monitoring to sysadmin chapter explain that we ship smartmontools, basic usage of smartctl default behaviour of smartd, and where to get more information Signed-off-by: Dominik Csapak <d.csapak@proxmox.com> 2016-10-06 16:49:19 +03:00			`* link:/wiki/Disk_Health_Monitoring[Disk Health Monitoring]`

include/improve new LVM page 2016-09-12 13:18:27 +03:00			`* link:/wiki/Logical_Volume_Manager_(LVM)[Logical Volume Manager (LVM)]`

use/install separate wiki pages for sysadmin.adoc includes 2016-09-12 11:42:02 +03:00			`* link:/wiki/ZFS_on_Linux[ZFS on Linux]`

sysadmin: add missing btrfs & time sync links for wiki Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com> 2022-08-25 09:01:44 +03:00			`* link:/wiki/BTRFS[BTRFS]`

typo managment -> management Signed-off-by: Oguz Bektas <o.bektas@proxmox.com> 2019-02-14 18:06:11 +03:00			`* link:/wiki/Certificate_Management[Certificate Management]`
sysadmin: update links for ifdef::wiki Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com> 2022-05-04 12:23:58 +03:00
			`* link:/wiki/Kernel_Samepage_Merging_(KSM)[Kernel Samepage Merging (KSM)]`

use/install separate wiki pages for sysadmin.adoc includes 2016-09-12 11:42:02 +03:00			`endif::wiki[]`


			`ifndef::wiki[]`
add sysadmin docs 2016-01-05 12:24:31 +03:00
sysadmin.adoc: split into several smaller files 2016-01-19 19:03:26 +03:00			`include::pve-package-repos.adoc[]`
add sysadmin docs 2016-01-05 12:24:31 +03:00
sysadmin.adoc: split into several smaller files 2016-01-19 19:03:26 +03:00			`include::system-software-updates.adoc[]`
add section about soptware upgrades using apt-get 2016-01-17 13:35:58 +03:00
sysadmin: add section 'Firmware Updates' and references Firmware updates are important, their existence should not be checked only when there are already noticeable problems. Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com> Reviewed-by: Dominik Csapak <d.csapak@proxmox.com> 2023-07-28 16:21:12 +03:00			`include::firmware-updates.adoc[]`

pve-network.adoc: move network docu into separate file 2016-09-12 10:50:41 +03:00			`include::pve-network.adoc[]`
add network configuration 2016-05-01 12:52:18 +03:00
sysadmin: add section about NTP configuration based on wiki article Configuration_of_Time_Syncronization_(NTP) 2016-10-07 16:28:31 +03:00			`include::system-timesync.adoc[]`

add external metric server to sysadmin.adoc this did only exist as a wiki article, but since we ship with it, this should be in the reference documentation Signed-off-by: Dominik Csapak <d.csapak@proxmox.com> 2016-10-20 12:58:33 +03:00			`include::pve-external-metric-server.adoc[]`

add section disk health monitoring to sysadmin chapter explain that we ship smartmontools, basic usage of smartctl default behaviour of smartd, and where to get more information Signed-off-by: Dominik Csapak <d.csapak@proxmox.com> 2016-10-06 16:49:19 +03:00			`include::pve-disk-health-monitoring.adoc[]`

include/improve new LVM page 2016-09-12 13:18:27 +03:00			`include::local-lvm.adoc[]`

add ZFS management docs partly imported from current wiki page. 2016-09-08 10:24:50 +03:00			`include::local-zfs.adoc[]`
add sysadmin docs 2016-01-05 12:24:31 +03:00
add a basic BTRFS section Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com> 2021-06-23 15:46:48 +03:00			`include::local-btrfs.adoc[]`

avoid own chapter for meager pvenode, move to sysadmin As else we have a big promising heading for "PVE Node Management" with just two acme examples and a bit of Wake-On-LAN support. Move the latter into sysadmin, the former goes only in man-page environment, as the ACME docs are much more telling. Ideally we move some stuff inside pvenode and see if it merits it's own chapter, separating the more basic "Linux-y" sysadmin stuff from PVE node, but not today. Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com> 2020-05-06 11:30:34 +03:00			`include::pvenode.adoc[]`

typo managment -> management Signed-off-by: Oguz Bektas <o.bektas@proxmox.com> 2019-02-14 18:06:11 +03:00			`include::certificate-management.adoc[]`
add documentation for certificate managment * new section about certificate management in sysadmin chapter. * adaptation of pveproxy and pvenode documentation Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com> Co-authored-by: René Jochum <r.jochum@proxmox.com> 2018-05-09 19:56:21 +03:00
Add documentation on bootloaders (systemd-boot) With the recently added support for booting ZFS on root on EFI systems via `systemd-boot` the documentation needs adapting (mostly related to editing the kernel commandline). This patch adds a short section on Bootloaders to the sysadmin chapter describing both `grub` and PVE's use of `systemd-boot` Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com> 2019-07-10 15:40:16 +03:00			`include::system-booting.adoc[]`

fix #3884: Add section for kernel samepage merging Adds a section to the "Host System Administration" section of the Administration Guide, discussing KSM and its security risks Signed-off-by: Dylan Whyte <d.whyte@proxmox.com> 2022-02-25 19:29:48 +03:00			`include::kernel-samepage-merging.adoc[]`

use/install separate wiki pages for sysadmin.adoc includes 2016-09-12 11:42:02 +03:00			`endif::wiki[]`

add sysadmin docs 2016-01-05 12:24:31 +03:00
add ZFS management docs partly imported from current wiki page. 2016-09-08 10:24:50 +03:00			`////`
			`TODO:`
add sysadmin docs 2016-01-05 12:24:31 +03:00
			`Working with 'systemd'`
			`----------------------`

			`Journal and syslog`
			`~~~~~~~~~~~~~~~~~~`

			`TODO: explain persistent journal...`

add network configuration 2016-05-01 12:52:18 +03:00			`////`