Go to file
Megan Marsh a8a3758cc8
Cut version 1.5.0
2019-12-18 15:57:46 -08:00
.circleci pin to go 1.13 & cleanup go deps 2019-09-05 17:11:08 +02:00
.github Document how code generation works a little in .github/CONTRIBUTING.md 2019-10-29 15:29:29 +01:00
builder Merge pull request #8498 from hashicorp/f-builder_docker-typeassertion-check 2019-12-17 18:08:00 -05:00
cmd build using HCL2 (#8423) 2019-12-17 11:25:56 +01:00
command fix pps 2019-12-17 16:13:21 -08:00
common Merge remote-tracking branch 'origin/master' into sharing_info 2019-12-17 11:57:09 +01:00
communicator fixup: Propagate bind errors up 2019-09-18 11:09:41 -07:00
contrib Fix zsh auto-completion 2019-09-26 12:13:02 +01:00
examples update bucket about no create 2019-10-29 16:11:43 -07:00
fix removed escape character check, updated synopsis string, change type to 'ansbile-local' only 2019-11-27 20:27:24 -05:00
hcl2template fix pps 2019-12-17 16:13:21 -08:00
helper clean up a few final issues with info sharing 2019-12-17 11:20:57 -08:00
packer regenerate builder mock 2019-12-17 13:49:16 -08:00
plugin/example delete unneeded plugin file 2017-09-28 10:52:54 -07:00
post-processor Merge remote-tracking branch 'origin/master' into sharing_info 2019-12-17 11:57:09 +01:00
provisioner Merge remote-tracking branch 'origin/master' into sharing_info 2019-12-17 11:57:09 +01:00
scripts Cut version 1.5.0 2019-12-18 15:54:41 -08:00
template add tests for info sharing 2019-12-17 13:41:48 -08:00
test test: Generalize README to avoid AWS 2019-12-03 14:57:41 +01:00
vendor build using HCL2 (#8423) 2019-12-17 11:25:56 +01:00
version cut packer release v1.5.0 2019-12-18 10:08:52 -08:00
website cut packer release v1.5.0 2019-12-18 10:08:52 -08:00
.gitattributes refresh line endings 2019-05-17 14:58:20 -07:00
.gitignore scrape builder docs from https://www.packer.io/docs/ 2019-06-05 16:41:20 +02:00
.travis.yml test osx on travis 2019-09-27 15:08:22 +02:00
CHANGELOG.md update changelog date 2019-12-18 10:08:17 -08:00
CODEOWNERS fix docs index 2019-11-05 19:07:09 +08:00
Dockerfile dockerfile: add minimal image with provisioners support 2018-10-31 16:58:06 +03:00
LICENSE LICENSE: MPL2 2013-06-24 14:29:15 -07:00
Makefile Update Makefile 2019-10-16 10:24:34 +02:00
README.md Miscellaneous doc improvements 2018-10-18 19:09:49 -04:00
Vagrantfile vagrantfile: add support for docker provider 2018-10-31 16:58:06 +03:00
appveyor.yml remove appveyor and travis cfg files 2019-09-05 17:17:59 +02:00
background_check.go surface notimplemented errs too 2019-09-19 08:57:50 -07:00
background_check_openbsd.go copypasta 2019-09-18 10:54:35 -07:00
checkpoint.go move packer to hashicorp 2017-04-04 13:39:01 -07:00
commands.go implement a packer console analogous to the terraform console 2019-06-05 16:35:22 -07:00
config.go build using HCL2 (#8423) 2019-12-17 11:25:56 +01:00
go.mod build using HCL2 (#8423) 2019-12-17 11:25:56 +01:00
go.sum build using HCL2 (#8423) 2019-12-17 11:25:56 +01:00
log.go log errors in scanner and manually close logging pipe if we hit an error in the scanner 2019-11-11 09:20:39 -08:00
main.go build using HCL2 (#8423) 2019-12-17 11:25:56 +01:00
main_test.go move packer to hashicorp 2017-04-04 13:39:01 -07:00
panic.go Add telemetry reporting through checkpoint 2017-06-15 13:21:11 -07:00
tty.go allow building packer on solaris by removing progress bar and tty imports 2019-05-07 15:58:49 +02:00
tty_solaris.go allow building packer on solaris by removing progress bar and tty imports 2019-05-07 15:58:49 +02:00

README.md

Packer

Build Status Windows Build Status GoDoc GoReportCard

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 many platforms, the full list of which can be found at https://www.packer.io/docs/builders/index.html.

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. Export your AWS credentials as the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables.

{
  "variables": {
    "access_key": "{{env `AWS_ACCESS_KEY_ID`}}",
    "secret_key": "{{env `AWS_SECRET_ACCESS_KEY`}}"
  },
  "builders": [{
    "type": "amazon-ebs",
    "access_key": "{{user `access_key`}}",
    "secret_key": "{{user `secret_key`}}",
    "region": "us-east-1",
    "source_ami": "ami-af22d9b9",
    "instance_type": "t2.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

Comprehensive documentation is viewable on the Packer website:

https://www.packer.io/docs

Developing Packer

See CONTRIBUTING.md for best practices and instructions on setting up your development environment to work on Packer.