5
0
mirror of git://git.proxmox.com/git/pve-docs.git synced 2025-10-24 03:33:11 +03:00
Commit Graph

2233 Commits

Author SHA1 Message Date
Thomas Lamprecht
008c966740 scan references: record and output the include order
This will be used to order the index after the actual chapter order.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-31 03:06:10 +02:00
Thomas Lamprecht
a461de5eba html/css: add toggle menu for TOC on narrow (mobile) screens
This hides the TOC by default on narrower screens (< 1000 px/dp) and
adds a simple toggle menu to make it pop out.

Most is handled purely through CSS, but to hide the menu when clicking
on links or when there is no TOC at all (e.g., for the index or FAQ)
we need a bit of JavaScript. There just monkey patch the asciidoc TOC
JS function to ensure we get called in the correct moment.

Further, add a modal-like "label" over the content if the TOC menu is
open, clicking on that will also close the TOC, again with pure CSS.

This also tries to improve styling and readability for mobile in
general, while I tested on many sizes, virtual devices in Firefox and
Chromiums developer mode, and also some actual smartphone, it
certainly will not yet be perfect everywhere, but it definitively
should be better than the status quo.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-31 03:06:10 +02:00
Thomas Lamprecht
05bd9f9557 html: make table overflow the x-axis automatically
This avoids that wide tables where the cell content cannot easily wrap
cause horizontal scrolling for the whole page, rather just cause that
scrolling for the table itself, so wrap in in a div and make that use
overflow-x: auto style.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-31 03:06:10 +02:00
Thomas Lamprecht
d76f4bf7af css: ensure index image doesn't overflows ovoer the screen
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-31 03:06:10 +02:00
Thomas Lamprecht
6940302e66 css: make table cell borders more lightweight
To not deflect to much from the actual content.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-31 03:06:10 +02:00
Thomas Lamprecht
4ad5d63283 css: do not differentiate visited links
Similar to PBS, as this looks rather odd for a reference documentation
that has many links.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-31 03:06:10 +02:00
Thomas Lamprecht
2f55a8ae4b css: prefer Open Sans, sans-serif for general text font
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-31 03:06:10 +02:00
Fiona Ebner
f7540b8ad9 backup/storage: remove references to 'maxfiles' parameter
The deprecated 'maxfiles' setting is being removed with Proxmox VE 9
now.

There are some generated docs where 'make update' is necessary to
phase it out.

Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
Link: https://lore.proxmox.com/20250718125408.133376-7-f.ebner@proxmox.com
2025-07-31 01:47:44 +02:00
Thomas Lamprecht
7456b0a6ee make introduction a first-class chapter
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-31 01:47:27 +02:00
Thomas Lamprecht
57e556bfc7 intro: fix xref spanning multiple lines
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-31 01:46:59 +02:00
Thomas Lamprecht
850ea37a4c qmeventd: do not make a top-level chapter
This is just a short paragraph anyway and quite definitively was only
declared as toplevel by mistake.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-31 01:45:45 +02:00
Thomas Lamprecht
eb29dcf7f6 storage: it's wrong to signal that directory based storages have no snapshots
This is talking about our plugins not the underlying filesysten
technology after all.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-31 01:44:33 +02:00
Thomas Lamprecht
b999cf9321 storage: abbreviate technology preview and add foot-note
TP is a common abbreviation and with a foot note it's better explained
in any way.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-31 01:43:40 +02:00
Christoph Heiss
029a5919db qm: document conntrack state migration for live migrations
Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
Link: https://lore.proxmox.com/20250730094549.263805-12-c.heiss@proxmox.com
2025-07-31 00:24:47 +02:00
Fiona Ebner
3d0e0d0639 user management: privileges: document VM.Replicate privilege
Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
2025-07-30 14:54:38 +02:00
Friedrich Weber
7153da5a9e pveproxy, pvedaemon: document MAX_WORKERS setting
For pveproxy, add it to the description of settings that can be
adjusted in /etc/default/pveproxy.

For pvedaemon, this is currently the only setting that can be adjusted
in /etc/default/pvedaemon.

Signed-off-by: Friedrich Weber <f.weber@proxmox.com>
Link: https://lore.proxmox.com/20250729155227.157120-5-f.weber@proxmox.com
2025-07-29 21:18:58 +02:00
Stefan Hanreich
0e3aaccaae firewall: update 'useful commands' section with new subcommands
Migrating proxmox-firewall to the proxmox_log crate has removed the
RUST_LOG environment variable, among other things. Additionally, the
proxmox-firewall binary now has subcommands for dumping the generated
firewall ruleset. Update the documentation to provide information on
how to use the new subcommands for debugging proxmox-firewall.

Signed-off-by: Stefan Hanreich <s.hanreich@proxmox.com>
Link: https://lore.proxmox.com/20250527135800.190084-5-s.hanreich@proxmox.com
2025-07-29 08:20:55 +02:00
Lukas Wagner
2b0173ef55 notifications: adapt to latest notification system UI changes
The latest updates to the backup-job UI completely drop the term
"Notification System" from the UI, instead we now use "Global
notification settings", which should be hopefully a bit clearer to users
with regards to what this actually means.

Furthermore, the 'auto' notification mode is not exposed anymore in the
UI, hence we also drop it from the documentation to avoid confusion. It
is still listed in the backup job option reference section, for any user
who might still be using it.

Some of the touched sections were slightly rephrased to improve clarity.

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
Reviewed-by: Michael Köppl <m.koeppl@proxmox.com>
Link: https://lore.proxmox.com/20250725082046.51199-1-l.wagner@proxmox.com
2025-07-25 12:00:57 +02:00
Thomas Lamprecht
84181fd98d slightly enhance and add references to PBS
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-25 12:00:36 +02:00
Thomas Lamprecht
4c7e18c4ab remove GlusterFS plugin documentation
Mirroring pve-storage commit 7669a99 ("drop support for using
GlusterFS directly"). Native GlusterFS support will not be available
for PVE 9, one still can manually mount and use such a storage as
directory storage though, or keep using PVE 8 until EOL and use that
time for migrating to e.g. Ceph or the like.

The main reason is that upstream has stopped development and various
integrations are planned to go away soon, like the QEMU one. That's
why we cannot promote it as stable storage for PVE 9.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-25 11:59:55 +02:00
Thomas Lamprecht
1e6e8fe870 LVM storage: reword and update to current capabilities
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-25 11:40:43 +02:00
Hannes Laimer
e043270aa8 sdn: fabrics: remove duplicate paragraph in OSPF section
Signed-off-by: Hannes Laimer <h.laimer@proxmox.com>
Link: https://lore.proxmox.com/20250717091224.1856-1-h.laimer@proxmox.com
2025-07-24 13:04:04 +02:00
Thomas Lamprecht
2398e3bcb3 lvm storage: fix spelling of Fibre Channel
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-18 14:55:10 +02:00
Thomas Lamprecht
0c65c680f7 bump version to 9.0.4
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-18 14:41:48 +02:00
Gabriel Goller
99c2b60dbb fabrics: fix IPv6 section
Fix the IPv6 section, now we don't enable IPv6 forwarding anymore, but
the user has to manually enable it. Also add some more info on how to do
it.

When applying the last fabrics series, this patch was missed, so update
the old docs to the latest version.

Signed-off-by: Gabriel Goller <g.goller@proxmox.com>
Reviewed-by: Hannes Duerr <h.duerr@proxmox.com>
Link: https://lore.proxmox.com/20250718080826.88560-1-g.goller@proxmox.com
2025-07-18 11:47:46 +02:00
Thomas Lamprecht
e871203968 storage overview: use simple yes for new snapshot feature for LVM
It's explained in a foot-note at the bottom of the table anyway, so no
need to use harder to understand terms here, the essence is: yes, it's
supported now.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-18 11:46:55 +02:00
Shannon Sterz
289cb4cf67 package-repos: update key file path and hashes
so they better match the repository definitions above

Signed-off-by: Shannon Sterz <s.sterz@proxmox.com>
Link: https://lore.proxmox.com/20250718083831.31025-1-s.sterz@proxmox.com
2025-07-18 10:51:15 +02:00
Daniel Herzig
43d8bb5e4c local-zfs: document raidz extension for PVE 9/ZFS 2.3.3
Add documentation how to extend a raidz vdev with a new disk [0].
Add the note that this will only work for PVE 9 (ZFS 2.3.3).

[0]: https://github.com/openzfs/zfs/pull/15022

Signed-off-by: Daniel Herzig <d.herzig@proxmox.com>
Link: https://lore.proxmox.com/20250717133753.408101-1-d.herzig@proxmox.com
2025-07-18 10:03:10 +02:00
Thomas Lamprecht
333550f13a lvm storage: further wording improvements
Suggested-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-18 09:48:21 +02:00
Thomas Lamprecht
95871caa29 lvm storage: improve wording for snapshot-as-volume-chain option
Suggested-by: Friedrich Weber <f.weber@proxmox.com>
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-18 08:47:02 +02:00
Thomas Lamprecht
260a3738dc lvm storage: fix line continuation in term list
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-18 00:01:51 +02:00
Thomas Lamprecht
add489e9e4 bump version to 9.0.3
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-17 23:02:50 +02:00
Thomas Lamprecht
bb578ab630 update static/schema information
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-17 23:00:56 +02:00
Thomas Lamprecht
bffbdd4243 storage: fixup reference syntax
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-17 22:56:26 +02:00
Fiona Ebner
0d07e03bf0 user management: privileges: remove reference to dropped VM.Monitor privilege
The privilege was replaced by Sys.Audit for access to the QEMU HMP
monitor and by VM.GuestAgent.* privileges for access to the QEMU guest
agent.

Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
Link: https://lore.proxmox.com/20250717133711.84715-10-f.ebner@proxmox.com
2025-07-17 22:41:20 +02:00
Fiona Ebner
b9ff27af50 user management: privileges: document new VM guest agent privileges
Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
Link: https://lore.proxmox.com/20250717133711.84715-9-f.ebner@proxmox.com
2025-07-17 22:41:17 +02:00
Stefan Hanreich
2e1cb3fe05 qm: document new default behavior for mtu setting
The default behavior changed from setting 1500 MTU to inheriting the
bridge MTU, if the MTU key for network devices is unset.

Signed-off-by: Stefan Hanreich <s.hanreich@proxmox.com>
Link: https://lore.proxmox.com/20250717175012.606372-4-s.hanreich@proxmox.com
2025-07-17 20:36:54 +02:00
Thomas Lamprecht
48944d9068 storage, lvm: add basic documentation for snapshot-as-volume-chain option
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-17 20:03:50 +02:00
Gabriel Goller
eb9cd35a97 docs: add screenshots
Signed-off-by: Gabriel Goller <g.goller@proxmox.com>
 [TL: revert commenting-out screenshot usage again]
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-17 13:12:36 +02:00
Thomas Lamprecht
e38ceea5ea bump version to 9.0.2
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-17 01:12:57 +02:00
Maximiliano Sandoval
a470dbd1d9 ha-manager: move hardware watchdog out of the requirements list
Having a hardware watchdog is not a requirement, we move it out of the
list so it is not as prominent.

Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
Link: https://lore.proxmox.com/20250521140343.366871-3-m.sandoval@proxmox.com
2025-07-17 01:08:32 +02:00
Maximiliano Sandoval
3d23336364 ha-manager: remove hardware fencing from requirements
This is not fully integrated at the moment.

The documentation for the `fencing` option in datacenter.cfg suggests
that /etc/pve/ha/fence.cfg can used for configuring fence devices but
such a config file is not documented anywhere.

Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
Link: https://lore.proxmox.com/20250521140343.366871-2-m.sandoval@proxmox.com
2025-07-17 01:08:19 +02:00
Fiona Ebner
838ad7efee qm: cpu types: list that Haswell supports x86-64-v3 ABI
As reported in the community forum [0] and mentioned in the QEMU
documentation [1], Haswell already supports the x86-64-v3 ABI. This
can also be seen in the QEMU source code [2] by checking that the
necessary flags are supported for the QEMU Haswell models.

[0]: https://forum.proxmox.com/threads/166061/post-770368
[1]: https://qemu-project.gitlab.io/qemu/system/qemu-cpu-models.html#id1
[2]: in target/i386/cpu.c:
> .name = "Haswell",
> .level = 0xd,
> .vendor = CPUID_VENDOR_INTEL,
> .family = 6,
> .model = 60,
> .stepping = 4,
> .features[FEAT_1_EDX] =
>     CPUID_VME | CPUID_SSE2 | CPUID_SSE | CPUID_FXSR | CPUID_MMX |
>     CPUID_CLFLUSH | CPUID_PSE36 | CPUID_PAT | CPUID_CMOV | CPUID_MCA |
>     CPUID_PGE | CPUID_MTRR | CPUID_SEP | CPUID_APIC | CPUID_CX8 |
>     CPUID_MCE | CPUID_PAE | CPUID_MSR | CPUID_TSC | CPUID_PSE |
>     CPUID_DE | CPUID_FP87,
> .features[FEAT_1_ECX] =
>     CPUID_EXT_AVX | CPUID_EXT_XSAVE | CPUID_EXT_AES |
>     CPUID_EXT_POPCNT | CPUID_EXT_X2APIC | CPUID_EXT_SSE42 |
>     CPUID_EXT_SSE41 | CPUID_EXT_CX16 | CPUID_EXT_SSSE3 |
>     CPUID_EXT_PCLMULQDQ | CPUID_EXT_SSE3 |
>     CPUID_EXT_TSC_DEADLINE_TIMER | CPUID_EXT_FMA | CPUID_EXT_MOVBE |
>     CPUID_EXT_PCID | CPUID_EXT_F16C | CPUID_EXT_RDRAND,
> .features[FEAT_8000_0001_EDX] =
>     CPUID_EXT2_LM | CPUID_EXT2_RDTSCP | CPUID_EXT2_NX |
>     CPUID_EXT2_SYSCALL,
> .features[FEAT_8000_0001_ECX] =
>     CPUID_EXT3_ABM | CPUID_EXT3_LAHF_LM,
> .features[FEAT_7_0_EBX] =
>     CPUID_7_0_EBX_FSGSBASE | CPUID_7_0_EBX_BMI1 |
>     CPUID_7_0_EBX_HLE | CPUID_7_0_EBX_AVX2 | CPUID_7_0_EBX_SMEP |
>     CPUID_7_0_EBX_BMI2 | CPUID_7_0_EBX_ERMS | CPUID_7_0_EBX_INVPCID |
>     CPUID_7_0_EBX_RTM,

Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
Link: https://lore.proxmox.com/20250513080108.17210-1-f.ebner@proxmox.com
2025-07-17 01:07:54 +02:00
Shannon Sterz
dbf3f1c509 calendar-events: add a note about systemd-analyze calendar
this is mentioned in the `systemd.time(7)` manpage, but adding it here
to should give it more exposure. it's very handy and hopefully avoids
some frustration for users less familiar with calendar events.

Signed-off-by: Shannon Sterz <s.sterz@proxmox.com>
Link: https://lore.proxmox.com/20250414102948.87726-1-s.sterz@proxmox.com
2025-07-17 01:07:30 +02:00
Aaron Lauterer
7d7bb4aed0 pvecm: extend cluster Requirements
by expanding on best practices with background information as to how and
why.

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
Link: https://lore.proxmox.com/20250627134455.2065020-5-a.lauterer@proxmox.com
2025-07-17 01:04:08 +02:00
Aaron Lauterer
ab83397071 pvecm: add anchor for corosync exernal vote support
so we can reference the chapter. Manually set the automatically
generated one to avoid breaking existing deep links.

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
Link: https://lore.proxmox.com/20250627134455.2065020-4-a.lauterer@proxmox.com
2025-07-17 01:04:06 +02:00
Aaron Lauterer
065e6a1cd5 pvecm: add anchor for cluster requirements
so we can link help buttons to it

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
Link: https://lore.proxmox.com/20250627134455.2065020-3-a.lauterer@proxmox.com
2025-07-17 01:04:02 +02:00
Aaron Lauterer
b26a764ce3 pvecm: drop notes about old version incompatibilities
Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
Link: https://lore.proxmox.com/20250627134455.2065020-2-a.lauterer@proxmox.com
2025-07-17 01:04:00 +02:00
Aaron Lauterer
b9d31c2594 pveceph: update cluster shutdown procedure
It seems that the shutdown procedure which we had documented (and many
others as well) can potentially cause problems when the cluster starts
up again.

There is a blog article from croit explaining it in detail [0] if you
are interested.

The shorter explanation is that when unsetting 'pause' it might take
half an hour to get out of that state. Unsetting nodown also could take
a long time. During all this OSDs and MONs might consume a lot of CPU
resources, increasing the CPU load on the host considerbly.

nobackfill and norecover are not needed, but also not harmful.

Archeology revealed that the procedure with all the other flags (which
this commit removes), originated in the RedHat documentation, but was
never part of Ceph's shutdown procedure which is tested by the Ceph
team.

[0] https://web.archive.org/web/20250624082830/https://www.croit.io/blog/how-not-to-shut-down-a-ceph-cluster

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
Link: https://lore.proxmox.com/20250624085306.3224755-1-a.lauterer@proxmox.com
2025-07-17 01:01:38 +02:00
Gabriel Goller
257e70874a sdn: add fingerprint option to the NetBox IPAM plugin
Add the required "Fingerprint" option of the NetBox IPAM plugin to the
docs. Also add a quick `openssl` command to retrieve the fingerprint
from the default certificate on a NetBox installation. AFAIK NetBox
doesn't provide a way to easily get the fingerprint from the gui.

Signed-off-by: Gabriel Goller <g.goller@proxmox.com>
Link: https://lore.proxmox.com/20250611123216.236179-1-g.goller@proxmox.com
2025-07-17 01:00:42 +02:00