Commit Graph

2149 Commits

Author SHA1 Message Date
Aaron Lauterer
6afac16cb7 vzdump: replace e.g. with for example
to be more aligned with our technical writing style guide.

[0] https://pve.proxmox.com/wiki/Technical_Writing_Style_Guide#Abbreviations

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2024-07-11 12:59:17 +02:00
Aaron Lauterer
107b5974ea vzdump: change detection mode: rephrase to avoid e.g.
We try to avoid "e.g.". Restructuring the sentence helps us to avoid it
alltogether.

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2024-07-11 12:58:05 +02:00
Christian Ebner
2ce60240a4 vzdump: add section describing PBS change detection mode
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>
2024-07-11 12:49:31 +02:00
Mario Loderer
f5e17ae1c6 qm: fix formula for ballooning
move "+" in to new line, if it set at the end of the line it will be
lost when converting to other formats. E.g. html

Signed-off-by: Mario Loderer <m.loderer@proxmox.com>
2024-07-04 15:28:38 +02:00
Lukas Wagner
413219c01a notifications: backport some rephrased parts from PBS docs
Most of the changes were done when adapting the PVE docs to
the new PBS notification system, so now we 'backport' those
improvements.

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2024-07-04 15:11:27 +02:00
Lukas Wagner
054583a418 notifications: fix typo in 'notification'
Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
[FG: adapted context for partial application]
Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2024-07-04 15:10:57 +02:00
Lukas Wagner
23c057837a notification: clarify that 'hostname' does not include the domain
This was a bit inconsistent between the different notification types:
  - APT/VZDump included the domain part
  - fence notifications did not

A decision has been made to unify this by removing the domain part
from APT/VZDump notifications.

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2024-07-04 14:00:15 +02:00
Fiona Ebner
75659740b2 backup: mention where fleecing can be configured
Reported in the community forum:
https://forum.proxmox.com/threads/145955/post-658380

Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
2024-07-03 14:50:58 +02:00
Aaron Lauterer
ff3aca1073 ceph server: document full cluster shutdown
Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
Reviewed-by: Alexander Zeidler <a.zeidler@proxmox.com>
2024-06-20 09:46:43 +02:00
Folke Gleumes
33bd85d554 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>
2024-06-18 16:33:57 +02:00
Christoph Heiss
ecab5895a4 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>
2024-06-18 10:27:49 +02:00
Fabian Grünbichler
27f646827d certs: make it more clear where to set alias
see https://bugzilla.proxmox.com/show_bug.cgi?id=5506

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2024-06-05 12:31:04 +02:00
Fiona Ebner
8f6611eb7c fix #5512: installation: fix typo
Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
2024-06-05 09:42:22 +02:00
Friedrich Weber
0563b1e982 network: override device names: suggest running update-initramfs
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>
2024-05-21 16:01:08 +02:00
Fabian Grünbichler
188d30f0fe totp: fix copy/paste mistake
this should of course talk about PVE's UI, not PBS'.

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2024-05-02 10:55:16 +02:00
Friedrich Weber
11a062af1b 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.

Reported in the forum [0] and in #5429 [1].

[0] https://forum.proxmox.com/threads/144557/post-656188
[1] https://bugzilla.proxmox.com/show_bug.cgi?id=5429

Fixes: 96c0261 ("fix #4847: network: extend section on interface naming scheme")
Signed-off-by: Friedrich Weber <f.weber@proxmox.com>
2024-04-29 15:43:49 +02:00
Thomas Lamprecht
73c340dea7 bump version to 8.2.2
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-04-25 09:24:19 +02:00
Thomas Lamprecht
788fffd01c vzdump: drop overly scary & outdated warning about fleecing
This is pretty stable, albeit naturally an advanced and new technique.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-04-25 09:21:48 +02:00
Thomas Lamprecht
ad285c9a91 bump version to 8.2.1
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-04-23 22:09:09 +02:00
Thomas Lamprecht
f85620dfc9 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>
2024-04-23 22:07:29 +02:00
Thomas Lamprecht
1ffb0cf58c update static/schema information
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-04-23 21:45:14 +02:00
Dominik Csapak
354b96de8c vzdump: add backup job screenshots
Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
2024-04-23 11:26:09 +02:00
Stefan Hanreich
d00d6f5677 firewall: add documentation for proxmox-firewall
Add a section that explains how to use the new nftables-based
proxmox-firewall.

Signed-off-by: Stefan Hanreich <s.hanreich@proxmox.com>
2024-04-23 09:12:09 +02:00
Thomas Lamprecht
49152567fd bump version to 8.2.0
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-04-22 13:44:30 +02:00
Aaron Lauterer
e0695f4133 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>
2024-04-22 13:41:54 +02:00
Thomas Lamprecht
907e4bc32b update static/schema information
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-04-22 13:15:46 +02:00
Thomas Lamprecht
62ef2acb18 firmware-updates: fix typo
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-04-21 12:03:30 +02:00
Stefan Hanreich
0500f140bf network: update specification for bridge names
Reviewed-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
Signed-off-by: Stefan Hanreich <s.hanreich@proxmox.com>
2024-04-21 11:22:47 +02:00
Thomas Lamprecht
a3806d641c firmware updates: split overly long sentence into three separate one
Surely  still not perfect but even me, a comma loving creator of
complex sentences, found rather hard to follow, so this had to get
split up.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-04-21 11:03:26 +02:00
Stoiko Ivanov
905fff4902 firmware: adapt to proxmox packaged fwupd
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.

Suggested-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2024-04-21 11:00:08 +02:00
Fiona Ebner
1ca0f96a86 vzdump: add section about backup fleecing
Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
2024-04-19 16:00:27 +02:00
Fabian Grünbichler
c58d2f179c ssh: document PVE-specific setup
such as adapted configs and managed files.

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2024-04-19 09:10:33 +02:00
Fabian Grünbichler
95d15550a0 ssh: make pitfalls a regular section instead of block
because we'll add another one before it, and formatting is off otherwise.

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2024-04-19 09:10:33 +02:00
Friedrich Weber
5a33939735 qm: add overrule-shutdown to CLI usage examples
Signed-off-by: Friedrich Weber <f.weber@proxmox.com>
2024-04-18 23:09:32 +02:00
Thomas Lamprecht
5e6024eaf0 system boot: slightly reword some secure-boot paragraphs
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-04-18 22:12:18 +02:00
Stoiko Ivanov
6eb73a3ff8 secure boot: mention proxmox-secure-boot-support metapackage
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2024-04-18 22:06:15 +02:00
Fiona Ebner
f8564fdd51 storage: pbs: document port option
Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
2024-04-17 16:52:25 +02:00
Fiona Ebner
cb3fe20115 backup: clarify where repeat-missed option can be found now
It was moved to the advanced tab by pve-manager commit
ui: backup job: move repeat-missed option to advanced tab

Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
2024-04-17 16:06:19 +02:00
Fiona Ebner
848c7b1be5 backup: update information about performance settings
Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
2024-04-17 16:06:19 +02:00
Markus Frank
d5b75187db add vIOMMU documentation
Signed-off-by: Markus Frank <m.frank@proxmox.com>
2024-04-11 16:47:21 +02:00
Fabian Grünbichler
611d594874 zfs: add missing "to"
Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2024-04-08 10:22:20 +02:00
Aaron Lauterer
e309f17326 system-requirements: mention that SSDs with PLP should be used
Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2024-03-29 13:49:09 +01:00
Thomas Lamprecht
a366aa5937 pvenode/wake-on-lan: mention defaults
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-03-28 17:50:26 +01:00
Christian Ebner
b6938de84a pvenode/wake-on-lan: mention optional config options
Show how to configure the optional bind interface and broadcast address
options via `pvenode`.

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
2024-03-28 17:38:36 +01:00
Christoph Heiss
93f1aa5d53 installation: fix volume group name
This slipped through while taking the wording from PMG.

Fixes: 67d2d94 ("installation: lvm-options: improve & align wording with pmg-docs")
Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2024-03-28 11:59:48 +01:00
Thomas Lamprecht
093bd98ffc bump version to 8.1.5
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-03-27 14:46:53 +01:00
Christoph Heiss
2a2e180c50 installation: add serial console grub entry
This was added with the 8.1 release ISO, so mention it in the
documentation too.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2024-03-27 14:44:04 +01:00
Christoph Heiss
eb638de418 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>
2024-03-27 14:43:19 +01:00
Christoph Heiss
64b28d743f installation: document ARC max size option for ZFS-on-root installations
This has been part of the installer since the 8.1 release.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2024-03-27 14:42:09 +01:00
Christoph Heiss
2172bbb2be local-zfs: mention zfs_arc_max clamping by the installer
This was forgotten to be updated when it changed it the installer and
now reported in the forum [0] that the docs are a bit outdated in this
regard.

[0] https://forum.proxmox.com/threads/hat-proxmox-8-neue-zfs_arc_max-settings.142754/

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2024-03-27 14:42:04 +01:00