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>
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>
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>
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
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
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
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>
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
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>
/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>
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>
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>
* 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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
