Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.
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 2170410

Summary: Documented option "--enable-foreman-cli-plugin-webhooks" is not valid
Product: Red Hat Satellite Reporter: Sayan Das <saydas>
Component: DocumentationAssignee: Adam Lazik <alazik>
Documentation sub component: default QA Contact:
Status: CLOSED CURRENTRELEASE Docs Contact:
Severity: high    
Priority: high CC: alazik
Version: 6.13.0Keywords: Reopened, Triaged
Target Milestone: Unspecified   
Target Release: Unused   
Hardware: All   
OS: All   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2023-05-03 20:53:28 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:
Embargoed:

Description Sayan Das 2023-02-16 09:43:38 UTC 
Document URL: 

https://dxp-docp-prod.apps.ext-waf.spoke.prod.us-west-2.aws.paas.redhat.com/documentation/en-us/red_hat_satellite/6.13/html-single/administering_red_hat_satellite/index?lb_target=preview

Section Number and Name: 

19.2. Installing Webhooks


Describe the issue: 

We mention this:
~~~
Optionally, you can install the CLI plugin using the following command:

# satellite-installer --enable-foreman-cli-plugin-webhooks
~~~


"--enable-foreman-cli-plugin-webhooks" is wrong installer option and installer will throw errors like:
~~
2023-02-16 15:02:15 [NOTICE] [root] Loading installer configuration. This will take some time.
2023-02-16 15:02:18 [NOTICE] [root] Running installer with log based terminal output at level NOTICE.
2023-02-16 15:02:18 [NOTICE] [root] Use -l to set the terminal output log level to ERROR, WARN, NOTICE, INFO, or DEBUG. See --full-help for definitions.
ERROR: Unrecognised option '--enable-foreman-cli-plugin-webhooks'
~~



Suggestions for improvement: 

Replace:

# satellite-installer --enable-foreman-cli-plugin-webhooks

With

# satellite-installer --enable-foreman-cli-webhooks


Additional information: 

This change needs to be done for Satellite 6.12 and 6.11 as well.
Comment 2 Adam Lazik 2023-02-16 13:14:58 UTC 
PR: https://github.com/theforeman/foreman-documentation/pull/2003
Comment 3 Adam Lazik 2023-02-16 15:28:21 UTC 
The documentation has been updated:

https://dxp-docp-prod.apps.ext-waf.spoke.prod.us-west-2.aws.paas.redhat.com/documentation/en-us/red_hat_satellite/6.13/html-single/administering_red_hat_satellite/index?lb_target=preview#installing-webhooks-plugin_admin

https://access.redhat.com/documentation/en-us/red_hat_satellite/6.12/html-single/administering_red_hat_satellite/index#installing-webhooks-plugin_admin

https://access.redhat.com/documentation/en-us/red_hat_satellite/6.11/html-single/administering_red_hat_satellite/index#installing-webhooks-plugin_admin
Comment 4 Marie Hornickova 2023-05-03 20:53:28 UTC 
Updated docs for RH Satellite 6.13 are now live on RH Customer Portal:

https://access.redhat.com/documentation/en-us/red_hat_satellite/6.13/html-single/administering_red_hat_satellite/index#installing-webhooks-plugin_admin