Packer is a tool for creating identical machine images for multiple platforms from a single source configuration.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Go to file
Jason A. Beranek 56ec6bf7af
common/command/template,packer/template: fix build name ConfigTemplate processing [GH-858]
12 years ago
builder Merge pull request #1397 from jfrazelle/disk_size 12 years ago
command command/build: -parallel=false to disable parallelization [GH-924] 12 years ago
common common/command/template,packer/template: fix build name ConfigTemplate processing [GH-858] 12 years ago
communicator/ssh communicator/ssh: remove background connection checker 12 years ago
packer common/command/template,packer/template: fix build name ConfigTemplate processing [GH-858] 12 years ago
plugin post-processor/vagrant-cloud: initial commit 12 years ago
post-processor post-processor/vagrant-cloud: fix multi-part corruption 12 years ago
provisioner Cleaned up Go formatting with gofmt. 12 years ago
scripts scripts: fix executable name when packer dir is a symlink 12 years ago
test test: high-level CLI tests that catch basic errors 12 years ago
website add disk size to google compute, so as to avoid disk size errors on exporting the image 12 years ago
.gitignore builder/virtualbox: move to iso/ folder 12 years ago
.travis.yml Remove race tests from travis, too many false 12 years ago
CHANGELOG.md Update CHANGELOG.md 12 years ago
CONTRIBUTING.md Add gox installation instructions to Contributing 12 years ago
LICENSE LICENSE: MPL2 13 years ago
Makefile Install gox during build time 12 years ago
README.md Update README.md 12 years ago
config.go post-processor/vagrant-cloud: initial commit 12 years ago
configfile.go Don't depend on os/user anymore, which requires cgo 13 years ago
configfile_unix.go Don't depend on os/user anymore, which requires cgo 13 years ago
configfile_windows.go Don't depend on os/user anymore, which requires cgo 13 years ago
packer.go core: Create cache directory only when needed [GH-367] 12 years ago
packer_test.go Fix packer test 13 years ago
panic.go add issues URL in crash detect output 13 years ago
signal.go packer/plugin: confirm cleanup at first signal received 13 years ago
stdin.go ctrl-c closes stdin for plugins so that they are unblocked 13 years ago

README.md

Packer

Packer is a tool for building identical machine images for multiple platforms from a single source configuration.

Packer is lightweight, runs on every major operating system, and is highly performant, creating machine images for multiple platforms in parallel. Packer comes out of the box with support for the following platforms:

  • Amazon EC2 (AMI). Both EBS-backed and instance-store AMIs
  • DigitalOcean
  • Docker
  • Google Compute Engine
  • OpenStack
  • Parallels
  • QEMU. Both KVM and Xen images.
  • VirtualBox
  • VMware

Support for other platforms can be added via plugins.

The images that Packer creates can easily be turned into Vagrant boxes.

Quick Start

Note: There is a great introduction and getting started guide for those with a bit more patience. Otherwise, the quick start below will get you up and running quickly, at the sacrifice of not explaining some key points.

First, download a pre-built Packer binary for your operating system or compile Packer yourself.

After Packer is installed, create your first template, which tells Packer what platforms to build images for and how you want to build them. In our case, we'll create a simple AMI that has Redis pre-installed. Save this file as quick-start.json. Be sure to replace any credentials with your own.

{
  "builders": [{
    "type": "amazon-ebs",
    "access_key": "YOUR KEY HERE",
    "secret_key": "YOUR SECRET KEY HERE",
    "region": "us-east-1",
    "source_ami": "ami-de0d9eb7",
    "instance_type": "t1.micro",
    "ssh_username": "ubuntu",
    "ami_name": "packer-example {{timestamp}}"
  }]
}

Next, tell Packer to build the image:

$ packer build quick-start.json
...

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.

Documentation

Full, comprehensive documentation is viewable on the Packer website:

http://www.packer.io/docs

Developing Packer

If you wish to work on Packer itself, you'll first need Go installed (version 1.2+ is required). Make sure you have Go properly installed, including setting up your GOPATH.

For some additional dependencies, Go needs Mercurial and Bazaar to be installed. Packer itself doesn't require these, but a dependency of a dependency does.

You'll also need gox to compile packer. You can install that with:

$ go get -u github.com/mitchellh/gox

Next, clone this repository into $GOPATH/src/github.com/mitchellh/packer and then just type make. In a few moments, you'll have a working packer executable:

$ make
...
$ bin/packer
...

If you need to cross-compile Packer for other platforms, take a look at scripts/dist.sh.

You can run tests by typing make test.

This will run tests for Packer core along with all the core builders and commands and such that come with Packer.

If you make any changes to the code, run make format in order to automatically format the code according to Go standards.

When new dependencies are added to packer you can use make updatedeps to get the latest and subsequently use make to compile and generate the packer binary.