Aaron Lauterer [Thu, 21 Mar 2024 16:45:48 +0000 (17:45 +0100)]
qm: small follow-up linking to our virtio wiki page
instead of the direct link to the latest ISO. As the wiki page contains
a bit more details about the VirtIO drivers and can be changed quickly
if needed.
Stefan Sterz [Thu, 21 Mar 2024 15:50:43 +0000 (16:50 +0100)]
qm: multiqueue specify that it needs to be vCPUs not cores
total number of cores != vCPUs if there is more than one socket
configured. according to the redhat docs it should be vCPUs not cores:
> Multi-queue virtio-net provides the greatest performance benefit when:
> [..]
> - The number of queues is equal to the number of vCPUs.
https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/7/html/virtualization_tuning_and_optimization_guide/sect-virtualization_tuning_optimization_guide-networking-techniques#sect-Virtualization_Tuning_Optimization_Guide-Networking-Multi-queue_virtio-net Signed-off-by: Stefan Sterz <s.sterz@proxmox.com>
In the manpage output the sections get rendered as refsections, but
those only go up to level 3:
> In DocBook, RefSect3 is the lowest-level section allowed in a
> RefEntry. There is no element analogous to a Sect4.
-- https://tdg.docbook.org/tdg/4.5/refsect3
While nesting refsect3 would work output wise, the DTD schema does not
allows this, and disabling schema validation can lead to graver
issues, so rather avoid that and use a formalpara [0], a paragraph
with a title, instead, but only for the title, as the inner content
will be a simpara (simple paragraph) that cannot be nested inside a
formalpara, but the resulting rendering works out well enough.
[0]: https://tdg.docbook.org/tdg/4.5/formalpara
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
partially fix #5139: document qnetd port requirement
we could also add a check somewhere in pve-cluster for this.
Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
[ TL: squash in changes Fiona proposed for the port syntax/wording ] Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
Fiona Ebner [Tue, 30 Jan 2024 13:21:40 +0000 (14:21 +0100)]
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.
Thomas Lamprecht [Tue, 21 Nov 2023 18:19:58 +0000 (19:19 +0100)]
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>
Stefan Lendl [Fri, 17 Nov 2023 13:55:26 +0000 (14:55 +0100)]
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>
Lukas Wagner [Tue, 14 Nov 2023 12:59:54 +0000 (13:59 +0100)]
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.
Stefan Lendl [Fri, 17 Nov 2023 14:40:50 +0000 (15:40 +0100)]
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>
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")
Friedrich Weber [Thu, 27 Jul 2023 10:37:45 +0000 (12:37 +0200)]
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: 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>
Fiona Ebner [Fri, 10 Nov 2023 13:24:45 +0000 (14:24 +0100)]
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.
Dominik Csapak [Thu, 2 Nov 2023 15:08:23 +0000 (16:08 +0100)]
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.
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>
projects / pve-docs.git / log