summaryrefslogtreecommitdiffstats
path: root/koan.pod
blob: 5ca5c89a1286fbf4f4ad94d424c508dbfa54942d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
=head1 NAME

koan standards for 'kickstart-over-a-network' and allows for both network provisioning of new Xen guests and "auto-kickstarting" (destructive re-provisioning of any existing system).  It interacts with a centralized boot server that has been configured with 'cobbler'.

=head1 SYNOPSIS

koan --server=<host> --list-profiles

koan --server=<host> --list-systems

koan --xen --server=<host> --profile=<name>

koan --replace-self --server=<host> --profile=<name>

koan --replace-self --server=<host> --system=<name>

=head1 DESCRIPTION

When invoked, koan requests profile information from a remote boot server that has been configured with cobbler.   What koan does with the profile data depends on whether it was invoked with --xen or --replace-self.

For --xen, cobbler will create new Xen domUs on a xen dom0 in accordance to the orders from cobbler.

For re-kickstarting ('--replace-self'), this means reprovisioning the system, blowing away any current data and replacing it with the results of a network install.

=head1 NOTES FOR USERS OF COBBLER TEMPLATING

Cobbler contains an advanced templating feature that allows a single kickstart file to be customized on a per-system basis.  See the cobbler manpage for more details.

Ordinarily specifying the cobbler profile (--profile) when running koan would be sufficient, though if you are utilizing cobbler's templating features, you might want to provision the system by specifying a cobbler system entry instead.  The arguments to --system would be an ip, such as --system=172.16.57.21 or a MAC, such as --system=00:11:22:AA:BB:CC.  If the cobbler administrator has created any customizations for the system, this way, the koan machine will be sure to get them.  Note, however, that if the cobbler administrator never created an entry for the IP and/or MAC address, this will fail, and you should resort to using the profile name.

=head1 ADDITIONAL

Consult the man page for cobbler for more information.

=head1 AUTHOR

Michael DeHaan <mdehaan@redhat.com>