RHEL Engineering is moving the tracking of its product development work on RHEL 6 through RHEL 9 to Red Hat Jira (issues.redhat.com). If you're a Red Hat customer, please continue to file support cases via the Red Hat customer portal. If you're not, please head to the "RHEL project" in Red Hat Jira and file new tickets here. Individual Bugzilla bugs in the statuses "NEW", "ASSIGNED", and "POST" are being migrated throughout September 2023. Bugs of Red Hat partners with an assigned Engineering Partner Manager (EPM) are migrated in late September as per pre-agreed dates. Bugs against components "kernel", "kernel-rt", and "kpatch" are only migrated if still in "NEW" or "ASSIGNED". If you cannot log in to RH Jira, please consult article #7032570. That failing, please send an e-mail to the RH Jira admins at rh-issues@redhat.com to troubleshoot your issue as a user management inquiry. The email creates a ServiceNow ticket with Red Hat. Individual Bugzilla bugs that are migrated will be moved to status "CLOSED", resolution "MIGRATED", and set with "MigratedToJIRA" in "Keywords". The link to the successor Jira issue will be found under "Links", have a little "two-footprint" icon next to it, and direct you to the "RHEL project" in Red Hat Jira (issue links are of type "https://issues.redhat.com/browse/RHEL-XXXX", where "X" is a digit). This same link will be available in a blue banner at the top of the page informing you that that bug has been migrated.
Bug 1773565 - Incorrect section name [global], misleading option formatting in ipahealthcheck.conf man page
Summary: Incorrect section name [global], misleading option formatting in ipahealthche...
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Red Hat Enterprise Linux 8
Classification: Red Hat
Component: ipa-healthcheck
Version: 8.2
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: rc
: 8.0
Assignee: Rob Crittenden
QA Contact: ipa-qe
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2019-11-18 13:42 UTC by Sudhir Menon
Modified: 2023-02-18 04:20 UTC (History)
3 users (show)

Fixed In Version: ipa-healthcheck-0.4-3
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2020-04-28 15:44:12 UTC
Type: Bug
Target Upstream Version:
Embargoed:

Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Issue Tracker FREEIPA-9479 0 None None None 2023-02-18 04:20:56 UTC
Red Hat Issue Tracker RHELPLAN-32907 0 None None None 2023-02-18 04:19:43 UTC
Red Hat Product Errata RHEA-2020:1640 0 None None None 2020-04-28 15:44:32 UTC

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
Note You need to log in before you can comment on or make changes to this bug.