fix #5140: qdevice SSH access documentation

rephrase in order to not make it seem like password-based access is required.

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>

tree-wide: unify spelling of GRUB and systemd-boot

Especially for GRUB there were a myriad of different casing variants
(e.g. grub, Grub, GRUB), so unify them, with GRUB being the official
casing.

For systemd-boot, fix an instance where it was not typeset as
monospace, like everywhere else.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>

installation: add section about booting with `nomodeset`

As the grub entry specific to this was removed with the 8.1 release, add
a separate section for this to link users too.

Unfortunaly it is relatively often needed, due to very old or very new
hardware, or when Nvidia cards are installed.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>

installation: add note about memtest86+ incompatibility with secureboot

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>

screenshots: update grub menu screenshot

The 8.1 release changed some things, so update the screenshot to keep in
sync with the latest ISO.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>

qm: resource limits: reword affinity section

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

qm: resource limits: reword cpulimit section

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

qm: resource limits: revise section affinity

* mention side effects
* increase compactness w/o complexity
* improve section-formatting

Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>

qm: resource limits: revise section cpuunits

* restructure sentences minimally
* improve section-formatting

Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>

qm: resource limits: revise section cpulimit

* precise statements
* increase compactness w/o complexity
* improve section-formatting

Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>

pvecm: correct network address

Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>

ballooning: precise example

Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>

firewall: fix link to suricata page

Signed-off-by: Hannes Duerr <h.duerr@proxmox.com>

installation: update installer option wording & description

Some things changed with the 8.1 release, so update all the relevant
things here too.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>

storage: lvm: mention how saferemove setting is called in the UI

to avoid confusion.

Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>

storage: improve description of 'shared' property

Following pve-storage commit 4abb327 ("plugin schema: improve
description of 'shared' property"), adapting the description also
here in the documentation.

It's not clear to users what this property does otherwise.

Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>

pvecm: remove node: explain how to deal with the node's pmxcfs directory

Reported in the community forum:
https://forum.proxmox.com/threads/139006/post-621739

Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>

notifications: fix typos and improve reading flow

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>

storage: lvm: expand on description of saferemove option

mentioning why zeroing-out might be necessary.

Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>

local-zfs: use correct man page for vdev infos

ZFS did split up their man pages a while ago

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>

qm-cloud-init: make install inside VM more obvious

by making that part bold. While there is already a big note where
cloudinit needs to be installed, it is after the actual command.

Making it more obvious right before the command will hopefully reduce
confusion for more users.

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>

fix 'vpus' typo

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>

fix #5089: pvesdn: replace quest(s) -> guest(s)

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>

fix #5087: qm: formatting of start/shutdown order list

drop the stray '*' and reflow.

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>

installation: be more specific about current secure boot state

Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>

secure boot: fix typos, add inline code formatting

Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>

bump version to 8.1.3

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

system booting: fixup title-case

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

secure boot: add subsection for DKMS/MOK

similar, but a bit more beginner friendly compared to the wiki article.

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>

system-booting: fix typo

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>

system-booting: add note about weird uefi behaviour

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>

bump version to 8.1.2

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

system booting: use title-case for secboot-switch section

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

system-booting: add instructions to switch install to secure boot

As this procedure could *potentially* lead to data loss (however
unlikely if followed correctly), put a big warning on top, for safety.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>

pvesdn: Fix heading for NetBox IPAM plugin section

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>

bump version to 8.1.1

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

update static/schema information

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

pvesdn: remove double occurrence of 'external'

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>

boot: add Secure Boot information

and refer to the (updated) wiki article for more in-depth explanations.

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>

notifications: add screenshots for the new notification UI

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>

sdn: fix trailing double-quote character

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

consistently use web UI and web interface wording

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

pveum: update generated synopsys

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

bump version to 8.1.0

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

update static/schema information

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

sdn: rework installation a bit and merge sections for dnsmaq

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

sdn: dhcp: Add documentation for DHCP

Signed-off-by: Stefan Hanreich <s.hanreich@proxmox.com>

sdn: rework introduction and installation and add support status

Provide installation documentation for opt-in features, document the
current support status, and rework the overview and introduction of
the whole chapter.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

notification: document 'unknown' severity

This is the severity used for forwarded mails, since we cannot
reasonably infer a priority here.

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>

notification: add anchors for target types/matchers

This enables us to directly link to the appropriate section from the
UI.

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>

sdn: switch back to singular for vnet reference

do not break the web UI and external references just for a small
virtual improvement

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

add VNC clipboard documentation

Signed-off-by: Markus Frank <m.frank@proxmox.com>
Reviewed-by: Dominik Csapak <d.csapak@proxmox.com>
Tested-by: Dominik Csapak <d.csapak@proxmox.com>

pvecm: expand on public/cluster networks

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>

pveceph: fix typo

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>

pvecm: fix qnetd typo

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>

sdn: add section about underlying technology and configuration files

document some basics of the inner workings, can definitively get
extended (and might be then better of placed somewhere else).

This makes also a bit more sense then the non-telling 'SDN' heading
left over the recent rework.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

sdn: overall language and consistency rework

This is a general style polishing rework that wants to:
- improve consistency of spellings and casing
- drop some to verbose examples that included the whole generated
  ifupdown2 config, which is not only not that useful here, but will
  also get outdated fast, so it is probably more confusing than
  helping at the current development pace. Could be nice in some
  reduced form some times in a "inner workings" section
- shorten some examples verbosity by not spelling repetitions of
  steps, e.g., for those that one needs to apply to all guests in an
  example.

Best to check the changes using the following git flags to avoid noise:
git show -w --word-diff=color --word-diff-regex='\w+'

Signed-off-by: Stefan Lendl <s.lendl@proxmox.com>
 [ TL: fix build, squash patches to not break patch causality, add
   actual commit message and reinstate some notes to avoid loss of
   information ]
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

notifications: change to simplified ACL structure.

For now, we use a less deeply nested structure. We can always extend
it if we need to.

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>

notifications: add documentation for system mail forwarding

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>

notifications: document 'comment' option for targets/matchers

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>

notifications: document SMTP endpoints

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>

notifications: update docs to for matcher-based notifications

Target groups and filters have been replaced by notification matchers.
The matcher can match on certain notification properties and route
the notification to a target in case of a match.

This patch updates the docs to reflect these changes.

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>

gitignore: add build artefacts and temporary intermediate files

Signed-off-by: Stefan Lendl <s.lendl@proxmox.com>
 [ TL: fix subject and use more specific glob ]
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

update static/schema information

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

network: add missing reference

Fixes: 96c0261 ("fix #4847: network: extend section on interface naming scheme")
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

sdn: use correct spelling for software-defined network

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

Fix spelling of command line/command-line

Commandline/command line/command-line where being used interchangeably,
which is not correct
(see: https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/c/command-line).
use command-line when it is an adjective (e.g. "command-line interface")
and use command line when it is a noun (e.g. "change the setting from
the command line")

Signed-off-by: Noel Ullreich <n.ullreich@proxmox.com>

Consistency of USB flash drive spelling

To be consistent, replaced all synonyms of USB flash drive (e.g. thumb
drive, drive, stick)

Signed-off-by: Noel Ullreich <n.ullreich@proxmox.com>

Consistency: change mainboard to motherboard

To be consistent, replaced all instances of mainboard/main board with
motherboard.

Signed-off-by: Noel Ullreich <n.ullreich@proxmox.com>

Consistency of passthrough/pass-through

Fix consistency issues as well as grammatical mistakes with the spelling
of passthough/pass-through/pass through in the pve docs

Signed-off-by: Noel Ullreich <n.ullreich@proxmox.com>

fix #4847: network: extend section on interface naming scheme

Expand the existing section on systemd network interface names with a
link to the systemd.net-naming-scheme(7) manpage and some information
about naming scheme versions. Also mention the possibility of
interface naming changes due to a new naming scheme version, or
kernel/driver updates. This happens for quite some users during the
upgrade from PVE 7 to 8.

Further, describe how to pin a specific naming scheme version and how
to override interface names using systemd.link files.

Also, make some formatting fixes to the existing text.

Signed-off-by: Friedrich Weber <f.weber@proxmox.com>

ceph: add more details for private/public network usage and distinction

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

ceph: rework introduction and recommendation section

Add more headings, update some recommendations to current HW (e.g.,
network and NVMe attached SSD) capabilities and expand recommendations
taking current upstream documentation into account.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

qm: add headings and references for machine-version sections

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

qm: add section about machine types

expanding from the two currently existing sentences. In the first one, a
typo VMs -> VM's is fixed. In the second one, "one wants to" is changed
to "you want to", because the sentence already starts with "You can" and
it's active voice.

Adds information about the machine version, rationale behind the
defaults for it and what to do for deprecated versions.

Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>

ui: reword user-menu header docs

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

ui: correct outdated info about entries in the top header

The header part of the gui did change already a few releases ago.
The user name was moved into a menu button, which now contains more
user specific actions.

So, update the section to document the current layout and ui elements
again correctly.

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>

firmware: reword ucode version hint

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

firmware: rework setting up OS ucode updates to actionable list

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

sysadmin: revise firmware chapter, add firmware repo section

Chapter "Firmware Updates":
* improve the structure and clarity of information provided
* mention which update methods are when available/recommended
* add information about the already pre-installed pve-firmware package
* emphasise the importance of CPU microcode updates, how to interpret
  versions and how to recover a possibly unbootable system
* move info about non-free-firmware repo to "Package Repositories"

Chapter "Package Repositories":
* add new section "Debian Firmware Repository"

Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>

ha-manager, software updates: add useful anchors

Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>

ha: maintenance mode: fix grammar and reword

This was a bit complex while leaving out some key info, like that
HA groups also play into the target selection, not only CRS.

Try to improve on that.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

ha: Explicitly mention that migrations only affect HA guests

Signed-off-by: Maximiliano Sandoval R <m.sandoval@proxmox.com>

zfs: add extra hint for raidz consideration section

For those that jump directly to this part of the docs without seeing
the extra section first.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

zfs: improve and expand on ZIL and cache sections

The ZIL section was copied over from the cache one, but not fully
adapted, so it wrongly talked about cache devices, as recently
reported by a user.

Improve on that and expand those sections in general.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

sdn: fix phrasing

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>

sdn: add isis controller documentation

sdn: add notes about bgp controller

installation: document UP indicator in network setup

See
https://git.proxmox.com/?p=pve-installer.git;a=commit;h=124ca33f9fb3780a76f0b5fd57952e69823852c8.

Signed-off-by: Maximiliano Sandoval R <m.sandoval@proxmox.com>

faq: use only major release version in EOL table

and adapt the one from Proxmox VE 6 to what was the effective date
when we stopped providing updates.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

boot: kernel cmdline: clarify where kernel version/docs can be found

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

qemu: update the PCI(e) docs

A little update to the PCI(e) docs. The PCI wiki article has been
reworked as well, in line with changes from this patch.

Along some minor grammar fixes added:
 * how to check if kernel modules are being loaded
 * how to check which drivers to blacklist
 * how to add softdeps for module loading
 * where to find kernel params

Signed-off-by: Noel Ullreich <n.ullreich@proxmox.com>
 [ TL: squash in dropping two trailing whitespace errors ]
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

fix #2920: add cifs options parameter

Signed-off-by: Stefan Hrdlicka <s.hrdlicka@proxmox.com>
[FE: rebase + style fix]
Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>

ct: update broken link to CentOS release EOL

Use Wikipedia, as it seems CentOS cannot be bothered to create a sane
supported releases + EOL dates table themselves anymore..

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

sdn: update netbox api-token docs link

Found by Fabian using the mlc tool [0].
[0]: https://crates.io/crates/mlc

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

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>

update static/schema information

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

vzdump: mention new parameter 'pbs-entries-max'

configuring pbs-entries-max can avoid failing backups due to a high
amount of files in folders where a folder exclusion is not possible

Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>

calendar events: fix build for wiki target

This was actually just some POC that got committed by accident and
broke build to to getting a title where not expecting it as there
where two (relatively seen) top-level titles in the calendar events
page.

Fix that by declaring an actual level-0 heading (i.e., title) in the
wiki context.

This then should also fix a dangling link to the calendar-events wiki
page for the docs-in-wiki stuff, e.g., "calendar events" in backup
chapter [0] pointint to 404 [1], that Fiona reported a few weeks ago.
[0]: https://pve.proxmox.com/wiki/Backup_and_Restore#vzdump_jobs
[1]: https://pve.proxmox.com/wiki/Schedule_Format#chapter_calendar_events

Fixes: a90b75d ("package repos: add Ceph 18.2 Reef repos")
Reported-by: Lukas Wagner <l.wagner@proxmox.com>
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

package repos: fix heading syntax

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>