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
Stefan Scherer 8b10e70bc8
fixed packer --version
11 years ago
builder builder/digitalocean: default to nyc3 11 years ago
command command/push: update help text 11 years ago
common Merge pull request #1402 from jasonberanek/858-issue 11 years ago
communicator/ssh communicator/ssh: upload proper source [GH-1484] 12 years ago
fix command: move all remaining commands 11 years ago
packer command/push: add base_dir setting 11 years ago
plugin post-processor/atlas: make it 11 years ago
post-processor Merge pull request #1748 from BlackIkeEagle/constant-4294967295-overflows-int 11 years ago
provisioner added ssl_verify_mode parameter to chef-client provisioner 11 years ago
scripts scripts: ignore errors on gox for now 12 years ago
test fixed packer --version 11 years ago
website Fix broken links in the DigitalOcean documentation 11 years ago
.gitignore Add Vagrantfile for cross cmpiling 12 years ago
.travis.yml Update travis to try to avoid failures 12 years ago
CHANGELOG.md Update CHANGELOG 11 years ago
CONTRIBUTING.md Add gox installation instructions to Contributing 12 years ago
LICENSE LICENSE: MPL2 13 years ago
Makefile Cleanup updatedeps more 11 years ago
README.md Update scripts to latest HashiCorp style 12 years ago
Vagrantfile Remove Vagrant constants [GH-1566] 12 years ago
checkpoint.go Remove version from "packer" package 11 years ago
commands.go hook up push to commands 11 years ago
config.go remove command configs 11 years ago
config_unix.go website: update website to point to proper directory 12 years ago
config_windows.go website: update website to point to proper directory 12 years ago
log.go command: move more to this package, remove old packages 11 years ago
main.go fixed packer --version 11 years ago
main_test.go Rename some files, style 11 years ago
panic.go Rename some files, style 11 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
version.go Update CHANGELOG 11 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 or any of its built-in providers, you'll first need Go installed (version 1.2+ is required). Make sure Go is properly installed, including setting up a GOPATH.

Next, install the following software packages, which are needed for some dependencies:

Then, install Gox, which is used as a compilation tool on top of Go:

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

Next, clone this repository into $GOPATH/src/github.com/mitchellh/packer. Install the necessary dependencies by running make updatedeps and then just type make. This will compile some more dependencies and then run the tests. If this exits with exit status 0, then everything is working!

$ make updatedeps
...
$ make
...

To compile a development version of Packer and the built-in plugins, run make dev. This will put Packer binaries in the bin folder:

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

If you're developing a specific package, you can run tests for just that package by specifying the TEST variable. For example below, only packer package tests will be run.

$ make test TEST=./packer
...