[pve-devel] [PATCH docs 1/2] pvecm: fix pvecm status indentation

[pve-devel] [PATCH docs 1/2] pvecm: fix pvecm status indentation

[Aaron Lauterer]

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
---
 pvecm.adoc | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/pvecm.adoc b/pvecm.adoc
index ace6488..45271e8 100644
--- a/pvecm.adoc
+++ b/pvecm.adoc
@@ -1076,9 +1076,9 @@ Flags:            Quorate Qdevice
 Membership information
 ~~~~~~~~~~~~~~~~~~~~~~
     Nodeid      Votes    Qdevice Name
-    0x00000001          1    A,V,NMW 192.168.22.180 (local)
-    0x00000002          1    A,V,NMW 192.168.22.181
-    0x00000000          1            Qdevice
+    0x00000001      1    A,V,NMW 192.168.22.180 (local)
+    0x00000002      1    A,V,NMW 192.168.22.181
+    0x00000000      1            Qdevice
 
 ----
 
-- 
2.39.2

[pve-devel] [PATCH docs 2/2] pvecm: add qdevice status flag explanation

[Aaron Lauterer]

They are underdocumented and finding information is not that easy.

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
---

Found some info in the suse documentation [0] and the sourcecode [1].
We do not ship man 3 pages, therefore I used a direct link to the github
repo as that seems to be the only place that talks abit about the MW /
NMW flag.

[0] https://documentation.suse.com/sle-ha/15-SP1/html/SLE-HA-all/cha-ha-qdevice.html
[1] https://github.com/corosync/corosync/blob/v3.1.7/tools/corosync-quorumtool.c#L524-L536


 pvecm.adoc | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/pvecm.adoc b/pvecm.adoc
index 45271e8..e286bdd 100644
--- a/pvecm.adoc
+++ b/pvecm.adoc
@@ -1082,6 +1082,21 @@ Membership information
 
 ----
 
+QDevice Status Flags
+^^^^^^^^^^^^^^^^^^^^
+
+The status output of the QDevice, as seen above, will usually contain three
+columns:
+
+* `A` / `NA`: Alive or Not Alive. Indicates if the communication to the external
+    `corosync-qndetd` daemon works.
+* `V` / `NV`: If the QDevice will cast a vote for the node. In a split-brain
+    situation, where the corosync connection between the nodes is down, but they
+    both can still communicate with the external `corosync-qnetd` daemon,
+    only one node will get the vote.
+* `MW` / `NMW`: Master wins (`MV`) or not (`NMW`). Default is `NMW`, see footnote:[`votequorum_qdevice_master_wins` manual page https://github.com/corosync/corosync/blob/main/man/votequorum_qdevice_master_wins.3.in].
+* `NR`: QDevice is not registered.
+
 
 Frequently Asked Questions
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
-- 
2.39.2

Re: [pve-devel] [PATCH docs 2/2] pvecm: add qdevice status flag explanation

[Thomas Lamprecht]

On 24/07/2023 14:54, Aaron Lauterer wrote:
> They are underdocumented and finding information is not that easy.
> 
> Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
> ---
> 
> Found some info in the suse documentation [0] and the sourcecode [1].

Yes, like it was mentioned on the chat a bit ago, luckily we use open
source which, if not easy for all to find, is at least the definitive
truth – thanks for adding this in our docs now too for our users.

> We do not ship man 3 pages, therefore I used a direct link to the github

corosync-doc does ship that page..

> repo as that seems to be the only place that talks abit about the MW /
> NMW flag.
> 
> [0] https://documentation.suse.com/sle-ha/15-SP1/html/SLE-HA-all/cha-ha-qdevice.html
> [1] https://github.com/corosync/corosync/blob/v3.1.7/tools/corosync-quorumtool.c#L524-L536
> 
> 
>  pvecm.adoc | 15 +++++++++++++++
>  1 file changed, 15 insertions(+)
> 
> diff --git a/pvecm.adoc b/pvecm.adoc
> index 45271e8..e286bdd 100644
> --- a/pvecm.adoc
> +++ b/pvecm.adoc
> @@ -1082,6 +1082,21 @@ Membership information
>  
>  ----
>  

I'd proactively add a reference here, e.g.:

[[pvecm_qdevice_status_flags]]

> +QDevice Status Flags
> +^^^^^^^^^^^^^^^^^^^^
> +
> +The status output of the QDevice, as seen above, will usually contain three
> +columns:
> +
> +* `A` / `NA`: Alive or Not Alive. Indicates if the communication to the external
> +    `corosync-qndetd` daemon works.
> +* `V` / `NV`: If the QDevice will cast a vote for the node. In a split-brain
> +    situation, where the corosync connection between the nodes is down, but they
> +    both can still communicate with the external `corosync-qnetd` daemon,
> +    only one node will get the vote.
> +* `MW` / `NMW`: Master wins (`MV`) or not (`NMW`). Default is `NMW`, see footnote:[`votequorum_qdevice_master_wins` manual page https://github.com/corosync/corosync/blob/main/man/votequorum_qdevice_master_wins.3.in].

I really would not link to the manpage source directly on GitHub.
I'd either use manpages.debian.org [0] or none at all and refer to the
corosync-doc package, which ships it.

[0]: https://manpages.debian.org/bookworm/libvotequorum-dev/votequorum_qdevice_master_wins.3.en.html

> +* `NR`: QDevice is not registered.
> +
>  
>  Frequently Asked Questions
>  ~~~~~~~~~~~~~~~~~~~~~~~~~~

Re: [pve-devel] [PATCH docs 2/2] pvecm: add qdevice status flag explanation

[Aaron Lauterer]

On 7/25/23 11:17, Thomas Lamprecht wrote:
> On 24/07/2023 14:54, Aaron Lauterer wrote:
>> They are underdocumented and finding information is not that easy.
>>
>> Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
>> ---
>>
>> Found some info in the suse documentation [0] and the sourcecode [1].
> 
> Yes, like it was mentioned on the chat a bit ago, luckily we use open
> source which, if not easy for all to find, is at least the definitive
> truth – thanks for adding this in our docs now too for our users.
> 
>> We do not ship man 3 pages, therefore I used a direct link to the github
> 
> corosync-doc does ship that page..

ah good to know
> 
>> repo as that seems to be the only place that talks abit about the MW /
>> NMW flag.
>>
>> [0] https://documentation.suse.com/sle-ha/15-SP1/html/SLE-HA-all/cha-ha-qdevice.html
>> [1] https://github.com/corosync/corosync/blob/v3.1.7/tools/corosync-quorumtool.c#L524-L536
>>
>>
>>   pvecm.adoc | 15 +++++++++++++++
>>   1 file changed, 15 insertions(+)
>>
>> diff --git a/pvecm.adoc b/pvecm.adoc
>> index 45271e8..e286bdd 100644
>> --- a/pvecm.adoc
>> +++ b/pvecm.adoc
>> @@ -1082,6 +1082,21 @@ Membership information
>>   
>>   ----
>>   
> 
> I'd proactively add a reference here, e.g.:
> 
> [[pvecm_qdevice_status_flags]]

good idea, will do
> 
>> +QDevice Status Flags
>> +^^^^^^^^^^^^^^^^^^^^
>> +
>> +The status output of the QDevice, as seen above, will usually contain three
>> +columns:
>> +
>> +* `A` / `NA`: Alive or Not Alive. Indicates if the communication to the external
>> +    `corosync-qndetd` daemon works.
>> +* `V` / `NV`: If the QDevice will cast a vote for the node. In a split-brain
>> +    situation, where the corosync connection between the nodes is down, but they
>> +    both can still communicate with the external `corosync-qnetd` daemon,
>> +    only one node will get the vote.
>> +* `MW` / `NMW`: Master wins (`MV`) or not (`NMW`). Default is `NMW`, see footnote:[`votequorum_qdevice_master_wins` manual page https://github.com/corosync/corosync/blob/main/man/votequorum_qdevice_master_wins.3.in].
> 
> I really would not link to the manpage source directly on GitHub.
> I'd either use manpages.debian.org [0] or none at all and refer to the
> corosync-doc package, which ships it.
> 
> [0]: https://manpages.debian.org/bookworm/libvotequorum-dev/votequorum_qdevice_master_wins.3.en.html

thanks, might do both, link to manpages.debian.org and mention the corosync-docs 
package

> 
>> +* `NR`: QDevice is not registered.
>> +
>>   
>>   Frequently Asked Questions
>>   ~~~~~~~~~~~~~~~~~~~~~~~~~~
> 

[pve-devel] applied: [PATCH docs 1/2] pvecm: fix pvecm status indentation

[Thomas Lamprecht]

On 24/07/2023 14:54, Aaron Lauterer wrote:
> Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
> ---
>  pvecm.adoc | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
>

applied this one for now, thanks!