Commit Graph

2135 Commits

Author SHA1 Message Date
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
Fiona Ebner
0366eb1a5e pvesr: tiny style/language improvement
Add a "the" for better readability and a dot at the end to be
consistent with the other items in the list.

Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
2024-11-29 16:12:26 +01:00
Aaron Lauterer
e5f7974987 pvesr: fix possible issues storage ID
The same storage needs to be configured on the target node for the
replication to work.

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2024-11-29 15:56:21 +01:00
Thomas Lamprecht
08fb5f9a79 ha: update CRM docs a bit
To better describe the long time existing status quo and mention the
new auto idle, while not changing much in practice it should be
documented in any way.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-11-20 22:38:08 +01:00
Thomas Lamprecht
a89cb75f36 bump version to 8.3.1
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-11-20 21:19:46 +01:00
Thomas Lamprecht
656d56ab51 Revert "increase verbosity of sdn dhcp docs."
This reverts commit 3e42197c54, it was
not intended to be applied already.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-11-20 17:53:27 +01:00
Aaron Lauterer
608887b210 sdn: port isolation: remove superfluous the
Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2024-11-20 17:49:45 +01:00
Daniel Herzig
3e42197c54 increase verbosity of sdn dhcp docs.
These minor additions to and rearrangements within the
documentation target easier accessibility for the SDN DHCP feature.

Signed-off-by: Daniel Herzig <d.herzig@proxmox.com>
2024-11-20 17:00:39 +01:00
Aaron Lauterer
b074964d6f pvesdn: add note to port isolation to use firewall in clusters
since port isolation is only local on the host. To get better port
isolation, the VNET firewall can be used.

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2024-11-20 16:56:45 +01:00
Aaron Lauterer
e3818925ad pvesdn: add chapter reference for sdn firewall
Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2024-11-20 16:56:45 +01:00
Thomas Lamprecht
718f326690 bump version to 8.3.0
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-11-20 11:59:08 +01:00
Dominik Csapak
a6bb595ed8 qm: import: use consistent capitalization for web UI
Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
2024-11-20 11:52:40 +01:00
Thomas Lamprecht
cc9dad4f01 update static/schema information
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-11-20 11:52:33 +01:00
Thomas Lamprecht
3734b4f879 bump version to 8.2.5
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-11-19 18:54:16 +01:00
Stefan Hanreich
ae064a1ed2 sdn: add documentation for isolated ports option
Signed-off-by: Stefan Hanreich <s.hanreich@proxmox.com>
2024-11-19 17:49:31 +01:00
Dominik Csapak
9a282ae974 qm: adapt import section to newly added OVA/OVF import
remove reference to future ova support and only esxi as supported.

Add extra OVA/OVF section explaining some caveats.

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
2024-11-19 16:06:58 +01:00
Stefan Hanreich
cda6d6418a firewall: add documentation for forward direction and vnet zone
Added a new direction section, mostly so I can write about the forward
direction and explain its use cases.

Signed-off-by: Stefan Hanreich <s.hanreich@proxmox.com>
2024-11-19 16:02:54 +01:00
Stefan Hanreich
4f7c386b6a sdn: add documentation for firewall integration
Signed-off-by: Stefan Hanreich <s.hanreich@proxmox.com>
2024-11-19 16:02:51 +01:00
Friedrich Weber
39dff49d81 ceph: fix two broken lists
The two lists were missing the initial empty line and were
consequently rendered as inline text, which made them hard to read.

Signed-off-by: Friedrich Weber <f.weber@proxmox.com>
2024-11-19 12:03:40 +01:00
Thomas Lamprecht
9cd1ca7852 update static/schema information
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-11-19 12:03:28 +01:00
Markus Frank
ee6ba5d24d qm: add AMD SEV documentation
add documentation for the qemu-server patch series to add AMD SEV
support.

Signed-off-by: Markus Frank <m.frank@proxmox.com>
 [ TL: fleece in wording improvement suggested by Shannon ]
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-11-18 21:37:08 +01:00
Fiona Ebner
4ea02b32a3 cli appendix: reference section about casing style
The section about casing style also applies to CLI option names.

Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
2024-11-17 19:34:24 +01:00
Fiona Ebner
f32bdb8997 configuration files: add general section
Explain the mixed casing styles for (sub-)properties in configuration
files and plans regarding the future.

Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
2024-11-17 19:34:24 +01:00
Christian Ebner
b38ef259d1 docs: drop experimental warning for change detection modes
Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
2024-11-17 18:36:04 +01:00