Project

General

Profile

Actions

Bug #16148

closed

Enable/disable module descriptions in help output are confusing

Added by Shlomi Zadok over 8 years ago. Updated over 6 years ago.

Status:
Closed
Priority:
Normal
Assignee:
Category:
Foreman modules
Target version:
Difficulty:
Triaged:
Fixed in Releases:
Found in Releases:

Description

Cloned from https://bugzilla.redhat.com/show_bug.cgi?id=1329375
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:

Actions #1

Updated by Shlomi Zadok over 8 years ago

  • Assignee deleted (Shlomi Zadok)
  • Target version set to 115
Actions #2

Updated by Marek Hulán over 8 years ago

  • Project changed from Installer to Kafo
  • Subject changed from foreman-installer descriptions for oscap is incorrect to Module descriptions in help output are confusing

Note that this is not related to openscap and is common for all puppet modules we have in our installer. I've asked reporter for possible alternatives but it's very likely a change that would have to be made in kafo and based on solution also maybe in foreman-installer. Moving this to kafo and will create a new issue if it's required in installer.

Actions #3

Updated by The Foreman Bot about 8 years ago

  • Status changed from New to Ready For Testing
  • Assignee set to Shlomi Zadok
  • Pull request https://github.com/theforeman/kafo/pull/198 added
Actions #4

Updated by Marek Hulán almost 8 years ago

  • Project changed from Kafo to Installer
  • Category set to Foreman modules
Actions #5

Updated by Marek Hulán almost 8 years ago

  • Target version changed from 115 to 1.10.2
Actions #6

Updated by Marek Hulán almost 8 years ago

  • Pull request https://github.com/theforeman/puppet-foreman_proxy/pull/319 added
  • Pull request deleted (https://github.com/theforeman/kafo/pull/198)
Actions #7

Updated by Anonymous almost 8 years ago

  • Status changed from Ready For Testing to Closed
  • % Done changed from 0 to 100
Actions #8

Updated by Dominic Cleal almost 8 years ago

  • Translation missing: en.field_release set to 209
Actions #9

Updated by Dominic Cleal almost 8 years ago

  • Subject changed from Module descriptions in help output are confusing to Enable/disable module descriptions in help output are confusing
  • Assignee changed from Shlomi Zadok to Marek Hulán
Actions

Also available in: Atom PDF