From: Aaron Lauterer <a.lauterer@proxmox.com>
To: Thomas Lamprecht <t.lamprecht@proxmox.com>,
Proxmox VE development discussion <pve-devel@lists.proxmox.com>
Subject: Re: [pve-devel] [PATCH docs 2/2] pvecm: add qdevice status flag explanation
Date: Tue, 25 Jul 2023 11:35:51 +0200 [thread overview]
Message-ID: <69e338a7-5140-ebbe-7cde-2fd95f01526f@proxmox.com> (raw)
In-Reply-To: <054cf652-dbfc-4dcb-9650-132990bbe3f1@proxmox.com>
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
>> ~~~~~~~~~~~~~~~~~~~~~~~~~~
>
next prev parent reply other threads:[~2023-07-25 9:36 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-07-24 12:54 [pve-devel] [PATCH docs 1/2] pvecm: fix pvecm status indentation Aaron Lauterer
2023-07-24 12:54 ` [pve-devel] [PATCH docs 2/2] pvecm: add qdevice status flag explanation Aaron Lauterer
2023-07-25 9:17 ` Thomas Lamprecht
2023-07-25 9:35 ` Aaron Lauterer [this message]
2023-07-25 9:56 ` [pve-devel] applied: [PATCH docs 1/2] pvecm: fix pvecm status indentation Thomas Lamprecht
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=69e338a7-5140-ebbe-7cde-2fd95f01526f@proxmox.com \
--to=a.lauterer@proxmox.com \
--cc=pve-devel@lists.proxmox.com \
--cc=t.lamprecht@proxmox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox