Bug 1750427

Summary: New sbd option 'SBD_TIMEOUT_ACTION' is not listed in pcs documentation
Product: Red Hat Enterprise Linux 8 Reporter: Nina Hostakova <nhostako>
Component: pcsAssignee: Ondrej Mular <omular>
Status: CLOSED ERRATA QA Contact: cluster-qe <cluster-qe>
Severity: unspecified Docs Contact:
Priority: medium    
Version: 8.1CC: cfeist, cluster-maint, idevat, kwenning, mlisik, mmazoure, omular, tojeline
Target Milestone: rcKeywords: EasyFix
Target Release: 8.2Flags: pm-rhel: mirror+
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: pcs-0.10.4-5.el8 Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of:
: 1803826 (view as bug list) Environment:
Last Closed: 2020-04-28 15:27:56 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On:    
Bug Blocks: 1803826    

Description Nina Hostakova 2019-09-09 15:05:06 UTC
Description of problem:
pcs has added 'SBD_TIMEOUT_ACTION' to supported options. However it is not documented neither in help nor in pcs man page

Version-Release number of selected component (if applicable):
pcs-0.10.2-4.el8.x86_64

How reproducible:
always

Steps to Reproduce:
1. check pcs help
[root@virt-030 ~]#  pcs stonith sbd --help | grep 'SBD options' -A5 -B5

Usage: pcs stonith sbd...
    sbd enable [watchdog=<path>[@<node>]]... [device=<path>[@<node>]]...
               [<SBD_OPTION>=<value>]... [--no-watchdog-validation]
        Enable SBD in cluster. Default path for watchdog device is
        /dev/watchdog. Allowed SBD options: SBD_WATCHDOG_TIMEOUT (default: 5),
        SBD_DELAY_START (default: no) and SBD_STARTMODE (default: always). It is
        possible to specify up to 3 devices per node. If
        --no-watchdog-validation is specified, validation of watchdogs will be
        skipped.


2. check man pcs
[root@virt-030 ~]# man pcs | grep 'SBD options' -A1 -B1
       sbd enable [watchdog=<path>[@<node>]]... [device=<path>[@<node>]]... [<SBD_OPTION>=<value>]... [--no-watchdog-validation]
              Enable SBD in cluster. Default path for watchdog device is /dev/watchdog. Allowed SBD options: SBD_WATCHDOG_TIMEOUT (default: 5), SBD_DELAY_START (default:  no)  and  SBD_STARTMODE  (default:
              always). It is possible to specify up to 3 devices per node. If --no-watchdog-validation is specified, validation of watchdogs will be skipped.

Actual results:
'SBD_TIMEOUT_ACTION' is not mentioned in allowed SBD options

Expected results:
The option should be documented including the values that can be set

Additional info:

Comment 4 Miroslav Lisik 2019-11-29 08:53:47 UTC
Test:

[root@r8-node-03 pcs]# rpm -q pcs
pcs-0.10.4-1.el8.x86_64

[root@r8-node-03 pcs]# pcs stonith sbd enable --help | grep -A 3 "SBD options"
        /dev/watchdog. Allowed SBD options: SBD_WATCHDOG_TIMEOUT (default: 5),
        SBD_DELAY_START (default: no), SBD_STARTMODE (default: always) and
        SBD_TIMEOUT_ACTION. It is possible to specify up to 3 devices per node.
        If --no-watchdog-validation is specified, validation of watchdogs will

Comment 12 Miroslav Lisik 2020-02-17 13:56:13 UTC
Test:
[root@r8-node-01 ~]# rpm -q pcs
pcs-0.10.4-5.el8.x86_64

[root@r8-node-01 ~]# MAXWIDTH=80 man pcs | grep -C 1 sbd\(8\)
              Enable SBD in cluster. Default path for watchdog device is /dev/watchdog. Allowed SBD options: SBD_WATCHDOG_TIMEOUT (default: 5), SBD_DELAY_START (default: no), SBD_STARTMODE (default: always) and SBD_TIMEOUT_ACTION.  SBD  options  are  documented  in
              sbd(8) man page. It is possible to specify up to 3 devices per node. If --no-watchdog-validation is specified, validation of watchdogs will be skipped.

--
       sbd device message <device-path> <node> <message-type>
              Manually set a message of the specified type on the device for the node. Possible message types (they are documented in sbd(8) man page): test, reset, off, crashdump, exit, clear

--

       boothd(8), sbd(8)

[root@r8-node-01 ~]# pcs stonith sbd enable --help | grep -C 1 sbd\(8\)
        SBD_DELAY_START (default: no), SBD_STARTMODE (default: always) and
        SBD_TIMEOUT_ACTION. SBD options are documented in sbd(8) man page. It
        is possible to specify up to 3 devices per node.

Comment 16 errata-xmlrpc 2020-04-28 15:27:56 UTC
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory, and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHEA-2020:1568