Red Hat Satellite engineering is moving the tracking of its product development work on Satellite 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 "Satellite project" in Red Hat Jira and file new tickets here. Individual Bugzilla bugs will be migrated starting at the end of May. 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 "Satellite project" in Red Hat Jira (issue links are of type "https://issues.redhat.com/browse/SAT-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 1329375 - foreman-installer descriptions for oscap is incorrect
Summary: foreman-installer descriptions for oscap is incorrect
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Red Hat Satellite
Classification: Red Hat
Component: Installation
Version: 6.2.0
Hardware: Unspecified
OS: Unspecified
unspecified
high
Target Milestone: Unspecified
Assignee: satellite6-bugs
QA Contact: Kedar Bidarkar
URL: http://projects.theforeman.org/issues...
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-04-21 18:47 UTC by Kedar Bidarkar
Modified: 2019-09-26 14:36 UTC (History)
5 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2018-02-21 16:54:17 UTC
Target Upstream Version:
Embargoed:

Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Foreman Issue Tracker 16148 0 Normal Closed Enable/disable module descriptions in help output are confusing 2020-02-06 16:37:36 UTC

Description Kedar Bidarkar 2016-04-21 18:47:23 UTC 
Description of problem:

The description for the below options is not right and is confusing.

~]# foreman-installer --help | grep -i scap 
    --[no-]enable-foreman-plugin-openscap Enable 'foreman_plugin_openscap' puppet module (default: true)
    --[no-]enable-foreman-proxy-plugin-openscap Enable 'foreman_proxy_plugin_openscap' puppet module (default: true)
    --foreman-proxy-plugin-openscap-enabled  enables/disables the plugin (default: true)

Also if "--[no-]enable-foreman-plugin-openscap" configures the sat6 side stuff and "--[no-]enable-foreman-proxy-plugin-openscap" configures the capsule side stuff then the description for "--foreman-proxy-plugin-openscap-enabled"  as 
"enables/disables the plugin " is not at all clear.

This needs to be updated to bring in more clarity.

Version-Release number of selected component (if applicable):
sat62-snap9.0

How reproducible:


Steps to Reproduce:
1.
2.
3.

Actual results:

Currently the description for -[no-]enable-foreman-plugin-openscap and -[no-]enable-foreman-plugin-openscap ,

 uses the words "puppet module" which is incorrect.

Also the requirement/purpose of this --foreman-proxy-plugin-openscap-enabled is not clear.

Expected results:

The description is not clear and needs more detail, something like

--[no-]enable-foreman-plugin-openscap  Installs and configures the packages required for Satellite6
--[no-]enable-foreman-proxy-plugin-openscap  Installs and configures the packages required for Capsules
--foreman-proxy-plugin-openscap-enabled  "< exact  description>"
Additional info:
Comment 5 Shlomi Zadok 2016-08-17 13:10:49 UTC 
Created redmine issue http://projects.theforeman.org/issues/16148 from this bug
Comment 6 Bryan Kearney 2016-08-17 16:14:40 UTC 
Upstream bug component is Installer
Comment 8 Marek Hulan 2016-08-19 10:31:28 UTC 
This is not related to openscap. The installer help is generated based on puppet module name that does the configuration and that is also the reason why it says "$name puppet module". It is the same for any other plugin, e.g.

    "--[no-]enable-foreman-plugin-discovery Enable 'foreman_plugin_discovery' puppet module (default: true)"

Would it make more sense if we just remote the word puppet from the sentence, resulting in "Enable foreman_plugin_openscap module"? It could help understand it while it would keep the information about what it does. Otherwise we'd have to allow overriding the help for each puppet module in installer config file I guess.
Comment 9 Kedar Bidarkar 2017-01-04 08:40:09 UTC 
This bug was mainly raised to address the ambiguity related to the installer option "--foreman-proxy-plugin-openscap-enabled  enables/disables the plugin (default: true)"



The issue was,  If "--[no-]enable-foreman-plugin-openscap" configures the sat6 side stuff and "--[no-]enable-foreman-proxy-plugin-openscap" configures the capsule side stuff then the description for "--foreman-proxy-plugin-openscap-enabled"  as 
"enables/disables the plugin " is not at all clear.



------------

From sat62 

# satellite-installer --help | grep -i scap | grep -i enabled
    --foreman-proxy-plugin-openscap-enabled  enables/disables the plugin (default: true)

From sat63 

# satellite-installer --help | grep -i scap | grep -i enabled
#

So, this looks like an issue still with satellite-6.2.6-2.0.


Other suggestion to update help text can be ignored, as you are right, it's same for other plugins.
Comment 10 Marek Hulan 2017-01-04 09:42:34 UTC 
The option is still there for Satellite 6.3, you just need to run --full-help to see it. The change was introduced by bz 1352003 so if the 6.3 solution works for you I think, this is a dup of it. Could you please confirm?
Comment 11 Sanket Jagtap 2017-01-10 10:44:44 UTC 
@Marek the solution, should work and avoid confusion caused by multiple plugin options.
Comment 12 Satellite Program 2017-01-10 13:11:33 UTC 
Moving this bug to POST for triage into Satellite 6 since the upstream issue http://projects.theforeman.org/issues/16148 has been resolved.
Comment 13 Bryan Kearney 2017-05-18 14:29:17 UTC 
No customer issues, moving to 6.3 for verification
Comment 14 Kedar Bidarkar 2017-08-25 20:31:40 UTC 
Agreed with Marek as per comment 10.

Yes, this is similar to bz mentioned in comment 10.

Unless the --full-help is used, the user would not see the unintend options to the installer.

with "satellite-installer --help" only the intented options are seen, so would agreed to mark this bugzilla as VERIFIED.


VERIFIED with Sat6.3.0-snap12.0
Comment 16 Satellite Program 2018-02-21 16:54:17 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/RHSA-2018:0336
Note You need to log in before you can comment on or make changes to this bug.