Bug 2170845

Summary:	Example missing for "--foreman-proxy-dhcp-ipxefilename" option in provisioing guide when an external Capsule will be used for iPXE
Product:	Red Hat Satellite	Reporter:	Sayan Das <saydas>
Component:	Documentation	Assignee:	Marie Hornickova <mdolezel>
Documentation sub component:	default	QA Contact:
Status:	CLOSED NOTABUG	Docs Contact:
Severity:	medium
Priority:	medium
Version:	6.13.0
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-02-19 16:53:43 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-17 12:09:35 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#

Section Number and Name: 

Chapter 5. Configuring iPXE to Reduce Provisioning Times

Point 19 of "5.1. Booting Virtual Machines"

Point 17 of "5.2. Chainbooting iPXE from PXELinux"


Describe the issue: 

We mention what needs to be done with "--foreman-proxy-dhcp-ipxefilename" in case of satellite i.e.

~~~
On Satellite Server, run:

satellite-installer --foreman-proxy-dhcp-ipxefilename "http://satellite.example.com/unattended/iPXE?bootstrap=1"

~~~

But we don't mention anything about capsule. So when user is not using this option on capsule, The dhcpd.conf gets generated with following segment 

if exists user-class and option user-class = "iPXE" {
  filename "http://capsule613.lab.example.com:8000/unattended/iPXE";

which i believe is not correct. 


Suggestions for improvement: 

Assuming my assumption is correct and from what i can see as an example in https://access.redhat.com/documentation/en-us/red_hat_satellite/6.10/html/provisioning_guide/configuring_networking-configuring_gpxe_to_reduce_provisioning_times#booting_virtual_machines ,  I would prpose to add one more point in 6.13 doc , to include 


~~~
In any external capsule Server, run:

satellite-installer --foreman-proxy-dhcp-ipxefilename "http://capsule.example.com:8000/unattended/iPXE?bootstrap=1"

~~~


Additional information: 

We seem to be skipping this part since 6.11 docs. So please confirm with foreman\satellite SMEs if my observation is wrong here or else we should consider my proposal here.

Comment 2 Sayan Das 2023-02-19 16:53:43 UTC

I tested today and It seems, we don't need to do anything extra for External Capsules and the default configuration i.e.

if exists user-class and option user-class = "iPXE" {
  filename "http://capsule613.lab.example.com:8000/unattended/iPXE";


works fine for iPXE or iPXE via PXELinux.


Closing this bug