Commit Graph

108 Commits

Author SHA1 Message Date
Fabian Grünbichler
508a36f599 partially fix #5139: document qnetd port requirement
we could also add a check somewhere in pve-cluster for this.

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
 [ TL: squash in changes Fiona proposed for the port syntax/wording ]
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-02-20 16:00:25 +01:00
Fabian Grünbichler
f358b68663 fix #5140: qdevice SSH access documentation
rephrase in order to not make it seem like password-based access is required.

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2024-02-20 15:55:05 +01:00
Alexander Zeidler
0554c751fd pvecm: correct network address
Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>
2024-02-20 13:00:36 +01:00
Fiona Ebner
9cfbea5361 pvecm: remove node: explain how to deal with the node's pmxcfs directory
Reported in the community forum:
https://forum.proxmox.com/threads/139006/post-621739

Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
2024-01-15 17:49:16 +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
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
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
Aaron Lauterer
cd44cb4c27 pvecm: add node: let parameter use two dashes
While the '--linkX' paramter works with one dash too, let's use two so
we are in line with the man page and other uses of named parameters.

Since we are at it, prepend the command with '#' as we do throughout
this section.

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2023-07-03 09:43:44 +02:00
Fiona Ebner
aaf632d5fe cluster join: mention that storage config from cluster is inherited
and what to do about it. It's a rather common topic in forum threads.

Suggested in the community forum:
https://forum.proxmox.com/threads/118492/post-513743

Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
2023-01-16 16:54:28 +01:00
Marco Gabriel via pve-devel
337a2d4238 fix #4319: use corred port range for corosync v3.x
corosync v2 used ports 5405 and 5404, but corosync v3 uses ports 5405-5412.

Signed-off-by: Marco Gabriel <mgabriel@inett.de>
2022-11-18 10:12:30 +01:00
Thomas Lamprecht
eee1c5de0a pvecm: add basic next-id section
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2022-04-29 17:29:12 +02:00
Oguz Bektas
16162db8cc pvecm: add small note for 'updatecerts' workaround in qdevice setup
sometimes the qdevice setup can fail when copying CA certificates if the
node SSH keys are not matching for some reason.

reported here:
https://forum.proxmox.com/threads/pvecm-qdevice-setup-fails.88681

Signed-off-by: Oguz Bektas <o.bektas@proxmox.com>
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2022-03-16 16:08:03 +01:00
Thomas Lamprecht
c43c999f81 cluster: network: clarify and ease latency requirements
With 5 ms (stable!) even mid size cluster can work just fine, and we
know quite some smaller setups that work OK with 6 - 9 ms, so ease
on unnecessarily scaring users into thinking that their network will
cause them trouble.

we got reports of working two node clusters with ~15 ms latency, so
it can work out above 10ms, albeit things start to get really brittle
and def. not something for 3+ nodes.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2022-02-11 11:57:44 +01:00
Fabian Ebner
da0c67934c cluster: migration: use back-ticked insecure when referring to the setting
Signed-off-by: Fabian Ebner <f.ebner@proxmox.com>
2021-11-17 15:33:02 +01:00
Fabian Ebner
8e0e0bcf35 VM live migration: mention that CPU vendor should be the same
Signed-off-by: Fabian Ebner <f.ebner@proxmox.com>
2021-11-17 15:33:02 +01:00
Dylan Whyte
7ec7bcee11 fix #3375: warn user to remove replication jobs
this adds a warning in the documentation to remove any replication jobs
before deleting a cluster node

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
2021-09-15 17:01:42 +02:00
Dylan Whyte
249fd83323 pvecm: add note about corosync killnode error
Mentions the misleading error message shown, when deleting a node,
because of the failing command:
    corosync-cfgtool -k x

Some forum users were confused by this, and believed that the removal of
the node was unsuccessful.

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
2021-09-15 17:01:28 +02:00
Dylan Whyte
663ae2bf5c pvecm: update instructions to add redundant links
mentions the ability to add up to 8 redundant corosync links and how
it's done in the current GUI

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
2021-09-15 17:01:28 +02:00
Dylan Whyte
8673c878ce pvecm: fix command output formatting
- Remove host name from commands, where it provided no value
- Display new command output for pvecm status
- Shorten command output where unneccessary
- Change migration network example to use CIDR address rather than
  address + netmask

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
2021-09-15 17:01:28 +02:00
Dylan Whyte
65a0aa490b pvecm: replace {PVE} with {pve}
although they both act the same, {pve} is more common throughout the
docs, so this helps to keep things more consistent

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
2021-09-15 17:01:28 +02:00
Dylan Whyte
a37d539fe4 pvecm: language and format fixup
- Fix wording, spelling, grammar
- Fix capitalisation in some titles
- Replace usage of e.g. and i.e.

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
2021-09-15 17:01:28 +02:00
Dylan Whyte
60ed554fac fix 3372: fix typos, and impove pve-gui docs
This reformulates quite a bit of the gui section and corrects small
typos elsewhere.

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
2021-04-12 15:47:33 +02:00
Thomas Lamprecht
79bb079400 followup comma fix
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-01-19 14:26:02 +01:00
Thomas Lamprecht
fdf1dd364d cluster manager: reword node limit, as there's not a real one
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-01-19 14:17:26 +01:00
Fabian Grünbichler
4e8fe2a959 pvecm: improve SSH section
reword some parts, fix wrong information about port forwarding

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2020-11-25 12:41:35 +01:00
Thomas Lamprecht
9d999d1bf6 cluster: restructure ssh role section
Move the example into the bulletin points, makes it clearer that they
are connected and avoids interrupting the flow when reading.

Make the whole "important" part a admontion, as such notes should be
self-contained (not split between note and non-note), it also gives
it more visibility.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-11-24 12:02:01 +01:00
Oguz Bektas
39aa8892b4 pvecm: explain role of ssh in PVE stack
(for #2829)

add a section describing how SSH tunnels are used in conjunction
with PVE.

Signed-off-by: Oguz Bektas <o.bektas@proxmox.com>
2020-11-24 12:02:01 +01:00
Dominic Jäger
10da5ce16b pvecm: Add output for delnode
The output of "pvecm delnode someNode" is "Killing node X". Even though this
only says something about an attempt and not about success, it is not "no
output is returned".

Signed-off-by: Dominic Jäger <d.jaeger@proxmox.com>
2020-08-20 15:31:41 +02:00
Dominic Jäger
838081cd4c pvecm: Add required -r to rm
/etc/corosync/* includes the directory uidgid.d.
Consequentlly, a correct rm call requires -r.

Signed-off-by: Dominic Jäger <d.jaeger@proxmox.com>
2020-08-20 15:31:37 +02:00
Aaron Lauterer
94cfc9d491 pvecm: whitespace fixup
Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2020-08-11 15:33:03 +02:00
Aaron Lauterer
7a39aabd39 fix #2526: network config: change underscore to dash
The network config examples use the underscore but our tooling
generates the configs with dashes.

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2020-08-11 15:33:03 +02:00
Dominic Jäger
41a37193e4 qdevice: Clarify required packages
I overlooked the different package names myself. Writing out the two commands
makes this more difficult to overlook.

Signed-off-by: Dominic Jäger <d.jaeger@proxmox.com>
2020-08-11 15:33:03 +02:00
Dominic Jäger
1b80fbaac7 qdevice: Add note about root login requirements
We mention Debian as external server before. On Debian it is easily possible
that SSH root login via password is prohibited.

Signed-off-by: Dominic Jäger <d.jaeger@proxmox.com>
2020-08-11 15:33:03 +02:00
Dominic Jäger
9ffebff57f pvecm: Add comma after 'First'
Comma after sequence words like first, next, then, or last.

Signed-off-by: Dominic Jäger <d.jaeger@proxmox.com>
2020-08-11 15:33:03 +02:00
Dominic Jäger
7c039095ed qdevice: Remove a wrong 's'
Third person plural does not require -s form.

Signed-off-by: Dominic Jäger <d.jaeger@proxmox.com>
2020-08-11 15:33:03 +02:00
Thomas Lamprecht
5f318cc038 fix some typos
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-02-11 18:01:34 +01:00
Aaron Lauterer
fcf0226ef6 pvecm: fix corosync link priority description
The official man page fixed this in commit 0a323ff [0] to describe the
actual behaviour: higher knet_link_priority number equals to higher
priority

[0] 0a323ff2ed

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2020-02-07 12:06:43 +01:00
Thomas Lamprecht
6cab1704fc followup: extend cluster create/join a bit
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2019-09-04 15:35:37 +02:00
Stefan Reiter
24398259f8 Add screenshot references to cluster GUI section
Signed-off-by: Stefan Reiter <s.reiter@proxmox.com>
2019-09-03 14:27:58 +02:00
Stefan Reiter
3e380ce0b8 Mention GUI for creating a cluster and adding nodes
Signed-off-by: Stefan Reiter <s.reiter@proxmox.com>
2019-09-03 14:27:58 +02:00
Fabian Ebner
6d3c0b3479 Fix typos in pvecm.adoc
Signed-off-by: Fabian Ebner <f.ebner@proxmox.com>
2019-09-02 12:19:26 +02:00
Thomas Lamprecht
dd1aa0e016 pvecm: re-add "multiple cluster in same net" section
While yes, there's a note covering this, users have had often
questions about it, or if it's possible at all, so it deserves its
own section, it's more visible and can be better found this way.

Adapt for corosync 3

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2019-07-10 10:48:48 +02:00
Stefan Reiter
a9e7c3aa23 Update pvecm documentation for corosync 3
Parts about multicast and RRP have been removed entirely. Instead, a new
section 'Corosync Redundancy' has been added explaining the concept of
links and link priorities.

Signed-off-by: Stefan Reiter <s.reiter@proxmox.com>
2019-07-10 10:16:45 +02:00
Stefan Reiter
3254bfddb3 Use correct xref: syntax and add pvecm prefix
Signed-off-by: Stefan Reiter <s.reiter@proxmox.com>
2019-07-10 10:08:10 +02:00
Thomas Lamprecht
9121b45bcd followup: be more specific where to run upcatecerts
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2019-07-04 14:03:37 +02:00
Stefan Reiter
41925ede90 document #2247: add info about SSH fingerprints on cluster leave
Signed-off-by: Stefan Reiter <s.reiter@proxmox.com>
2019-07-04 14:02:18 +02:00
Stefan Reiter
270757a162 Update pvecm doc regarding IP vs hostname as corosync address
Signed-off-by: Stefan Reiter <s.reiter@proxmox.com>
2019-06-25 12:05:48 +02:00
Thomas Lamprecht
e34c3e913f pvecm: qdevice: more general wording
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2019-05-26 11:40:01 +02:00
Mira Limbeck
91f3edd0e1 pvecm: fix wrong quorum numbers
Signed-off-by: Mira Limbeck <m.limbeck@proxmox.com>
2019-03-11 15:09:16 +01:00