Bug 2167486

Summary:	The "Prefer registered through Capsule for remote execution" setting is missing from "Remote Execution Workflow" documentation
Product:	Red Hat Satellite	Reporter:	Jayant Bhatia <jbhatia>
Component:	Documentation	Assignee:	Adam Lazik <alazik>
Documentation sub component:	default	QA Contact:
Status:	CLOSED CURRENTRELEASE	Docs Contact:
Severity:	low
Priority:	low	CC:	alazik
Version:	6.13.0	Keywords:	Reopened, Triaged
Target Milestone:	Unspecified
Target Release:	Unused
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:		Doc Type:	If docs needed, set a value
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2023-05-03 21:34:48 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 Jayant Bhatia 2023-02-06 18:34:30 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/managing_hosts/index?lb_target=preview&check_logged_in=1


Section Number and Name: 

11.2. Remote Execution Workflow


Describe the issue: 

If "Satellite WebUI -> Administer -> Settings -> Remote Execution -> Prefer registered through Capsule for remote execution" is set to "Yes", then all the remote execution jobs on the registered host is executed by the Capsule to which the host is registered.

The section "11.2. Remote Execution Workflow" in mentioned documentation URL talks about following: "When you run a remote job on hosts, for every host, Satellite performs the following actions to find a remote execution Capsule to use.".
However there is no mention of "Prefer registered through Capsule for remote execution" setting anywhere in the documentation which plays a major role in finding remote execution Capsule to use. If "Prefer registered through Capsule for remote execution" setting is set to "Yes", it gets the priority above all the other conditions which are used to find remote execution Capsule.  


Suggestions for improvement: Inclusion of "Prefer registered through Capsule for remote execution" setting in the above mentioned section within documentation.

Comment 3 Adam Lazik 2023-02-09 10:32:06 UTC

Hello!
The setting is in fact there under different name.
Created PR to correct the name of the setting: https://github.com/theforeman/foreman-documentation/pull/1984

Comment 4 Adam Lazik 2023-02-09 15:15:50 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/managing_hosts/index?lb_target=preview&check_logged_in=1#remote-execution-workflow_managing-hosts

Comment 5 Jayant Bhatia 2023-02-09 15:34:58 UTC

The documentation looks good! Thank you for updating it.

Comment 6 Marie Hornickova 2023-05-03 21:34:48 UTC

The documentation is now live on RH Customer Portal:

https://access.redhat.com/documentation/en-us/red_hat_satellite/6.13/html-single/managing_hosts/index#remote-execution-workflow_managing-hosts