packer/README.markdown

   1 # OpenDaylight CI Packer
   2
   3 [Packer][1] is a tool for automatically creating VM and container images,
   4 configuring them and post-processing them into standard output formats.
   5
   6 We build OpenDaylight's CI images via Packer.
   7
   8 ## Building
   9
  10 You'll need to [install Packer][2], of course.
  11
  12 OpenDaylight's Packer configuration is divided into build-specific variables,
  13 output-specific templates and a set of shared provisioning scripts. To do a
  14 specific build, combine the template for the desired output artifact type with
  15 a variable file. To build a new java-builder instance the following would be done:
  16
  17 ```
  18 packer build -var-file=vars/cloud-env.json -var-file=vars/centos.json templates/java-builder.json
  19 ```
  20
  21 **NOTE:** vars/cloud-env.json is a gitignored file as it contains private
  22 information. A vars/cloud-env.json.example file is provided as an example.
  23
  24 This would build bootable image in two different OpenStack clouds. In specific,
  25 Rackspace's Public cloud and a private OpenStack cloud.
  26
  27 From a high level, the builds:
  28
  29 * Boot a specified base image in both clouds.
  30 * Run a set of shell scripts, listed in the template's shell provisioner
  31   section, to do any configuration required by the builder.
  32 * Execute a shutdown of the running instance in the clouds.
  33 * Execute a 'nova image-create' operation against the shutdown instance.
  34 * Perform a 'nova delete' operation against the shutdown instance.
  35
  36 [1]: https://www.packer.io/
  37 [2]: https://www.packer.io/intro/getting-started/setup.html