5
0
mirror of git://git.proxmox.com/git/pve-docs.git synced 2025-10-31 04:23:45 +03:00
Commit Graph

2228 Commits

Author SHA1 Message Date
Stefan Hanreich
969b3cbb5d network: add documentation for proxmox-network-interface-pinning
Signed-off-by: Stefan Hanreich <s.hanreich@proxmox.com>
Link: https://lore.proxmox.com/20250716163911.406995-10-s.hanreich@proxmox.com
2025-07-16 19:46:51 +02:00
Shannon Sterz
6d92a7be09 pveceph/package-repos: adapt further to new deb822 format
fixes up some outdated uses of the old package repositories and adds a
bit more explanation for users trying to install the firmware package

Signed-off-by: Shannon Sterz <s.sterz@proxmox.com>
Link: https://lore.proxmox.com/20250716145702.315217-1-s.sterz@proxmox.com
2025-07-16 17:16:15 +02:00
Fabian Grünbichler
1a8b9d95fe fix #6388: disk health: sync list of scanned devices
taken straight from the man page.

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
Link: https://lore.proxmox.com/20250512082347.444284-1-f.gruenbichler@proxmox.com
2025-07-16 16:46:57 +02:00
Thomas Lamprecht
6044b2aab0 bump version to 9.0.1
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-16 02:37:45 +02:00
Thomas Lamprecht
a245b28f88 update static/schema information
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-16 02:36:13 +02:00
Thomas Lamprecht
bb5e44ff21 pvecm: update reference to votequorum qedvic manual page.
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-16 02:32:49 +02:00
Thomas Lamprecht
6522e73891 wiki: apt repositories: drop full repository list for PVE 5 and older
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-16 02:32:10 +02:00
Thomas Lamprecht
5847014cce apt repositories: initial update for PVE 9 / Debian Trixie based repos
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-16 02:31:32 +02:00
Thomas Lamprecht
895b7f8934 faq: mention PVE 9 and add preliminary EOL for PVE 8
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-16 02:30:48 +02:00
Thomas Lamprecht
015a37d34c asciidoc conf: update ceph base url for PVE 9 baseline Ceph 19.2 Squid
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-16 02:15:30 +02:00
Thomas Lamprecht
5fb655c67f installation: reword explanation for maxroot and swap a bit
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-15 12:23:30 +02:00
Michael Köppl
3560f5f879 installation: remove maxroot size requirement and mention default instead
The requirement of hdsize/4 was not checked anywhere and adding sanity
checks for maxroot<=hdsize/4 would stop users from installing PVE on
smaller disks (see [0]), whereas the installation actually tries its
best to successfully install even on disks below 12GB. So instead of
adding sanity checks, relax the documentation regarding this requirement
and instead refer to the defaults used during installation to provide
guidance for users.

[0] https://lore.proxmox.com/pve-devel/D9P1YXB42LGJ.ULII1HUIPAWQ@proxmox.com/

Signed-off-by: Michael Köppl <m.koeppl@proxmox.com>
Link: https://lore.proxmox.com/20250715094021.154914-2-m.koeppl@proxmox.com
2025-07-15 12:19:28 +02:00
Stefan Hanreich
badafb0782 firewall: nftables: document new firewall bridge behavior
proxmox-firewall does not require firewall bridges if the interface is
on a linux bridge. It still creates firewall bridges for OVS, since
otherwise the traffic of the interface is not visible in netfilter.
Document this behavior explicitly as it hasn't been mentioned in the
documentation before.

Signed-off-by: Stefan Hanreich <s.hanreich@proxmox.com>
Reviewed-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2025-07-03 14:23:08 +02:00
Thomas Lamprecht
7cc17ee595 bump version to 9.0.0
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-06-02 19:00:09 +02:00
Thomas Lamprecht
105b23a6e2 d/control: adapt to imagemagick package being now version 7
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-06-02 18:49:19 +02:00
Thomas Lamprecht
1498f87bfb d/control: ensure again that docs are build with compatible asciidoc
While I opened an issue for asciidoc.py two years ago [0], describing
the underlying regression and a simple potential fix, there was no
reaction whatsoever. I now also opened a PR [1] but let's see what
happens in the next two years, ideally I do not have to care about
this one way or there other.

This is basically a semantic copy of commit 393cdae ("d/control:
ensure docs are build with compatible asciidoc").

[0]: https://github.com/asciidoc-py/asciidoc-py/issues/266
[1]: https://github.com/asciidoc-py/asciidoc-py/pull/277

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-06-02 18:48:11 +02:00
Fabian Grünbichler
0a9408769e fix #6416: bootloader: update OpenZFS doc link
Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2025-05-26 14:27:54 +02:00
Fabian Grünbichler
11eafa5b6b fix #6362: qm: remove duplicate 'only'
Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2025-04-28 10:42:17 +02:00
Fabian Grünbichler
1598c6a891 fix #6361: pvecm: replace 'packages' with 'packets'
where appropriate.

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2025-04-28 10:41:32 +02:00
Fabian Grünbichler
ad48183c11 fix #6360: properly quote tags in example
Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2025-04-28 10:40:13 +02:00
Aaron Lauterer
57cdb88224 firmware-updates: align apt upgrade to apt full-upgrade
Because 'apt-get upgrade' or 'apt upgrade' will not pull in potential
new dependencies and that could lead to a broken system.
'apt-get dist-ugprade' or 'apt full-upgrade' will install new
dependencies when needed.

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2025-04-11 10:36:37 +02:00
Thomas Lamprecht
fbb84a2b4c notifications: reflow to 80 cc text-width and indent points in lists
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-04-09 10:09:21 +02:00
Lukas Wagner
56f3d84b75 notifications: add section about how to use custom templates
This section is meant to give a basic overview on how to use
custom templates for notifications. It will be expanded in the
future, providing a more detailed view on how templates are resolved,
existing fallback mechanisms, available templates, template
variables and helpers.

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
Reviewed-by: Alexander Zeidler <a.zeidler@proxmox.com>
Link: https://lore.proxmox.com/20250409074713.55474-1-l.wagner@proxmox.com
2025-04-09 10:02:36 +02:00
Thomas Lamprecht
a3479f7fb6 bump version to 8.4.0
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-04-09 09:00:27 +02:00
Thomas Lamprecht
46601a3245 update static/schema information
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-04-09 08:53:50 +02:00
Markus Frank
907860602f virtiofs: add a description of how to install virtiofsd
Signed-off-by: Markus Frank <m.frank@proxmox.com>
2025-04-09 07:58:05 +02:00
Fiona Ebner
23123df035 qm: virtiofs: drop writeback cache
VirtIO-fs using writeback cache seems very broken at the moment. If a
guest accesses a file (even just using 'touch'), that the host is
currently writing, the guest can permanently end up with a truncated
version of that file. Even subsequent operations like moving the file,
will not result in the correct file being visible, but just rename the
truncated one.

Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
2025-04-08 17:31:47 +02:00
Thomas Lamprecht
9afbde533d qemu: consistently use virtiofs term
Upstream always uses virtiofs besides inside the projects URL, which
I'd just ignore.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-04-08 17:17:47 +02:00
Thomas Lamprecht
1aaa3ecbb6 bump version to 8.3.2
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-04-07 23:17:11 +02:00
Thomas Lamprecht
5ba4beea55 update static/schema information
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-04-07 22:59:21 +02:00
Markus Frank
acc3795eed add doc section for the shared filesystem virtio-fs
Signed-off-by: Markus Frank <m.frank@proxmox.com>
Reviewed-by: Daniel Kral <d.kral@proxmox.com>
Link: https://lore.proxmox.com/20250407134950.265270-2-m.frank@proxmox.com
2025-04-07 22:34:22 +02:00
Fiona Ebner
ea689f14a6 backup: warn that tar does not honor exclusion pattern with a trailing slash
As reported in the community forum [0], for tar, an exclusion pattern
with a trailing slash will not match a folder with that name. For
rsync and proxmox-backup-client however, such a pattern will exclude
a directory with that name, but not a file.

rsync is used for 'suspend' mode backup and tar is used for all
non-PBS backups to create the archive. So currently, in the presence
of an exclusion pattern with a trailing slash, there is inconsistency
between different backup modes (because for 'suspend' mode, rsync will
already do the exclusion too) as well as between PBS and non-PBS
backups.

There doesn't seem to be a straight-forward way to align the behavior
for tar with command-line options exactly. The trailing slash can't be
removed from the pattern, because that would also match files.
Matching with
> some/pattern/*
> some/pattern/.*
rather than
> some/pattern/
gets pretty close, which was suggested by Dominik. Just the empty
directory is still included.

In any case, modifying current behavior would be a breaking change, so
actually aligning the exclusion (more closely) is better done in the
next major release.

Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
2025-04-07 19:39:13 +02:00
Thomas Lamprecht
6ef9ff4488 sdn: evpn: refer to existing section for installing frr
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-04-07 15:45:28 +02:00
Thomas Lamprecht
9e380a08b3 sdn: evpn: mention that frr service needs to be enabled now
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-04-07 15:40:26 +02:00
Shannon Sterz
1edaf7c98b sdn: drop frr from packages required by the evpn controller
frr is already shipped as part of pve now and does not need to be
installed separatelly.

Signed-off-by: Shannon Sterz <s.sterz@proxmox.com>
Link: https://lore.proxmox.com/20250407121622.154327-1-s.sterz@proxmox.com
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-04-07 15:40:26 +02:00
Markus Frank
5bf2d0f02a amd-sev: add SEV-SNP infos and improve documentation
add SEV-SNP limitations, example configuration and hyperlinks for more
information

Signed-off-by: Markus Frank <m.frank@proxmox.com>
Link: https://lore.proxmox.com/20250404114456.304222-1-m.frank@proxmox.com
 [TL: fix typo in virtualization]
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-04-07 15:40:26 +02:00
Daniel Kral
528fe5d7f3 storage: add remaining pvesm scan command examples
Add an example for the `pvesm scan` command to storage plugins, i.e.
GlusterFS and PBS, where it exists in the CLI but is not mentioned yet
in the documentation.

Signed-off-by: Daniel Kral <d.kral@proxmox.com>
Link: https://lore.proxmox.com/20250304100915.55114-3-d.kral@proxmox.com
2025-04-07 15:20:37 +02:00
Daniel Kral
28eb02fb33 storage: change to newer pvesm scan subcommands in examples
Update the examples to use the newer `pvesm scan` subcommands instead of
their backwards compatibility aliases to encourage new users to use the
new subcommand.

Signed-off-by: Daniel Kral <d.kral@proxmox.com>
Link: https://lore.proxmox.com/20250304100915.55114-2-d.kral@proxmox.com
2025-04-07 15:20:37 +02:00
Daniel Kral
500faf0743 storage: make description of storage CLI examples more consistent
Make the text for `pvesm scan` and `pvesm add` command examples more
consistent by introducing `pvesm scan` with "You can get ... with", as
it is already done for other storage plugins, and changing from past
tense to present tense in existing descriptions for the `pvesm add` as
recommended in the Technical Writing Style Guide for instructions [0].

While at it, replace the term "share" with the more appropriate
"datastore" for the example in the PBS section.

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

Signed-off-by: Daniel Kral <d.kral@proxmox.com>
Link: https://lore.proxmox.com/20250304100915.55114-1-d.kral@proxmox.com
2025-04-07 15:20:37 +02:00
Fiona Ebner
2ad2c765e9 user management: clarify that password changes for PAM realm only apply to local node
Reported in the community forum:
https://forum.proxmox.com/threads/158518/

Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
2025-04-06 19:55:01 +02:00
Thomas Lamprecht
5107b302d3 virtual machines: rework & extend PVE machine version section
Make the PVE machines a sub point of the overall machine version, as
they are not really different, but only extend the mechanism we
already used by something we can directly control. I tried to extend
the previously existing machine version to also describe that we use
that version for deciding what to enabled/change on the PVE side,
i.e., not just what QEMU exposes, and also reduce some verbosity with
regard to implementation details.

While at it, I replaced the first-person plural (we) use with third
person indicative mood as documented in our style guide [0].

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

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-04-06 19:47:27 +02:00
Dominik Csapak
78b8af75be qm: pve machine version: add section to explain +pveX versions
and clarify what windows guests will be pinned to.

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
Reviewed-by: Stoiko Ivanov <s.ivanov@proxmox.com>
Tested-By: Stoiko Ivanov <s.ivanov@proxmox.com>
Link: https://lore.proxmox.com/20250404125345.3244659-10-d.csapak@proxmox.com
2025-04-06 19:14:35 +02:00
Friedrich Weber
72c9efe062 pvenode: document ballooning-target node option
Also adjust the ballooning documentation to mention and
cross-reference this node option.

Signed-off-by: Friedrich Weber <f.weber@proxmox.com>
Tested-by: Stoiko Ivanov <s.ivanov@proxmox.com>
Reviewed-by: Stoiko Ivanov <s.ivanov@proxmox.com>
Link: https://lore.kernel.org/r/20250312151506.128311-5-f.weber@proxmox.com
2025-04-05 18:05:12 +02:00
Gabriel Goller
f332026019 add consent-banner description
Signed-off-by: Gabriel Goller <g.goller@proxmox.com>
 [TL: prefix anchor with gui_ like all others in the chapter...]
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-04-04 20:05:33 +02:00
Thomas Skinner
722747c816 fix #4234: add docs for openid optional userinfo request
Signed-off-by: Thomas Skinner <thomas@atskinner.net>
Tested-by: Mira Limbeck <m.limbeck@proxmox.com>
2025-04-04 16:09:36 +02:00
Thomas Skinner
058258e746 fix #4411: openid: add docs for openid groups support
Signed-off-by: Thomas Skinner <thomas@atskinner.net>
Tested-by: Mira Limbeck <m.limbeck@proxmox.com>
Reviewed-by: Mira Limbeck <m.limbeck@proxmox.com>
2025-04-04 14:52:20 +02:00
Christoph Heiss
0bbe5070ab pveum: document correct path for ldap/realm credentials
/etc/pve/priv/realm has been the default path since commit

  782b702db ("auth ldap/ad: make password a parameter for the api")

That commit was part of pve-access-control 6.0-7.

Replace /etc/pve/priv/ldap with /etc/pve/priv/realm, to avoid pointing
users to the deprecated path.

It's not used anywhere in our code too, except as (very) old fallback.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2025-04-04 12:18:33 +02:00
Thomas Lamprecht
e84fa159d5 update static/schema information
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-04-03 18:34:07 +02:00
Dominik Csapak
33f614f346 qm: resource mapping: document live-migration-capable setting
Reviewed-by: Christoph Heiss <c.heiss@proxmox.com>
Reviewed-by: Fiona Ebner <f.ebner@proxmox.com>
Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
2025-04-03 18:29:26 +02:00
Dominik Csapak
fe444d6e43 qm: resource mapping: add description for mdev option
in a new section about additional options

Reviewed-by: Christoph Heiss <c.heiss@proxmox.com>
Reviewed-by: Fiona Ebner <f.ebner@proxmox.com>
Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
2025-04-03 18:29:26 +02:00