1359816 – With capsule scenario plugin options are hard to guess

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 1359816 - With capsule scenario plugin options are hard to guess

Summary: With capsule scenario plugin options are hard to guess

Keywords:
Status:	CLOSED NEXTRELEASE
Alias:	None
Product:	Red Hat Satellite
Classification:	Red Hat
Component:	Installation
Sub Component:
Version:	6.2.0
Hardware:	Unspecified
OS:	Unspecified
Priority:	unspecified
Severity:	medium
Target Milestone:	Unspecified
Assignee:	Martin Bacovsky
QA Contact:	Lukas Pramuk
Docs Contact:
URL:
Whiteboard:
Depends On:	1339336
Blocks:
TreeView+	depends on / blocked

Reported:	2016-07-25 13:46 UTC by Lukas Pramuk
Modified:	2017-09-22 12:14 UTC (History)
CC List:	11 users (show)
Fixed In Version:
Doc Type:	If docs needed, set a value
Doc Text:
Clone Of:	1339336
Environment:
Last Closed:	2017-09-22 12:14:53 UTC
Target Upstream Version:
Embargoed:

Attachments	(Terms of Use)

Comment 1 Lukas Pramuk 2016-07-25 13:53:54 UTC

for example remote execution plugin:

@Satellite
= Module foreman_proxy_plugin_remote_execution_ssh:
    --foreman-proxy-plugin-remote-execution-ssh-enabled  Enables/disables the plugin (default: true)
    --foreman-proxy-plugin-remote-execution-ssh-generate-keys  Automatically generate SSH keys (default: true)
    --foreman-proxy-plugin-remote-execution-ssh-listen-on  Proxy feature listens on https, http, or both (default: "https")
    --foreman-proxy-plugin-remote-execution-ssh-local-working-dir  Local working directory on the smart proxy (default: "/var/tmp")
    --foreman-proxy-plugin-remote-execution-ssh-remote-working-dir  Remote working directory on clients (default: "/var/tmp")
    --foreman-proxy-plugin-remote-execution-ssh-ssh-identity-dir  Directory where SSH keys are stored (default: "/usr/share/foreman-proxy/.ssh")
    --foreman-proxy-plugin-remote-execution-ssh-ssh-identity-file  Provide an alternative name for the SSH keys (default: "id_rsa_foreman_proxy")
    --foreman-proxy-plugin-remote-execution-ssh-ssh-keygen  Location of the ssh-keygen binary (default: "/usr/bin/ssh-keygen")

vs.


@Capsule
= Module foreman_proxy_plugin_remote_execution_ssh:
    --enabled                     enables/disables the plugin (default: true)
    --enabled                     enables/disables the pulp plugin (default: false)
    --enabled                     Enables/disables the plugin (default: true)
    --generate-keys               Automatically generate SSH keys (default: true)
    --listen-on                   Proxy feature listens on http, https, or both (default: "https")
    --listen-on                   Proxy feature listens on http, https, or both (default: "https")
    --listen-on                   Proxy feature listens on https, http, or both (default: "https")
    --local-working-dir           Local working directory on the smart proxy (default: "/var/tmp")
    --remote-working-dir          Remote working directory on clients (default: "/var/tmp")
    --ssh-identity-dir            Directory where SSH keys are stored (default: "/usr/share/foreman-proxy/.ssh")
    --ssh-identity-file           Provide an alternative name for the SSH keys (default: "id_rsa_foreman_proxy")
    --ssh-keygen                  Location of the ssh-keygen binary (default: "/usr/bin/ssh-keygen")

>>> we don't want our customers to guess correct plugin options by replacing _ with - and prepending -- and concating with the rest 

>>> --enabled listed 3 times and notice the funny part (default: true) vs. (default: false)

Comment 2 Bryan Kearney 2016-07-25 14:17:25 UTC

Upstream bug assigned to mbacovsk

Comment 3 Bryan Kearney 2016-07-25 14:17:29 UTC

Moving to POST since upstream bug http://projects.theforeman.org/issues/13908 has been closed

Comment 4 Lukas Pramuk 2016-07-25 14:17:44 UTC

It looks like we are having plugin option conflicts here:

# satellite-installer --enabled blah
Parameter enabled invalid
Parameter enabled invalid
Parameter enabled invalid
Error during configuration, exiting

>> 3 plugins are consuming the same option (--enabled)

# satellite-installer --listen-on .
Parameter listen-on invalid
Parameter listen-on invalid
Error during configuration, exiting

>> 2 plugins are consuming the same option (--listen-on)

Comment 8 Stephen Benjamin 2016-08-01 18:49:12 UTC


*** This bug has been marked as a duplicate of bug 1352003 ***

Comment 9 Stephen Benjamin 2016-08-01 18:50:17 UTC

Ah sorry not a dupe - I misread the description it was cloned from.

Note You need to log in before you can comment on or make changes to this bug.