Bug 2170410 - Documented option "--enable-foreman-cli-plugin-webhooks" is not valid
Summary: Documented option "--enable-foreman-cli-plugin-webhooks" is not valid
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Satellite
Classification: Red Hat
Component: Documentation
Version: 6.13.0
Hardware: All
OS: All
high
high
Target Milestone: Unspecified
Assignee: Adam Lazik
QA Contact:
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2023-02-16 09:43 UTC by Sayan Das
Modified: 2023-08-03 17:35 UTC (History)
1 user (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2023-05-03 20:53:28 UTC
Target Upstream Version:
Embargoed:

Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Issue Tracker SAT-15959 0 None None None 2023-02-16 09:44:39 UTC

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
Note You need to log in before you can comment on or make changes to this bug.