Bug 1773565

Summary: Incorrect section name [global], misleading option formatting in ipahealthcheck.conf man page
Product: Red Hat Enterprise Linux 8 Reporter: Sudhir Menon <sumenon>
Component: ipa-healthcheckAssignee: Rob Crittenden <rcritten>
Status: CLOSED ERRATA QA Contact: ipa-qe <ipa-qe>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 8.2CC: fcami, ksiddiqu, ssidhaye
Target Milestone: rc   
Target Release: 8.0   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: ipa-healthcheck-0.4-3 Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2020-04-28 15:44:12 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:

Description Sudhir Menon 2019-11-18 13:42:16 UTC
Description of problem: Document [default] section parameters for ipahealthcheck.conf in 'man ipa-healthcheck'.


Version-Release number of selected component (if applicable):
[root@master ~]# cat /etc/redhat-release 
Red Hat Enterprise Linux release 8.2 Beta (Ootpa)
[root@master ~]# rpm -q ipa-healthcheck
ipa-healthcheck-0.3-4.module+el8.1.0+4098+f286395e.noarch


How reproducible:
Always

Steps to Reproduce:
1. Install ipa-healthcheck
2. Check the /etc/ipahealthcheck/ipahealthcheck.conf

Actual results: Currently there is a default section which is listed and doesn't
have any configuration parameters.

[root@master ~]# cat /etc/ipahealthcheck/ipahealthcheck.conf 
[default]

Expected results: If there are certain parameters which users can configure, we should document them in man page for ipa-healthcheck.
Also we should include any other sections which will be included for the tool.

Additional info: Logging this as a RFE so that users can configure it accordingly.

Comment 1 Rob Crittenden 2019-11-18 14:03:44 UTC
This is in the current man page:

OPTIONS
       The following options are relevant for the server:

       cert_expiration_days 28
              The number of days left before a certificate  expires  to  start
              displaying a warning.

It is currently the only user configuration.

Or are you looking for something else?

Comment 3 Rob Crittenden 2019-11-18 14:25:01 UTC
You are looking in the wrong man page. man 5 ipahealthcheck.conf

Comment 4 Sudhir Menon 2019-11-19 06:25:53 UTC
Rob,
Thanks, man 5 ipahealthcheck.conf does show the options.
However i do have some queries, the man pages says

1. Valid lines consist of an option name, an equals sign and a value
   - When we check the option i.e cert_expiration_days 28 it isn't mentioned in the above format.
   - Also where should this option be specified default/global section?
   
2. Options must appear in the section named [global]. There are no other sections defined or used currently
   - However i do see the [default] section in the /etc/ipahealthcheck/ipahealthcheck.conf.
   - default/global section do we support both right now?

Comment 5 Rob Crittenden 2019-11-19 19:53:24 UTC
1. The option is just bad formatting in the man page. I'll move the 28 elsewhere and indicate it's the default
2. global is incorrect, the section should be default.

Comment 6 Rob Crittenden 2019-11-19 19:58:59 UTC
Upstream issue https://github.com/freeipa/freeipa-healthcheck/issues/88

Comment 7 Rob Crittenden 2019-11-19 20:43:55 UTC
Fixed upstream
master: 528f9bb0621baefc35e4d8e5821ca02d08e240d2

Comment 10 Sumedh Sidhaye 2020-02-24 07:08:48 UTC
Reproducer:

[root@ci-vm-10-0-136-119 ~]# cat /etc/redhat-release
Red Hat Enterprise Linux release 8.1 (Ootpa)
[root@ci-vm-10-0-136-119 ~]# rpm -q ipa-healthcheck
ipa-healthcheck-0.3-4.module+el8.1.0+4098+f286395e.noarch


[root@ci-vm-10-0-136-119 ~]# man 5 ipahealthcheck.conf

<snip>
       Options must appear in the section named [global]. There are no other sections defined or used currently.

cert_expiration_days 28
              The number of days left before a certificate expires to start displaying a warning.
</snip>



Fix:

[root@vm-idm-026 ~]# cat /etc/redhat-release 
Red Hat Enterprise Linux release 8.2 Beta (Ootpa)
[root@vm-idm-026 ~]# rpm -q ipa-healthcheck
ipa-healthcheck-0.4-4.module+el8.2.0+5489+95477d9f.noarch

[root@vm-idm-026 ~]# man 5 ipahealthcheck.conf


<snip>
       Options must appear in the section named [default]. There are no other sections defined or used currently.


cert_expiration_days
              The number of days left before a certificate expires to start displaying a warning. The default is 28.

</snip>

Based on above observations marking the Bugzilla fixed.

Comment 13 errata-xmlrpc 2020-04-28 15:44:12 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:1640