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

2273 Commits

Author SHA1 Message Date
Thomas Lamprecht
e54926758d package repos: reword note w.r.t. disablign repos
While apt supports both false/true and yes/no (and maybe more?), the
sources.list manual page documents "Enabled: no", so lets use that
here too.

Drop a duplicate "of" and reword the whole not a bit.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-09-19 09:39:22 +02:00
Stoiko Ivanov
a44a78ae46 package-repos: fix disabling deb822 repository instructions
noticed this and the missing full-stop while carrying over the
changes to pmg-docs.

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
Link: https://lore.proxmox.com/20250918184850.2808572-1-s.ivanov@proxmox.com
2025-09-19 09:35:51 +02:00
Fabian Grünbichler
a4ad4f48b9 lvm: add note about requirements of snapshot-as-volume-chains
Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
Link: https://lore.proxmox.com/20250725095208.249266-1-f.gruenbichler@proxmox.com
2025-09-17 14:44:10 +02:00
Thomas Lamprecht
b00a14c3e6 asciidoc-pve: fix some typos
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-09-16 22:28:14 +02:00
Fiona Ebner
4e220f8aac qm: ovmf: mention that an RNG device is required for PXE boot
The restriction was added with an update to the EDK2 packages for
Proxmox VE 8.4. The issue was mentioned in the known issues section,
but should also be mentioned in the docs as requested here:
https://bugzilla.proxmox.com/show_bug.cgi?id=2767#c5

Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
Link: https://lore.proxmox.com/20250814111358.235632-1-f.ebner@proxmox.com
2025-09-10 15:44:26 +02:00
Friedrich Weber
feb34c347c pvecm: redundancy: explicitly mention subnets
The section uses addresses 10.10.10.X and 10.20.20.X in examples and
implicitly assumes they are in disjoint subnets, but does not
explicitly state this.

For better clarity, explicitly mention these are /25 subnets (this
subnet mask is also used in the "Separate Cluster Network" section).

Signed-off-by: Friedrich Weber <f.weber@proxmox.com>
Reviewed-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
Link: https://lore.proxmox.com/20250908145305.112814-1-f.weber@proxmox.com
2025-09-09 17:35:14 +02:00
Thomas Lamprecht
8444abd5a6 update static/schema information
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-09-05 21:02:52 +02:00
Christoph Heiss
60d2f90743 update generated cli synopsis files
Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
Link: https://lore.proxmox.com/20250812095637.444463-6-c.heiss@proxmox.com
2025-09-05 20:51:20 +02:00
Christoph Heiss
33550ee942 fix #6656: asciidoc: add anchor links for paragraphs with ids
Fixes [0].

All paragraphs with have `id` tags will now have an anchor (shown on
hover) besides their title, thus making these sections easily linkable
somewhere else.

[0] https://bugzilla.proxmox.com/show_bug.cgi?id=6656

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
Link: https://lore.proxmox.com/20250812095637.444463-5-c.heiss@proxmox.com
2025-09-05 20:51:17 +02:00
Thomas Lamprecht
8af9f6b0ff update static/schema information
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-09-04 15:55:14 +02:00
abobakr mohammed
2f1e3b3c03 ha: correct in-text references to available ha rule types
Correct affinity rule descriptions in Table 2
Change "seperate" to "negative".

Signed-off-by: abobakr mohammed <a.mohammed@proxmox.com>
Link: https://lore.proxmox.com/20250902130853.278850-1-a.mohammed@proxmox.com
2025-09-03 18:09:16 +02:00
Fiona Ebner
c3f613396b pct: cgroup: update to cgroupv2 being the only supported mode
As already mentioned in the known issues in the roadmap [0], cgroupv2
is the only supported mode in Proxmox VE 9.

To not break any references, because Proxmox VE 8 is not EOL yet, keep
the section about changing the cgroup version.

[0]: https://pve.proxmox.com/wiki/Upgrade_from_8_to_9#cgroup_V1_Removal

Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
2025-08-27 13:59:38 +02:00
Maximiliano Sandoval
012c31e15a pvesr: Document replication network setting
Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
Reviewed-by: Shannon Sterz <s.sterz@proxmox.com>
Link: https://lore.proxmox.com/20250721144411.326170-1-m.sandoval@proxmox.com
[FE: add missing commas]
Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
2025-08-14 15:42:16 +02:00
Thomas Lamprecht
b822a160a3 faq: Proxmox VE 9 got released, fix date
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-08-06 10:42:13 +02:00
Thomas Lamprecht
68ca31b535 network: improve title wording and casing
Use title case and avoid having absolutely no context headings like
"Manual Method".

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-08-06 10:10:30 +02:00
Thomas Lamprecht
6fa010b88a bump version to 9.0.8
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-08-05 16:04:49 +02:00
Daniel Kral
62815c23d8 ha: replace in-text references to ha groups with ha rules
As HA groups are replaced by HA node affinity rules and HA rules became
more powerful than before now, update texts that reference HA groups
with references to HA rules instead.

Signed-off-by: Daniel Kral <d.kral@proxmox.com>
Link: https://lore.proxmox.com/20250805075944.35405-4-d.kral@proxmox.com
2025-08-05 15:34:43 +02:00
Daniel Kral
aecd8e5497 ha: mark ha groups as deprecated and note migration to node affinity rules
As the migration is handled automatically by the HA Manager now instead
of manual user migration, the notice should be placed in the HA Groups
section instead.

Signed-off-by: Daniel Kral <d.kral@proxmox.com>
Link: https://lore.proxmox.com/20250805075944.35405-3-d.kral@proxmox.com
2025-08-05 15:34:43 +02:00
Daniel Kral
da333059f5 ha: rules: document crs behavior for split positive resource affinity
Signed-off-by: Daniel Kral <d.kral@proxmox.com>
Link: https://lore.proxmox.com/20250805075944.35405-2-d.kral@proxmox.com
2025-08-05 15:34:43 +02:00
Daniel Kral
72f874e505 ha: rules: update about mixed usage of node and resource affinity rules
As HA resources can be part of node and resource affinity rules at the
same time in simpler cases, update the relevant sections about specific
interactions and restrictions.

Signed-off-by: Daniel Kral <d.kral@proxmox.com>
Link: https://lore.proxmox.com/20250805075944.35405-1-d.kral@proxmox.com
2025-08-05 15:34:43 +02:00
Stefan Hanreich
3f1bf7305d network: update name of pinning tool
Has been changed from proxmox-network-interface-pinning to
pve-network-interface-pinning for the initial release, since we do not
include the standalone rust tool for now.

Signed-off-by: Stefan Hanreich <s.hanreich@proxmox.com>
Link: https://lore.proxmox.com/20250805122701.231702-1-s.hanreich@proxmox.com
2025-08-05 15:33:50 +02:00
Thomas Lamprecht
86a084c20d bump version to 9.0.7
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-08-04 23:08:51 +02:00
Daniel Kral
c61403fb66 ha: affinity rules: simplify overly verbose rule conflicts and errors section
Suggested-by: Hannes Dürr <h.duerr@proxmox.com>
Signed-off-by: Daniel Kral <d.kral@proxmox.com>
Link: https://lore.proxmox.com/20250804141204.207216-1-d.kral@proxmox.com
2025-08-04 23:07:34 +02:00
Thomas Lamprecht
a658d631ec update static/schema information
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-08-04 20:31:15 +02:00
Aaron Lauterer
089005898c pvecm: adapt bold highlights to mark the specific important parts
Suggested-by: Mira Limbeck <m.limbeck@proxmox.com>
Link: https://lore.proxmox.com/1e99dced-9619-417a-93a8-603abfc3579e@proxmox.com/
Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2025-08-04 16:51:09 +02:00
Friedrich Weber
0db8bc382e pvecm, network: add section on corosync over bonds
Testing has shown that running corosync (only) over a bond can be
problematic in some failure scenarios and for certain bond modes. The
documentation only discourages bonds for corosync because corosync can
switch between available networks itself, but does not mention other
caveats when using bonds for corosync.

Hence, extend the documentation with recommendations and caveats
regarding bonds for corosync.

Signed-off-by: Friedrich Weber <f.weber@proxmox.com>
Reviewed-by: Mira Limbeck <m.limbeck@proxmox.com>
Link: https://lore.proxmox.com/20250730085836.147270-1-f.weber@proxmox.com/
2025-08-04 16:50:52 +02:00
Stefan Hanreich
8971b2581c network: update documentation for network-interface-pinning
It is now possible to use arbitrary prefix names and target names for
network interfaces. Update the documentation to reflect this behavior
and add some more examples.

Signed-off-by: Stefan Hanreich <s.hanreich@proxmox.com>
Link: https://lore.proxmox.com/20250731121827.311601-1-s.hanreich@proxmox.com
2025-07-31 14:31:33 +02:00
Thomas Lamprecht
72a32081e8 bump version to 9.0.6
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-31 11:49:54 +02:00
Thomas Lamprecht
8d075eca17 update static/schema information
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-31 11:48:36 +02:00
Daniel Kral
561bc05598 ha: add documentation about ha resource affinity rules
Add documentation about HA Resource Affinity rules, what effects those
have on the CRS scheduler, and what users can expect when those are
changed.

There are also a few points on the rule conflicts/errors list which
describe some conflicts that can arise from a mixed usage of HA Node
Affinity rules and HA Resource Affinity rules.

Signed-off-by: Daniel Kral <d.kral@proxmox.com>
Link: https://lore.proxmox.com/20250730181428.392906-16-d.kral@proxmox.com
2025-07-31 10:25:34 +02:00
Thomas Lamprecht
c4dbca1959 bump version to 9.0.5
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-31 08:48:31 +02:00
Thomas Lamprecht
68ef55e2ee update static/schema information
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-31 08:48:10 +02:00
Daniel Kral
a54738d2a3 ha: crs: add effects of ha node affinity rule on the crs scheduler
Add information about the effects that HA rules and HA Node Affinity
rules have on the CRS scheduler and what can be expected by a user if
they do changes to them.

Signed-off-by: Daniel Kral <d.kral@proxmox.com>
Link: https://lore.proxmox.com/20250730175957.386674-26-d.kral@proxmox.com
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-31 08:48:10 +02:00
Daniel Kral
78121711f0 ha: add documentation about ha rules and ha node affinity rules
Add documentation about HA Node Affinity rules and general documentation
what HA rules are for in a format that is extendable with other HA rule
types in the future.

Signed-off-by: Daniel Kral <d.kral@proxmox.com>
Link: https://lore.proxmox.com/20250730175957.386674-25-d.kral@proxmox.com
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-31 08:48:10 +02:00
Thomas Lamprecht
bdcb3649fe auto-format code using perltidy with Proxmox style guide
using the new top-level `make tidy` target, which calls perltidy via
our wrapper to enforce the desired style as closely as possible.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-31 06:37:13 +02:00
Thomas Lamprecht
04e2dd09ee asciidoc-pve scan-exjts: add allow-missing option to make bootstrapping easier
Often, when one reviews or applies a series that adds new
documentation and UI (e.g., new feature) it's annoying to not be able
to build the UI if it already points to new onlineHelp info
definitions, so add a flag that allows during the hard error into a
warning.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-31 06:32:47 +02:00
Thomas Lamprecht
84f43eb2ea package repos: ceph: hide tentacle for now until we actually have it available somewhere
which needs an upstream release first.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-31 05:26:11 +02:00
Thomas Lamprecht
ae7db763e7 package repos: ceph: move long EOL column header out to attribute
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-31 05:25:44 +02:00
Alexander Zeidler
2b32abd4de package repos, software updates: revise Ceph section
- Start by mentioning the preconfigured Ceph repository and what options
  there are for using Ceph (HCI and external cluster)
- Link to available installation methods (web-based wizard, CLI tool)
- Describe when and how to upgrade
- Add new attributes to avoid manual editing multiple lines
- Create a table as an overview of Ceph release availability,
  maintaining clarity and avoiding duplicated text for each release
- Advise to read the latest version of the corresponding admin guide
- Add a TODO describing what to update occasionally
- List and link to the estimated EOL dates of Ceph releases
- Revise the descriptions of available repository components
- Mention when it makes sense to edit a repository file manually

- Mention upgrading Ceph under "System Software Updates"

Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>
Link: https://lore.proxmox.com/20250730180254.320235-1-a.zeidler@proxmox.com
2025-07-31 03:07:33 +02:00
Thomas Lamprecht
62a3250538 html: rework index to order chapters and avoid visual noise
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-31 03:06:10 +02:00
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