Bug 1376011

Summary: Directions to update discovery PXE templates are confusing.
Product: Red Hat Satellite Reporter: Rich Jerrido <rjerrido>
Component: Docs Install GuideAssignee: Julie <juwu>
Status: CLOSED CURRENTRELEASE QA Contact: Brandi Munilla <bmcelvee>
Severity: medium Docs Contact:
Priority: medium    
Version: 6.2.0CC: adahms, bmcelvee
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: 2016-10-09 23:06:05 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:

Description Rich Jerrido 2016-09-14 12:51:20 UTC
Document URL: 

https://access.redhat.com/documentation/en/red-hat-satellite/6.2/single/installation-guide#upgrading_capsule_server

Section Number and Name: 

Describe the issue: 


In the various sections that describe how to update the discovery templates as part of the 6.2 upgrade, the directions are confusing:

For example, the doc states:

"In the Template editor dialog box, edit the PXELinux global default template discovery menu entry by inserting the following text at the end of the template. "

This is ambiguous. As a user, I can interpret this one of two ways:

- Edit the existing stanza, making it look as per the documentation. 
- Add an stanza, in addition to any existing stanzas labeled 'discovery' with the content as per the documentation. 

We want the user to the do the former. They need to have exactly ONE stanza labeled 'discovery'. 

Suggestions for improvement: 

Change the text for this section (and the other sections that are similar) to text akin to the following

- Go to Hosts > Provisioning templates.
- Select PXELinux global default.
- In the Template editor dialog box, edit the PXELinux global default template discovery menu entry, updating the stanza that begins with 'LABEL discovery' to match the following:

LABEL discovery
MENU LABEL Satellite 6 Discovery
MENU DEFAULT
KERNEL boot/fdi-image-rhel_7-vmlinuz
APPEND initrd=boot/fdi-image-rhel_7-img rootflags=loop root=live:/fdi.iso rootfstype=auto ro rd.live.image acpi=force rd.luks=0 rd.md=0 rd.dm=0 rd.lvm=0 rd.bootif=0 rd.neednet=0 nomodeset proxy.url=https://SATELLITE_CAPSULE_URL:9090 proxy.type=proxy
IPAPPEND 2

As discovery needed to be setup manually in Satellite 6.1, it is possible that  this stanza does not exist.  



Additional information:

Comment 1 Andrew Dahms 2016-09-19 04:30:47 UTC
Assigning to Julie for review.

Julie - Dan might be able to provide the required clarification on this one.

Comment 3 Andrew Dahms 2016-10-03 23:57:07 UTC
Assigning Brandi as the QA contact.

Brandi - can you take a look at the changes for this bug?

Comment 6 Andrew Dahms 2016-10-09 23:06:05 UTC
This content is live on the Customer Portal.

Closing.