| Summary: | foreman-installer descriptions for oscap is incorrect | ||
|---|---|---|---|
| Product: | Red Hat Satellite | Reporter: | Kedar Bidarkar <kbidarka> |
| Component: | Installer | Assignee: | satellite6-bugs <satellite6-bugs> |
| Status: | CLOSED ERRATA | QA Contact: | Kedar Bidarkar <kbidarka> |
| Severity: | high | Docs Contact: | |
| Priority: | unspecified | ||
| Version: | 6.2.0 | CC: | bkearney, kbidarka, mhulan, pcfe, sjagtap |
| Target Milestone: | Unspecified | Keywords: | Triaged |
| Target Release: | Unused | ||
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| URL: | http://projects.theforeman.org/issues/16148 | ||
| Whiteboard: | |||
| Fixed In Version: | Doc Type: | Bug Fix | |
| Doc Text: | Story Points: | --- | |
| Clone Of: | Environment: | ||
| Last Closed: | 2018-02-21 16:54:17 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: | |
Created redmine issue http://projects.theforeman.org/issues/16148 from this bug Upstream bug component is Installer 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.
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.
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? @Marek the solution, should work and avoid confusion caused by multiple plugin options. Moving this bug to POST for triage into Satellite 6 since the upstream issue http://projects.theforeman.org/issues/16148 has been resolved. No customer issues, moving to 6.3 for verification 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 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
|
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: