Go to file

Mitchell Hashimoto f6919cf18b Short-circuit -h and --help to printing help for the top-level cmd		2013-03-24 16:35:33 -07:00
builder/amazon	Lots of stuff, too early for meaningful commit messages	2013-03-24 14:03:53 -07:00
packer	Short-circuit -h and --help to printing help for the top-level cmd	2013-03-24 16:35:33 -07:00
.gitignore	Lots of stuff, too early for meaningful commit messages	2013-03-24 14:03:53 -07:00
Makefile	More environment testing	2013-03-24 14:47:59 -07:00
README.md	README	2013-03-23 15:59:17 -07:00
example.json	Lots of stuff, too early for meaningful commit messages	2013-03-24 14:03:53 -07:00
example.toml	Amazon builder	2013-03-23 18:40:26 -07:00
packer.go	Lots of stuff, too early for meaningful commit messages	2013-03-24 14:03:53 -07:00

README.md

Packer

Packer is a tool for building identical machine images across multiple clouds.

Packer provides a framework and configuration format for creating identical machine images to launch into any environment, such as VirtualBox, VMware, Amazon EC2, etc. Because this build process is automated, you can develop in VirtualBox, then deploy to EC2 with an identical image.

Quick Start

First, get Packer by either downloading a pre-built Packer binary for your operating system or downloading and compiling Packer yourself.

After Packer is installed, build your first machine image.

$ packer build quick-start.toml
...

Packer will build an AMI according to the "quick-start" template. The AMI will be available in your AWS account. To delete the AMI, you must manually delete it using the AWS console. Packer builds your images, it does not manage their lifecycle. Where they go, how they're run, etc. is up to you.

Templates

Templates are static configurations that describe what machine images you want to create, how to create them, and what format you finally want them to be in.

Packer reads a template and builds all the requested machine images in parallel.

Templates are written in TOML. TOML is a fantastic configuration language that you can learn in minutes, and is very human-readable as well.

First, a complete template is shown below. Then, the details and structure of a template are discussed:

name = "my-custom-image"

[builder.amazon-ebs]
source = "ami-de0d9eb7"

[provision]

  [provison.shell]
  type = "shell"
  path = "script.sh"

[output]

  [output.vagrant]

Templates are comprised of three parts:

builders (1 or more) specify how the initial running system is built.
provisioners (0 or more) specify how to install and configure software from within the base running system.
outputs (0 or more) specify what to do with the completed system. For example, these can output Vagrant-compatible boxes, gzipped files, etc.

Developing Packer

If you wish to work on Packer itself, you'll first need Go installed. Next, clone this repository then just type make.

$ make
...
$ bin/packer --version