1 Using Kayak
   2 ===========
   3 
   4 Building
   5 --------
   6 
   7  * Set PKGURL to be the source of the OmniOS bits we wish to install with
   8    kayak, in case it's not the default "omnios" publisher for whatever release
   9    branch you have checked out.
  10 
  11  * zfs create rpool/kayak_image
  12  * gmake {PREBUILT_ILLUMOS=<path>} BUILDSEND=rpool/kayak_image <target>
  13 
  14 BUILDSEND must be specified.
  15 
  16 PREBUILT_ILLUMOS should point to an already-built illumos-omnios of the
  17 version you wish to construct an installer.  It is optional, but the build
  18 will warn you if you do not specify it. The build uses "svccfg-native" if
  19 possible to manipulate SMF on target images without conversing with the host
  20 machine's SMF services.
  21 
  22 <target> must be specified.
  23 
  24 install-http:
  25         Builds the <VERSION>.zfs.bz2 file, which is what Kayak uses
  26         for any install it does. Independent target.
  27 
  28 install-tftp:
  29         Builds the miniroot.gz file, which is what PXE Kayak feeds to
  30         GRUB or Loader to boot itself on a PXE boot. Independent target.
  31 
  32 install-iso:
  33         Builds both install-{http,tftp} and then proceeds to construct
  34         <VERSION>.iso using components from both.
  35 
  36 install-usb:
  37         Builds install-iso, and then proceed to construct <VERSION>.usb-dd
  38         based on the ISO image.
  39 
  40 Operation
  41 ---------
  42 
  43 DHCP server:
  44  * your server should be set to PXE boot
  45  * the DHCP server must return and IP, a nextserver and a bootfile
  46  * the boot file should be the file {{{/boot/grub/pxegrub}}} or {{{/boot/pxeboot}}} from an existing OmniOS system
  47 
  48 TFTP server:
  49  * menu.lst.01<macaddr_just_hex_caps> based on the template provided in this directory should be placed in /tftpboot/ if using grub, or put loader.conf.local in /tftpboot/boot
  50  * /boot/grub/pxegrub or /boot/pxeboot should be placed in /tftpboot/
  51  * /platform/i86pc/kernel/amd64/unix should be placed in /tftpboot/omnios/kayak/
  52  * the miniroot.gz file should be placed in /tftpboot/omnios/kayak/
  53 
  54 HTTP server:
  55  * The system install images should be placed an accessible URL
  56  * The target system kayak config should be placed at a URL path with the filename <macaddr_just_hex_caps>
  57