Thomas Lamprecht [Mon, 30 Sep 2024 09:41:24 +0000 (11:41 +0200)]
system requirements: use correct and modern acronym for Intel 64-bit
Intel EMT64 is not a thing, the correct variant would be Extended
Memory 64 Technology, which is shortened to EM64T [0].
But the `Intel EM64T` term was replace a long time ago by `Intel 64`
[1], so just go with that.
[0]: https://www.intel.com/content/www/us/en/support/articles/000005898/processors.html
[1]: "[...] in March 2004 unveiled the "official" name EM64T (Extended
Memory 64 Technology). In late 2006 Intel began instead using
the name Intel 64 for its implementation [...]"
-- https://en.wikipedia.org/wiki/X86-64#Intel_64
Reported-by: Alexander P. Inzinger-Zrock Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
Markus Frank [Fri, 26 Jul 2024 08:21:12 +0000 (10:21 +0200)]
passthrough: viommu: replace host requirement with reference to pcie passthrough
Enabling IOMMU on the host is not a requirement for vIOMMU. It is only
a requirement for passthrough. Add a sentence to clarify the need for
a configured PCI(e) passthrough on the host for passthrough to nested
VMs.
While at it also clarify that this does not only applies to PCI but
also PCIe here.
Suggested-by: Dominik Csapak <d.csapak@proxmox.com> Signed-off-by: Markus Frank <m.frank@proxmox.com>
[ TL: mention all changes and avoid overly long line with link ] Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
Add a concise section about what PBS change detection mode is, where
to configure the option and what it affects, including a table with a
description of the modes.
Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
Folke Gleumes [Tue, 18 Jun 2024 14:15:27 +0000 (16:15 +0200)]
acme: add note about validation delay
The effect and unit of the validation delay was unclear from our
documentation, and the link to the acme.sh documentation didn't explain
it either
Signed-off-by: Folke Gleumes <f.gleumes@proxmox.com>
[ TL: reflow to 80cc, while 100cc is fine in general, this file uses
basically only 80cc and honoring local style trumps using a more
modern line wrap width ] Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
Christoph Heiss [Fri, 10 May 2024 13:16:18 +0000 (15:16 +0200)]
asciidoc: add clickable anchor link to all headings
Works the same as in our PBS documentation and is generally common for
documentations.
Very useful for linking specific sections of the documentation in other
places. Previously, this always had to be done by getting the correct
anchor from the HTML directly via e.g. browser devtools.
Signed-off-by: Christoph Heiss <c.heiss@proxmox.com> Tested-by: Max Carrara <m.carrara@proxmox.com>
The initramfs-tools hook /usr/share/initramfs-tools/hooks/udev copies
link files from /etc/systemd/network to the initramfs, where they take
effect in early userspace. If the link files in the initramfs diverge
from the link files in the rootfs, this can lead to confusing
behavior, as reported in enterprise support. For instance:
- If an interface matches link files both in the initramfs and the
rootfs, it will be renamed twice during boot.
- A leftover link file in the initramfs renaming an interface A to a
new name X may prevent a link file in the rootfs from renaming a
different interface B to the same name X (it will fail with "File
exists").
To avoid this confusion, mention the link files are copied to the
initramfs, and suggest updating the initramfs after making changes to
the link files.
Suggested-by: Hannes Laimer <h.laimer@proxmox.com> Signed-off-by: Friedrich Weber <f.weber@proxmox.com>
Friedrich Weber [Mon, 29 Apr 2024 07:49:22 +0000 (09:49 +0200)]
fix #5429: network: override device names: include Type=ether
Mention that the systemd link file should contain `Type=ether` in most
setup, to make sure it only applies to Ethernet devices and does not
ever apply to e.g. bridges or bonds which inherit the MAC address of
the Ethernet device. Mention that some setups may require other
options.
Thomas Lamprecht [Tue, 23 Apr 2024 20:07:28 +0000 (22:07 +0200)]
backup: move screenshots for retention and note-templates to their section
As the job one is quite a bit crowded as is and there are some
screenshots that fit really well with some specific sections like
retention or the backup note templates.
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
installation: add section about unattended/automatic installation
Mention and briefly explain it. The main part of the documentation will
live in the Wiki for now as it applies to not just Proxmox VE.
Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
[ TL: adapt to changes made in the wiki article ] Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
We ship our own fwupd package, since it needs to handle the
differently named efi_os_dir (proxmox vs debian).
Due to our experience with `udisks2` causing issues on hypervisors,
our package downgraded the Recommends udisks2, to a Suggests.
The downside is, that users need to explicitly set their ESP
mountpoint in the config file.
Additionally a minor stylistic rephrasing (is an option vs. could be
an option).
Tested this today, while giving our fwupd package a spin.
Christoph Heiss [Mon, 26 Feb 2024 17:59:55 +0000 (18:59 +0100)]
installation: reword `nomodeset` section a bit, add link to it
The `nomodeset` section needs some massaging due to the text flow being
broken a bit. While at it, link to it above at the 'Terminal UI'
bootloader tip such that readers can find it more easily.
Suggested-by: Alexander Zeidler <a.zeidler@proxmox.com> Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
Christoph Heiss [Thu, 21 Mar 2024 15:29:30 +0000 (16:29 +0100)]
installation: zfs-options: improve & align wording with pmg-docs
These changes are the result of basically "diffing" both documentations,
choosing the better prased/sounding sections. Some wording were also
slightly changed as necessary to further improve them.
The equivalent changes will be done for pmg-docs too, to ensure they are
really the same in the end.
Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
Christoph Heiss [Thu, 21 Mar 2024 15:29:29 +0000 (16:29 +0100)]
installation: lvm-options: improve & align wording with pmg-docs
These changes are the result of basically "diffing" both documentations,
choosing the better prased/sounding sections. Some wording were also
slightly changed as necessary to further improve them.
The equivalent changes will be done for pmg-docs too, to ensure they are
really the same in the end.
Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
Christoph Heiss [Thu, 21 Mar 2024 15:29:28 +0000 (16:29 +0100)]
installation: iso: improve & align wording with pmg-docs
New paragraphs were taken from pmg-docs and adapted. Most changes
here are the result of basically "diffing" both documentations, choosing
the better prased/sounding sections. Some wording were slightly changed
as necessary to further improve them.
The equivalent changes will be done for pmg-docs too, to ensure they are
really the same in the end.
Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
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>
projects / pve-docs.git / log