Foreman

{{toc}}

h1. How do I use unattended installations (Kickstart, jumpstart, preseed)?

Foreman automates network boot processes using PXEboot (or native Solaris net:dhcp)

At this time, Foreman does not support DHCP and DNS alteration, you would need to do those steps manually.

h2. TFTP

Foreman has currently limited support for TFTP- that means it require the TFTP server to be accessible via the local file system.

future versions of Foreman would allow remote TFTP servers as well.

make sure you add into your config/settings.yml

<pre> :tftppath: /var/lib/tftpboot/pxelinux.cfg</pre>

replace the value with your actual TFTP directory and ensure that the *user which executes Foreman  have write access*.

h3. How does Foreman manages TFTP?

When clicking on the Build button (in the host list), Foreman would generate a link which will be automatically read by pxelinux,

This link would point to a predefined syslinux(pxelinux) boot file which would be based on the Operating System used.

Note:- if you require the link to point to different PXE files based on serial console variables, adding '0,19200n8' in the serial field of a host will create a different symbolic link.

after a successful OS installation, that link will be removed, and your default PXE settings will be served.

The idea behind it is to set the boot order on each host to always boot from network, and then change the settings via Foreman.

This avoids the need to press F12 on each machine just to reinstall it, Clicking on Build in Foreman will trigger a host re-installation upon the next server reboot if default boot order is PXE 

an example of a such a file for CentOS 5 32bit:

<pre>default linux

label linux

kernel boot/centos-5-32.vmlinuz

append initrd=boot/centos-5-32.initrd.img ks=http://foremanhost/unattended/kickstart ksdevice=eth0 network kssendmac

</pre>

and another example for Ubuntu 9.04 32bit

<pre>default preseed

label preseed

kernel boot/ubuntu-9.04-32.linux

append initrd=boot/ubuntu-9.04-32.initrd.gz ramdisk_size=10800 root=/dev/rd/0 rw auto preseed/url=http://foremanhost/unattended/preseed console-keymaps-at/keymap=us locale=en_US interface=eth0 DEBCONF_PRIORITY=critical netcfg/dhcp_timeout=60 --

</pre>

h2. PuppetCA

Foreman will enable host autosign during provisioning time, that means, the user which executes Foreman must have:

1. write access to /etc/puppet/autosign.conf

2. sudo access to run puppetca

Once a host (which is enabled for build) is requesting a kickstart/jumpstart etc than an entry would be created in the autosign.conf file.

Each operating system will run puppetd after the OS installation but before the first reboot, this will acquire the puppet certificate, then the host will notify Foreman that it has finished the installation, and Foreman will remove the entry from the autosign file automatically.

h2. Whats inside the Kickstart / jumpstart /preseed ?

These files are all generated dynamically based on the setting of each host in Foreman, things like partition tables and root password can be unique per server.

if you want to see the kickstart/preseed etc you may use the spoof parameter, just point your browser to:

<pre>http://foremanhost:3000/unattended/kickstart?spoof=123.321.123.321</pre>

* 123.321.123.321 is the hosts IP Address (the one you want to build).

* usually you want to see the page source, the browser might display the file in html which will result in hard to read output.

* if you are using passenger please remove the ":3000" from the URL.

h2. Modifying the unattended template

You probably want to do minor teaks to your kickstart/jumpstart/preseed template (yeah the same kind puppet uses).

the template for can be found at:

RedHat based installation

<pre>app/view/unattended/kickstart.rhtml</pre>

Debian/Ubuntu installations 

<pre>app/view/unattended/preseed.rhtml</pre>

and a finish script

<pre>app/view/unattended/preseed_finish.rhtml</pre>

h3. Snippets support

as of version 0.1-2 snippets support was added, for reusable code that be shared between operating systems deployments (e.g. puppet.conf).

They are pure ERB templates (same as puppet templates) and could be modified at the following directory:

<pre>

app/views/unattended/snippets

</pre>

in order to create a new snippet place it in that the same directory and prefix it with a "_". later you can call it from the existing templates:

<pre>

<%= snippets "vmware" -%>

</pre>