Foreman » Smart Proxy

h1. TFTP

An essential first step in netbooting a system is preparing the TFTP server with the PXE configuration file and boot images.  This document assumes that you have already configured your DHCP infrastructure, either via manual configuration or through the DHCP smart proxy.

h2. Configuration Values

Once enabled, there is currently only one valid setting to change, the default TFTP root.  This is set with the @:tftproot:@ parameter, which defaults to @/var/lib/tftpboot@.

Foreman tries to guess the right server name that should put into the dhcp record, if this is not what you want, you can override it - see 

*tftp_servername* under [[Settingsyml]].

h2. Setting Up the Proxy Server Host

Regardless of the filesystem setup is performed, you must also make sure you have the wget utility installed and in the default path.  wget is used to download OS specific installation when a given host is enabled for the build process.

h3. Automatic Setup

Foreman includes a "TFTP server module":https://github.com/theforeman/puppet-foreman_proxy/blob/master/manifests/tftp.pp that will perform all of the basic setup.  It defaults to TFTP root of @/var/lib/tftpboot@, which may change if necessary.  You will still need to provide the basic TFTP load images in your TFTP root directory.  For vanilla PXE booting, this includes @pxelinux.0@, @menu.c32@, and @chain.c32@.

h3. Manual Setup

The setup is very simple, and may be performed manually if desired.

# The TFTP root directory must exist (we will use @/var/lib/tftpboot@ in this example).

# Populate @/var/lib/tftpboot@ with PXE booting prerequisites.  At a minimum, this should include:

** @pxelinux.0@

** @menu.c32@

** @chain.c32@

# Create the directory @/var/lib/tftpboot/boot@ and make it writeable by the foreman proxy user (foreman-proxy, for instance, when installing through a rpm package).

# Create the directory @/var/lib/tftpboot/pxelinux.cfg@ and make it writeable by the foreman proxy user (foreman-proxy).

h2. Setting Up Foreman

In most cases, the default templates should work fine.  You do, however, need to make sure that a PXELinux or gPXE template is associated with your hosts.  See [[Foreman:Unattended_installations|Unattended Installations]] for details.  The template will be used to define the PXE configuration file when a host is enabled for build.

h2. Workflow

This is a rough outline of the steps triggered on the TFTP smart proxy host when you click on the "Build" link for a host.

# Call @mkdir -p /var/lib/tftpboot/pxelinux.cfg@ if it does not already exist.

# Create a host-specific TFTP configuration file in @/var/lib/tftpboot/pxelinux.cfg/01-XX-XX-XX-XX-XX-XX@, named based off of the MAC address, using the associated PXE template.

# Call @mkdir -p /var/lib/tftpboot/boot@ if it does not already exist.

# Download the OS specific kernel and initrd files using wget.  

## The download URLs are derived from the installation media path, and OS specific log (see @app/models/redhat.rb@ and @debian.rb@ in foreman for examples of the gory details).  

## The @debian.rb@ file tries to guess if you want Ubuntu or Debian, based on the Name you give to your OS in the UI. If the name does not contain 'ubuntu' or 'debian', it may default to debian, hence fail to fetch the kernel/initrd.

# The exact wget command is

<pre>wget --no-check-certificate -nv -c <src> -O "<destination>"</pre>

# At this point, the TFTP state is ready for the installation process.

# Once the host has completed installation, the OS specific installation script should inform foreman by retrieving the built URL.

# The host-specific TFTP configuration file is deleted.

# The kernel and initrd are not deleted, but left in place for future installs of the same OS and architecture combination.  Please note that in the unlikely case that these files are modified, the simplistic freshness check of wget will likely get confused, corrupting the downloaded versions of the files.  If this happens, you should simply delete the files and let them be re-downloaded from scratch.

h2. Limitations

At the moment, the proxy is not able to fetch boot files using NFS.

As a workaround, expose your installation medium (or use a public mirror) over http/ftp to configure one machine with the require boot files.

this would be resolved as part of #992.