Bug 1378551 - Typo in product documentation referencing /mnt/nfs/var/lib/tftpboot
Summary: Typo in product documentation referencing /mnt/nfs/var/lib/tftpboot
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Satellite
Classification: Red Hat
Component: Docs Install Guide
Version: 6.2.0
Hardware: All
OS: All
medium
low
Target Milestone: Unspecified
Assignee: Lucie Jirakova
QA Contact: Stephen Wadeley
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-09-22 18:08 UTC by Dan Trainor
Modified: 2019-09-26 18:04 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2016-12-09 12:17:33 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Dan Trainor 2016-09-22 18:08:22 UTC
Document URL: 
https://access.redhat.com/documentation/en/red-hat-satellite/6.2/paged/installation-guide/chapter-5-configuring-external-services

Section Number and Name: 
5.7. CONFIGURING CAPSULE SERVER WITH EXTERNAL TFTP
Step 2

Describe the issue: 
Step 2 asks the user to create a directory called /exports/mnt/nfs/var/lib/tftpboot in which the remote nfs export is mounted.  The "/exports" references in the document are only used for managing exports on the remote server, in this case, the remote nfs server.  

Suggestions for improvement: 
Change the directory to be created on the Capsule server in the documentation to be /mnt/nfs/var/lib/tftpboot instead of /exports/mnt/nfs/var/lib/tftpboot

Additional information:

Comment 1 Andrew Dahms 2016-09-27 13:09:22 UTC
Assigning to Lucie for review.

Comment 2 Lucie Jirakova 2016-09-30 09:50:57 UTC
Hello lzap,

Re: Configuring Capsule Server with External TFTP (see comment #0 for link)

Can you pls confirm if Steps 1 to 3 are for the external TFTP server, and steps 4 to 6 are for the Capsule?

Thank you.

Comment 4 Lukas Zapletal 2016-10-03 07:53:56 UTC
I confirm, it is correct in the document I created for this chapter.

***
Foreman Proxy configuration

Make and activate mountpoint:

mkdir -p /mnt/nfs/var/lib/tftpboot

In the /etc/fstab, add this line:

192.168.38.2:/exports/var/lib/tftpboot /mnt/nfs/var/lib/tftpboot nfs rw,vers=3,auto,nosharecache,context="system_u:object_r:tftpdir_rw_t:s0" 0 0


To enable TFTP support in foreman-proxy, edit /usr/share/foreman-proxy/config/settings.d/tftp.yml file:

:enabled: true
:tftproot: /mnt/nfs/var/lib/tftpboot


If TFTP service is running on a different server than the DHCP service, use the :tftp_servername setting to setup the IP address of that server.

Head over to Foreman Server WebUI, locate the Foreman Proxy and Refresh Features. Now you can associate this TFTP feature with the required Subnets.
***

Additional comments when touching this chapter:

This is NOT meant to be broken, it must be on the one line:

/exports/var/lib/tftpboot 192.168.38.1(rw,async,no_root_squash,no_subtree_check,nohide)

There are several places where the export file have newlines, these should be non breaking spaces to avoid confusion.

Please also change all mentions of "the recommended and tested version is Red Hat Enterprise Linux 7.1" to "7.1 or higher".

Comment 10 Stephen Wadeley 2016-11-04 16:22:10 UTC
Hello

re comment 0

Step 2 in the guide is:

 Add the newly created mount point to the /etc/fstab file.

/mnt/nfs/var/lib/tftpboot /exports/mnt/nfs/var/lib/tftpboot none bind,auto 0 0

I greped the guide and could not find any mkdir command with "/exports/mnt/nfs/var/lib/tftpboot"

Comment 11 Stephen Wadeley 2016-11-04 16:23:12 UTC
 ~]# exportfs -rva
-bash: exportfs: command not found

this command failed. I am testing only the TFTP part, I NFS was configured in the DNS section, so we should add a Prerequisite:
 
You should have already configured NFS. To configure NFS, see Configuring Satellite Server with External DNS.

Comment 16 Stephen Wadeley 2016-12-07 10:37:05 UTC
(In reply to Stephen Wadeley from comment #11)
>  ~]# exportfs -rva
> -bash: exportfs: command not found
> 
> this command failed. I am testing only the TFTP part, I NFS was configured
> in the DNS section, so we should add a Prerequisite:
>  
> You should have already configured NFS. To configure NFS, see Configuring
> Satellite Server with External DNS.

sorry, made a mistake

the relevant commands are in:

5.5. Configuring Capsule Server with External DHCP

    Install the NFS client.

    # yum install nfs-utils


The section "5.6. Configuring Satellite Server with External TFTP" already says:

Before You Begin

    You should have already configured the firewall for external access to NFS. To configure the firewall, see Configuring Satellite Server with External DHCP. 

So if we change that to say:

 "You should have already configured NFS and the firewall for external access to NFS. See Configuring Satellite Server with External DHCP.

it will be much better.

Comment 26 Lucie Jirakova 2016-12-09 12:17:33 UTC
The updated guide is now live on portal.

Corrected procedure for configuring Capsule Server with external TFTP:
https://access.redhat.com/documentation/en/red-hat-satellite/6.2/single/installation-guide/#configuring_capsule_external_tftp

Added note about external DHCP configuration via NFS being no longer supported:
https://access.redhat.com/documentation/en/red-hat-satellite/6.2/single/installation-guide/#configuring_satellite_external_dhcp


Note You need to log in before you can comment on or make changes to this bug.