Commit Graph

2158 Commits

Author SHA1 Message Date
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
Aaron Lauterer
2c12c2b1d5 qm, vzdump: add notes regarding backups of windows and VSS
VSS in windows guests with additional backup software in the guest can
cause problems. By now the guest agent does support to use a different
VSS option. This way, one can switch to one that does not interfere with
other backup solutions.

Mention it in the docs and link to the wiki article that explains it.

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
Reviewed-by: Alexander Zeidler <a.zeidler@proxmox.com>
2025-03-28 11:30:24 +01:00
Aaron Lauterer
0c2dcfce35 pveceph: destroy osd: rework to make it easier to read
* rephrased some parts
* split large paragraphs
* put CLI commands into own code blocks instead of being inline
* added step to wait until rebalance after OUT is finished

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2025-03-24 17:34:58 +01:00
Aaron Lauterer
c49d3f328c pveceph: annotate code blocks as bash
to have them set to the same highlighting scheme throughout the chapter

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2025-03-24 17:10:24 +01:00
Aaron Lauterer
41292dab6e pveceph: troubleshooting maintenance: rework to have CLI commands in blocks
having CLI commands in their own blocks instead of inline makes them
stand out quickly and a lot easier to copy & paste.

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2025-03-24 17:10:02 +01:00
Alexander Zeidler
9676a0d867 pvecm: remove node: mention Ceph and its steps for safe removal
as it has already been missed in the past or the proper procedure was
not known.

Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>
2025-03-24 16:06:22 +01:00
Alexander Zeidler
0a52307436 ceph: maintenance: revise and expand section "Replace OSDs"
Remove redundant information that is already described in section
“Destroy OSDs” and link to it.

Mention and link to the troubleshooting section, as replacing the OSD
may not fix the underyling problem.

Mention that the replacement disk should be of the same type and size
and comply with the recommendations.

Mention how to acknowledge warnings of crashed OSDs.

Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>
2025-03-24 16:06:22 +01:00
Alexander Zeidler
84ba04863c ceph: osd: revise and expand the section "Destroy OSDs"
Existing information is slightly modified and retained.

Add information:
* Mention and link to the sections "Troubleshooting" and "Replace OSDs"
* CLI commands (pveceph) must be executed on the affected node
* Check in advance the "Used (%)" of OSDs to avoid blocked I/O
* Check and wait until the OSD can be stopped safely
* Use `pveceph stop` instead of `systemctl stop ceph-osd@<ID>.service`
* Explain cleanup option a bit more

Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>
2025-03-24 16:06:22 +01:00
Alexander Zeidler
70b3fb96e1 ceph: troubleshooting: revise and add frequently needed information
Existing information is slightly modified and retained.

Add information:
* List which logs are usually helpful for troubleshooting
* Explain how to acknowledge listed Ceph crashes and view details
* List common causes of Ceph problems and link to recommendations for a
  healthy cluster
* Briefly describe the common problem "OSDs down/crashed"

Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>
[AL]: use old anchor to sub chapter that was kept to not break links
Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2025-03-24 16:06:22 +01:00
Alexander Zeidler
402893065f ceph: correct heading capitalization
Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>
2025-03-24 16:06:22 +01:00
Alexander Zeidler
dc1e865824 ceph: add anchors for use in troubleshooting section
Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>
[AL]: revert and fix subchapter anchor to autogenerated one to not break links
Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2025-03-24 16:05:55 +01:00
Shannon Sterz
4cd548b5cc pveum: switch OATH 2.0 to the correct OAuth 2.0; use pve not Proxmox
this switches the use of OATH 2.0 to the correct spelling of OAuth
2.0.

it also makes it clear that the OpenID Connect Discovery protocol is
used by Proxmox VE the product, not Proxmox the company. otherwise,
users could have gotten the impression that data is processed on
company servers.

Signed-off-by: Shannon Sterz <s.sterz@proxmox.com>
2025-03-04 16:34:49 +01:00
Thomas Lamprecht
4135209755 introduction: update and extend project history
Mostly adds a history overview for PVE 5 and newer releases.

The existing history was only touched up a bit language wise, the diff
looks more involved due to formatting the text with an 80 character
column limit, use git diff's word-diff feature to see what actually
changed there.

Authored-by: Dominik Bohn <d.bohn@proxmox.com>
 [TL: add more links to external and internal references]
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-03-04 14:21:13 +01:00
Fiona Ebner
b0531128a7 guest-example-hookscript: use double hyphen instead of single hyphen in documented commands
Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
2025-02-26 16:17:27 +01:00
Maximiliano Sandoval
71817453dd guest-example-hookscript: fix Exmple typo
Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
2025-02-26 16:12:36 +01:00
Christoph Heiss
64e7f07aa6 installation: adapt to raised root password length requirement
It's been raised in the installer across the board, so adapt it here
too.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2025-02-24 12:14:03 +01:00
Alexander Zeidler
4472a4a5b9 installation: unattended: sync the section with the wiki introduction
so that there are not two different versions of the introduction and
users mistakenly think they have already read the introduction in the
admin guide.

Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>
 [ AL: use {pve} and format boot option for easier recognizion ]
Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2025-02-19 17:57:19 +01:00
Thomas Skinner
7da9c0cf1c fix #5699: pveproxy: add docs for real IP support
Signed-off-by: Thomas Skinner <thomas@atskinner.net>
2025-01-24 09:36:59 +01:00
Fiona Ebner
5b4f685606 qm: machine version: document support in PVE
Elaborate on new QEMU machine version removal policy and how PVE will
support machine versions.

Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
2025-01-17 19:54:52 +01:00
Aaron Lauterer
2bf0dff0af pvesr: mention how to configure specific network for replication
Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2024-12-09 19:53:15 +01:00
Aaron Lauterer
6b4b612430 pvecm: add anchor for the migration network chapter
Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2024-12-09 19:53:15 +01:00