Commit Graph

1932 Commits

Author SHA1 Message Date
Thomas Lamprecht
22deb8488c pveum: update generated synopsys
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-11-21 21:01:24 +01:00
Thomas Lamprecht
673ffc0dd3 bump version to 8.1.0
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-11-21 20:49:13 +01:00
Thomas Lamprecht
fa22697b2d update static/schema information
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-11-21 20:42:05 +01:00
Thomas Lamprecht
3d5a1655f2 sdn: rework installation a bit and merge sections for dnsmaq
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-11-21 20:01:43 +01:00
Stefan Hanreich
a7ec9f05c4 sdn: dhcp: Add documentation for DHCP
Signed-off-by: Stefan Hanreich <s.hanreich@proxmox.com>
2023-11-21 19:38:34 +01:00
Thomas Lamprecht
fc4bf68a2a sdn: rework introduction and installation and add support status
Provide installation documentation for opt-in features, document the
current support status, and rework the overview and introduction of
the whole chapter.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-11-21 19:20:05 +01:00
Lukas Wagner
24451e5d60 notification: document 'unknown' severity
This is the severity used for forwarded mails, since we cannot
reasonably infer a priority here.

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-11-21 17:36:45 +01:00
Lukas Wagner
f5f316bddb notification: add anchors for target types/matchers
This enables us to directly link to the appropriate section from the
UI.

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-11-21 17:34:58 +01:00
Thomas Lamprecht
7823f52eaf sdn: switch back to singular for vnet reference
do not break the web UI and external references just for a small
virtual improvement

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-11-21 14:52:03 +01:00
Markus Frank
4005a5fafe add VNC clipboard documentation
Signed-off-by: Markus Frank <m.frank@proxmox.com>
Reviewed-by: Dominik Csapak <d.csapak@proxmox.com>
Tested-by: Dominik Csapak <d.csapak@proxmox.com>
2023-11-21 14:28:53 +01:00
Aaron Lauterer
d4ee0a1992 pvecm: expand on public/cluster networks
Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2023-11-20 16:59:34 +01:00
Aaron Lauterer
4df8e368fa pveceph: fix typo
Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2023-11-20 16:59:34 +01:00
Aaron Lauterer
9608e5b1c1 pvecm: fix qnetd typo
Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2023-11-20 16:59:34 +01:00
Thomas Lamprecht
460fa62010 sdn: add section about underlying technology and configuration files
document some basics of the inner workings, can definitively get
extended (and might be then better of placed somewhere else).

This makes also a bit more sense then the non-telling 'SDN' heading
left over the recent rework.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-11-20 09:40:24 +01:00
Stefan Lendl
bcb72b254d sdn: overall language and consistency rework
This is a general style polishing rework that wants to:
- improve consistency of spellings and casing
- drop some to verbose examples that included the whole generated
  ifupdown2 config, which is not only not that useful here, but will
  also get outdated fast, so it is probably more confusing than
  helping at the current development pace. Could be nice in some
  reduced form some times in a "inner workings" section
- shorten some examples verbosity by not spelling repetitions of
  steps, e.g., for those that one needs to apply to all guests in an
  example.

Best to check the changes using the following git flags to avoid noise:
git show -w --word-diff=color --word-diff-regex='\w+'

Signed-off-by: Stefan Lendl <s.lendl@proxmox.com>
 [ TL: fix build, squash patches to not break patch causality, add
   actual commit message and reinstate some notes to avoid loss of
   information ]
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-11-20 09:39:30 +01:00
Lukas Wagner
b4c816f4a4 notifications: change to simplified ACL structure.
For now, we use a less deeply nested structure. We can always extend
it if we need to.

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-11-17 17:54:16 +01:00
Lukas Wagner
7b293b5d9a notifications: add documentation for system mail forwarding
Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-11-17 17:54:16 +01:00
Lukas Wagner
e39dfad987 notifications: document 'comment' option for targets/matchers
Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-11-17 17:54:16 +01:00
Lukas Wagner
7a20522e0e notifications: document SMTP endpoints
Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-11-17 17:54:16 +01:00
Lukas Wagner
c877f0aa6d notifications: update docs to for matcher-based notifications
Target groups and filters have been replaced by notification matchers.
The matcher can match on certain notification properties and route
the notification to a target in case of a match.

This patch updates the docs to reflect these changes.

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-11-17 17:54:16 +01:00
Stefan Lendl
7e3d086fe3 gitignore: add build artefacts and temporary intermediate files
Signed-off-by: Stefan Lendl <s.lendl@proxmox.com>
 [ TL: fix subject and use more specific glob ]
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-11-17 16:04:23 +01:00
Thomas Lamprecht
bd92b74580 update static/schema information
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-11-17 13:35:08 +01:00
Thomas Lamprecht
f9a6aa0fe4 network: add missing reference
Fixes: 96c0261 ("fix #4847: network: extend section on interface naming scheme")
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-11-17 11:46:02 +01:00
Thomas Lamprecht
3c126a2153 sdn: use correct spelling for software-defined network
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-11-17 10:59:58 +01:00
Noel Ullreich
ff4ae05288 Fix spelling of command line/command-line
Commandline/command line/command-line where being used interchangeably,
which is not correct
(see: https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/c/command-line).
use command-line when it is an adjective (e.g. "command-line interface")
and use command line when it is a noun (e.g. "change the setting from
the command line")

Signed-off-by: Noel Ullreich <n.ullreich@proxmox.com>
2023-11-17 10:54:24 +01:00
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