Project

General

Profile

Bug #15556

Plugin enable options are confusing

Added by Stephen Benjamin over 4 years ago. Updated over 2 years ago.

Status:
Closed
Priority:
Normal
Category:
foreman-installer script
Target version:
Difficulty:
Triaged:
No
Bugzilla link:
Fixed in Releases:
Found in Releases:

Description

Every plugin has 2 options like this:

    --[no-]enable-foreman-plugin-remote-execution Enable 'foreman_plugin_remote_execution' puppet module (default: false)
    --foreman-proxy-plugin-remote-execution-ssh-enabled  Enables/disables the plugin (default: true)

The former is really the one to use to actually enabling the plugin, the latter only triggers the .yml config enable option.

It's very confusing for end users who probably see the second option first as it's near the end of the --help.


Related issues

Related to Installer - Feature #9308: Add hooks to enable multiple plugin parameters for pluginsNew2015-02-10

Associated revisions

Revision 9a23ee14 (diff)
Added by Stephen Benjamin over 4 years ago

fixes #15556 - move some params to advanced (#264)

This reduces the amount of default help text and confusing options for
plugins. This is especially confusing for 'enabled' as there are 2
options:
```
--[no-]enable-foreman-proxy-plugin-remote-execution-ssh
--foreman-proxy-plugin-remote-execution-ssh-enabled
```
The former REALLY enables the plugin, the latter is only controlling
the value in the .yml configuration which has a sane default value.
We should hide this, and some of the other options like `listen_on`,
`group`, etc which probably don't need changing ever.

History

#1 Updated by Stephen Benjamin over 4 years ago

  • Related to Feature #9308: Add hooks to enable multiple plugin parameters for plugins added

#2 Updated by Stephen Benjamin over 4 years ago

Maybe something that could be solved by #9308?

#3 Updated by Dominic Cleal over 4 years ago

The enable parameter could be put into an "Advanced" documentation group so it doesn't usually show up in the help output.

#4 Updated by Stephen Benjamin over 4 years ago

  • Bugzilla link set to 1352003

#5 Updated by Stephen Benjamin over 4 years ago

  • Status changed from New to Ready For Testing
  • Pull request https://github.com/theforeman/puppet-foreman_proxy/pull/264 added

#6 Updated by Anonymous over 4 years ago

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

#7 Updated by Dominic Cleal over 4 years ago

  • Legacy Backlogs Release (now unused) set to 160

#8 Updated by The Foreman Bot over 2 years ago

  • Assignee set to Julian Todt
  • Pull request https://github.com/theforeman/puppet-foreman_proxy/pull/434 added

#9 Updated by Ewoud Kohl van Wijngaarden over 2 years ago

  • Triaged set to No
  • Assignee changed from Julian Todt to Stephen Benjamin
  • Pull request deleted (https://github.com/theforeman/puppet-foreman_proxy/pull/434)

Also available in: Atom PDF