Bug 2170435

Summary:	The iPXE section does not explains how to confirm whether --foreman-trusted-proxies is configured correctly or not
Product:	Red Hat Satellite	Reporter:	Sayan Das <saydas>
Component:	Provisioning	Assignee:	Zuzana Lena Ansorgova <zuansorg>
Status:	CLOSED CURRENTRELEASE	QA Contact:	Satellite QE Team <sat-qe-bz-list>
Severity:	high	Docs Contact:
Priority:	medium
Version:	6.13.0	CC:	ekohlvan, sshtein, zuansorg
Target Milestone:	Unspecified	Keywords:	Documentation, EasyFix, Triaged
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-07-20 16:43:45 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:
Bug Depends On:	2221794
Bug Blocks:

Description Sayan Das 2023-02-16 11:18:39 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/provisioning_hosts/index?lb_target=preview#Configuring_iPXE_to_Reduce_Provisioning_Times

Chapter 5. Configuring iPXE to Reduce Provisioning Times



Section Number and Name: 

End of "5.1. Booting Virtual Machines" and "5.2. Chainbooting iPXE from PXELinux"


Describe the issue: 

We have a note that says:

~~
Note
Ensure that --foreman-trusted-proxies is configured correctly on the Satellite Server.
~~


Suggestions for improvement: 

We need to be clear about what to verify here i.e. 

* The purpose of that installer option

* How that should be configured ( in case of the deployment is being done via satellite or an external smart-proxy\capsule )


Some discussions about it can be found at https://github.com/theforeman/foreman-documentation/pull/1613#discussion_r1030466167 

Please verify with foreman\Sat Eng team what exactly we need to do about that installer option in terms of iPXE  

Additional information: 

We mention something about that option in "11.8. Using VMware Cloud-init and Userdata Templates for Provisioning" under the "Configuring Capsule to Forward the user data Template" part.

And the exact same changes are required for 6.12 docs as well.

Comment 3 Zuzana Lena Ansorgova 2023-05-15 11:44:55 UTC

https://github.com/theforeman/foreman-documentation/pull/2184

Comment 4 Zuzana Lena Ansorgova 2023-06-06 16:37:14 UTC

Published as a prerequisite and additional procedure in 6.13:

- https://access.redhat.com/documentation/en-us/red_hat_satellite/6.13/html-single/provisioning_hosts/index#Booting_Virtual_Machines_provisioning
- https://access.redhat.com/documentation/en-us/red_hat_satellite/6.13/html-single/provisioning_hosts/index#Chainbooting_iPXE_from_PXELinux_provisioning
- https://access.redhat.com/documentation/en-us/red_hat_satellite/6.13/html-single/installing_capsule_server/index#configuring-capsule-for-host-registration-and-provisioning_capsule

And in 6.12:

- https://access.redhat.com/documentation/en-us/red_hat_satellite/6.12/html-single/provisioning_hosts/index#Booting_Virtual_Machines_provisioning
- https://access.redhat.com/documentation/en-us/red_hat_satellite/6.12/html-single/provisioning_hosts/index#Chainbooting_iPXE_from_PXELinux_provisioning
- https://access.redhat.com/documentation/en-us/red_hat_satellite/6.12/html-single/installing_capsule_server/index#configuring-capsule-for-host-registration-and-provisioning_capsule

Comment 5 Zuzana Lena Ansorgova 2023-06-06 16:37:43 UTC

PR for 6.11: https://github.com/theforeman/foreman-documentation/pull/2219

Comment 7 Zuzana Lena Ansorgova 2023-07-20 16:43:45 UTC

Published for 6.11:

- https://access.redhat.com/documentation/en-us/red_hat_satellite/6.11/html-single/provisioning_hosts/index#Booting_Virtual_Machines_provisioning
- https://access.redhat.com/documentation/en-us/red_hat_satellite/6.11/html-single/provisioning_hosts/index#Chainbooting_iPXE_from_PXELinux_provisioning
- https://access.redhat.com/documentation/en-us/red_hat_satellite/6.11/html-single/installing_capsule_server/index#configuring-capsule-for-host-registration-and-provisioning_capsule

And a Known Issue about the missing "trusted proxies" option in Installer: https://access.redhat.com/documentation/en-us/red_hat_satellite/6.11/html-single/release_notes/index#ref_known-issues_assembly_introducing-red-hat-satellite