Commit Graph

1907 Commits

Author SHA1 Message Date
Noel Ullreich
451839ed51 Consistency of USB flash drive spelling
To be consistent, replaced all synonyms of USB flash drive (e.g. thumb
drive, drive, stick)

Signed-off-by: Noel Ullreich <n.ullreich@proxmox.com>
2023-11-17 10:54:24 +01:00
Noel Ullreich
42dfa5e964 Consistency: change mainboard to motherboard
To be consistent, replaced all instances of mainboard/main board with
motherboard.

Signed-off-by: Noel Ullreich <n.ullreich@proxmox.com>
2023-11-17 10:54:24 +01:00
Noel Ullreich
9632a85d3a Consistency of passthrough/pass-through
Fix consistency issues as well as grammatical mistakes with the spelling
of passthough/pass-through/pass through in the pve docs

Signed-off-by: Noel Ullreich <n.ullreich@proxmox.com>
2023-11-17 10:54:24 +01:00
Friedrich Weber
96c0261845 fix #4847: network: extend section on interface naming scheme
Expand the existing section on systemd network interface names with a
link to the systemd.net-naming-scheme(7) manpage and some information
about naming scheme versions. Also mention the possibility of
interface naming changes due to a new naming scheme version, or
kernel/driver updates. This happens for quite some users during the
upgrade from PVE 7 to 8.

Further, describe how to pin a specific naming scheme version and how
to override interface names using systemd.link files.

Also, make some formatting fixes to the existing text.

Signed-off-by: Friedrich Weber <f.weber@proxmox.com>
2023-11-17 10:17:44 +01:00
Thomas Lamprecht
7367ba5beb ceph: add more details for private/public network usage and distinction
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-11-12 19:06:44 +01:00
Thomas Lamprecht
3885be3bd0 ceph: rework introduction and recommendation section
Add more headings, update some recommendations to current HW (e.g.,
network and NVMe attached SSD) capabilities and expand recommendations
taking current upstream documentation into account.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-11-12 18:59:30 +01:00
Thomas Lamprecht
ff0c3ed1f9 qm: add headings and references for machine-version sections
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-11-12 18:59:30 +01:00
Fiona Ebner
cecc8064dc qm: add section about machine types
expanding from the two currently existing sentences. In the first one, a
typo VMs -> VM's is fixed. In the second one, "one wants to" is changed
to "you want to", because the sentence already starts with "You can" and
it's active voice.

Adds information about the machine version, rationale behind the
defaults for it and what to do for deprecated versions.

Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
2023-11-12 18:59:30 +01:00
Thomas Lamprecht
9e16e514c3 ui: reword user-menu header docs
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-11-02 20:46:31 +01:00
Dominik Csapak
039bc01103 ui: correct outdated info about entries in the top header
The header part of the gui did change already a few releases ago.
The user name was moved into a menu button, which now contains more
user specific actions.

So, update the section to document the current layout and ui elements
again correctly.

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
2023-11-02 20:44:48 +01:00
Thomas Lamprecht
8bad0dead6 firmware: reword ucode version hint
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-10-30 14:08:41 +01:00
Thomas Lamprecht
113290b8b0 firmware: rework setting up OS ucode updates to actionable list
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-10-30 14:06:50 +01:00
Alexander Zeidler
48ae572140 sysadmin: revise firmware chapter, add firmware repo section
Chapter "Firmware Updates":
* improve the structure and clarity of information provided
* mention which update methods are when available/recommended
* add information about the already pre-installed pve-firmware package
* emphasise the importance of CPU microcode updates, how to interpret
  versions and how to recover a possibly unbootable system
* move info about non-free-firmware repo to "Package Repositories"

Chapter "Package Repositories":
* add new section "Debian Firmware Repository"

Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>
2023-10-30 13:47:03 +01:00
Alexander Zeidler
c6284866ef ha-manager, software updates: add useful anchors
Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>
2023-10-30 13:46:11 +01:00
Thomas Lamprecht
8dcad10c19 ha: maintenance mode: fix grammar and reword
This was a bit complex while leaving out some key info, like that
HA groups also play into the target selection, not only CRS.

Try to improve on that.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-10-27 16:41:21 +02:00
Maximiliano Sandoval R
4064225d51 ha: Explicitly mention that migrations only affect HA guests
Signed-off-by: Maximiliano Sandoval R <m.sandoval@proxmox.com>
2023-10-27 16:19:54 +02:00
Thomas Lamprecht
8a1de6bfd0 zfs: add extra hint for raidz consideration section
For those that jump directly to this part of the docs without seeing
the extra section first.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-10-27 16:19:54 +02:00
Thomas Lamprecht
5f440d2c67 zfs: improve and expand on ZIL and cache sections
The ZIL section was copied over from the cache one, but not fully
adapted, so it wrongly talked about cache devices, as recently
reported by a user.

Improve on that and expand those sections in general.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-10-27 16:19:54 +02:00
Fabian Grünbichler
065b214708 sdn: fix phrasing
Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2023-10-25 13:02:28 +02:00
Alexandre Derumier
e59000139d sdn: add isis controller documentation 2023-10-25 13:00:42 +02:00
Alexandre Derumier
4cf52a0cc0 sdn: add notes about bgp controller 2023-10-25 13:00:42 +02:00
Maximiliano Sandoval R
ac46aa0474 installation: document UP indicator in network setup
See
https://git.proxmox.com/?p=pve-installer.git;a=commit;h=124ca33f9fb3780a76f0b5fd57952e69823852c8.

Signed-off-by: Maximiliano Sandoval R <m.sandoval@proxmox.com>
2023-10-23 17:35:08 +02:00
Thomas Lamprecht
e3c4d0ac7c faq: use only major release version in EOL table
and adapt the one from Proxmox VE 6 to what was the effective date
when we stopped providing updates.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-10-18 18:58:27 +02:00
Thomas Lamprecht
c9f91b12bb boot: kernel cmdline: clarify where kernel version/docs can be found
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-10-18 18:56:48 +02:00
Noel Ullreich
9dbab4f895 qemu: update the PCI(e) docs
A little update to the PCI(e) docs. The PCI wiki article has been
reworked as well, in line with changes from this patch.

Along some minor grammar fixes added:
 * how to check if kernel modules are being loaded
 * how to check which drivers to blacklist
 * how to add softdeps for module loading
 * where to find kernel params

Signed-off-by: Noel Ullreich <n.ullreich@proxmox.com>
 [ TL: squash in dropping two trailing whitespace errors ]
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-10-18 18:51:14 +02:00
Stefan Hrdlicka
cdf9d3f927 fix #2920: add cifs options parameter
Signed-off-by: Stefan Hrdlicka <s.hrdlicka@proxmox.com>
[FE: rebase + style fix]
Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
2023-09-27 16:36:50 +02:00
Thomas Lamprecht
0aa61e0478 ct: update broken link to CentOS release EOL
Use Wikipedia, as it seems CentOS cannot be bothered to create a sane
supported releases + EOL dates table themselves anymore..

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-09-21 15:44:33 +02:00
Thomas Lamprecht
14fc766eae sdn: update netbox api-token docs link
Found by Fabian using the mlc tool [0].
[0]: https://crates.io/crates/mlc

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-09-21 15:34:33 +02:00
Alexander Zeidler
16b31cc9a6 sysadmin: add section 'Firmware Updates' and references
Firmware updates are important, their existence should not be checked
only when there are already noticeable problems.

Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>
Reviewed-by: Dominik Csapak <d.csapak@proxmox.com>
2023-09-21 15:08:40 +02:00
Thomas Lamprecht
82551b2bea update static/schema information
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-09-18 17:04:47 +02:00
Alexander Zeidler
501744f77d vzdump: mention new parameter 'pbs-entries-max'
configuring pbs-entries-max can avoid failing backups due to a high
amount of files in folders where a folder exclusion is not possible

Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>
2023-09-18 16:53:52 +02:00
Thomas Lamprecht
6d8b6e3989 calendar events: fix build for wiki target
This was actually just some POC that got committed by accident and
broke build to to getting a title where not expecting it as there
where two (relatively seen) top-level titles in the calendar events
page.

Fix that by declaring an actual level-0 heading (i.e., title) in the
wiki context.

This then should also fix a dangling link to the calendar-events wiki
page for the docs-in-wiki stuff, e.g., "calendar events" in backup
chapter [0] pointint to 404 [1], that Fiona reported a few weeks ago.
[0]: https://pve.proxmox.com/wiki/Backup_and_Restore#vzdump_jobs
[1]: https://pve.proxmox.com/wiki/Schedule_Format#chapter_calendar_events

Fixes: a90b75d ("package repos: add Ceph 18.2 Reef repos")
Reported-by: Lukas Wagner <l.wagner@proxmox.com>
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-09-18 11:56:56 +02:00
Thomas Lamprecht
cf50cfe69b package repos: fix heading syntax
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-09-18 11:56:41 +02:00
Thomas Lamprecht
a90b75d5f4 package repos: add Ceph 18.2 Reef repos
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-09-15 16:51:22 +02:00
Fabian Grünbichler
d27e71eb0c ha: document where shutdown policy is set
it's not obvious otherwise from reading the description.

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2023-09-15 12:38:51 +02:00
Fabian Grünbichler
613b6effc0 vzdump: mention file-restore log file
it was only documented in the proxmox-backup source code so far.

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2023-09-08 10:39:52 +02:00
Christian Ebner
c2dbd3581d website: update external links to www.proxmox.com
During the redesign of www.proxmox.com the menu structure and therefore
some url changed. Update the external link in order to avoid an
unneccessary redirect.

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
2023-08-23 10:12:37 +02:00
Wolfgang Bumiller
ba2a819747 bump version to 8.0.5
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
2023-08-16 12:04:05 +02:00
Lukas Wagner
1ba1e95244 add documentation for the new notification system
Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-08-16 12:01:17 +02:00
Thomas Lamprecht
07b013aa0d update static/schema information
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-07-25 17:20:57 +02:00
Aaron Lauterer
e0c0420824 pvecm: add qdevice status flag explanation
They are underdocumented and finding information is not that easy.

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
 [TL: break footnote with long link over multiple lines ]
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-07-25 17:16:56 +02:00
Aaron Lauterer
50063cd726 pvecm: fix pvecm status indentation
Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2023-07-25 11:54:55 +02:00
Thomas Lamprecht
ff62dafe02 user management: add note about case-sensitivity for AD realm
As there its really common to do things case insensitive a docs note
should help users to discover that Proxmox VE allows one to configure
and LDAP/AD realm to also work case insensitive.

While the UI option got added only recently in pve-manager's commit
c34c5418 ("ui: active directory realm: expose case-sensitive option")
mention it already, as there's a good chance that manager gets bumped
sooner than docs.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-07-25 10:28:35 +02:00
Fabian Grünbichler
def3e106af fix #4866: fix install on Debian wiki link
to point at Bookworm, instead of Bullseye.

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2023-07-24 13:00:54 +02:00
Fabian Grünbichler
3ad9d61cdf fix proxmox-kernel-helper package name
Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2023-07-18 10:59:28 +02:00
Max Carrara
af79dcc5cb pveum: sort roles and privileges alphabetically
Signed-off-by: Max Carrara <m.carrara@proxmox.com>
2023-07-16 00:44:41 +02:00
Max Carrara
19934c36c4 pveum: add missing roles and privileges
Signed-off-by: Max Carrara <m.carrara@proxmox.com>
2023-07-16 00:44:41 +02:00
Philipp Hufnagl
2098db2e1a pmxcfs: fix incorrect exmple command
There is an error in this example. The .conf has to be moved in the
quemu-server folder of the new node for the migration to work.

Signed-off-by: Philipp Hufnagl <p.hufnagl@proxmox.com>
2023-07-15 23:42:17 +02:00
Friedrich Weber
d5f9b415fc cgroup: update note about legacy cgroup controller support
The 7->8 upgrade guide [1] mentions that cgroup v1 will be deprecated
starting from PVE 9.0, so also mention this in the docs.

[1] https://pve.proxmox.com/wiki/Upgrade_from_7_to_8#cgroup_V1_Deprecation

Signed-off-by: Friedrich Weber <f.weber@proxmox.com>
2023-07-15 23:25:31 +02:00
Thomas Lamprecht
8668bfdff9 installation: note that TUI uses same code and use thumbnail attribute
The thumbnail attribute is our preferred way to include those
screenshots, but it requires to be inside a paragraph to be replaced, and
having an admonition directly below the attribute doesn't makes it
part of a paragraph.

So, add a bit of text, which was warranted anyway, allowing us to use
the thumbnail attr again.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-07-07 08:42:06 +02:00