Go to file
Megan Marsh 517834d528 Revert "Revert "remove clean_ami_name and clean_image_name; complete the deprecation for these functions in favor of clean_resource_name""
This reverts commit 44f91c9afc.
2019-11-04 14:28:40 -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 Revert "Revert "remove clean_ami_name and clean_image_name; complete the deprecation for these functions in favor of clean_resource_name"" 2019-11-04 14:28:40 -08:00
cmd Change back to make sure all durations are a time.Duration 2019-10-31 16:12:07 +01:00
command update ucloud packer 2019-10-29 16:11:43 -07:00
common Merge pull request #8310 from alrs/resuscitate-common-floppy-tests 2019-11-04 15:50:46 +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 Move fixer test to fix package 2019-07-24 18:04:17 +01:00
hcl2template Force durations to be passed a strings 2019-10-31 11:47:19 +01:00
helper Change back to make sure all durations are a time.Duration 2019-10-31 16:12:07 +01:00
packer packer/rpc: remove unused cancelCalled field from testBuild{} 2019-11-04 12:59:55 -08:00
plugin/example delete unneeded plugin file 2017-09-28 10:52:54 -07:00
post-processor Merge pull request #8307 from hashicorp/fix_8116 2019-11-01 14:55:22 -07:00
provisioner Change back to make sure all durations are a time.Duration 2019-10-31 16:12:07 +01:00
scripts change installation of pigeon if off gopath 2019-07-01 12:16:50 -07:00
template Change back to make sure all durations are a time.Duration 2019-10-31 16:12:07 +01:00
test SSH tunneling support 2019-09-18 11:09:41 -07:00
vendor go mod vendor 2019-10-30 10:49:33 -07:00
version Update version.go 2019-11-04 19:01:09 +01:00
website Revert "Revert "remove clean_ami_name and clean_image_name; complete the deprecation for these functions in favor of clean_resource_name"" 2019-11-04 14:28:40 -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.md 2019-11-04 18:05:06 +01:00
CODEOWNERS Add builder CODEOWNERS to respective docs 2019-10-08 11:04:42 +02: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 use port as ints 2019-03-19 15:01:12 +01:00
go.mod Cut version 1.4.5 2019-11-04 18:43:29 +01:00
go.sum Cut version 1.4.5 2019-11-04 18:43:29 +01:00
log.go deduplicate loglines that stream both to ui ERROR call and to streaming logs when PACKER_LOG=1 2019-07-25 16:33:02 -07:00
main.go build differently for openbsd because we can't cross compile the process library 2019-09-18 10:51:46 -07: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.