Go to file
Megan Marsh 59307d6d02
Merge pull request #7124 from hashicorp/fix_7120
clarify use of split function in docs
2018-12-18 10:08:37 -08:00
.circleci clean up config.yml and decrease number of parallel processes in build 2018-11-19 16:02:43 -08:00
.github Fix link 2018-12-15 11:36:47 +00:00
builder Merge pull request #7111 from hashicorp/pr-7077-azure-regression 2018-12-18 09:53:52 -08:00
command make packer inspect not print sensitive variables. 2018-12-07 12:02:20 -08:00
common Revert "Fix previous change introduced in patch #7030" 2018-12-13 11:34:37 -08:00
communicator Add more detail for errors where the problem is that TEMPDIR is filled up 2018-11-08 15:21:40 -08:00
contrib Try to make help more consistent 2018-10-10 21:34:35 -04:00
examples update windows examples 2018-11-26 17:12:30 +08:00
fix Revert "Rename attribute api_access_key to organization_id" 2018-11-08 16:34:23 -08:00
helper gofmt using v1.11.2 instead of disro's outdated v1.10.5. 2018-12-04 16:54:49 -06:00
packer Revert "mux_broker_test.go: make non blocking errChan" 2018-12-17 13:49:47 -08:00
plugin/example delete unneeded plugin file 2017-09-28 10:52:54 -07:00
post-processor Move logging about aws waiters to the access config prepare() so that it's only spit out once per builder. 2018-12-06 14:37:31 -08:00
provisioner Merge pull request #7078 from aspectcapital/issue-5478 2018-12-14 19:06:46 -08:00
scripts scripts: add gcc package for using gco on build 2018-10-31 16:58:07 +03:00
template Formatting 2018-11-05 12:30:41 -08:00
test Miscellaneous doc improvements 2018-10-18 19:09:49 -04:00
vendor Revert "Removed mitchellh/go-homedir from vendor packages." 2018-12-04 16:54:49 -06:00
version update to v1.3.4-dev 2018-12-05 11:05:34 -08:00
website clarify use of split function in docs 2018-12-17 11:40:27 -08:00
.gitattributes too many files for shell during Make, convert .go and .sh to EOL=lf 2018-04-07 05:22:39 -04:00
.gitignore switch to netlify deployment 2018-09-19 12:17:28 -07:00
.travis.yml travis-ci: allow failures on windows 2018-10-17 13:44:27 +02:00
CHANGELOG.md Update CHANGELOG.md 2018-12-17 12:36:15 +01:00
CODEOWNERS whitespace 2018-11-28 10:38:53 -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 clean up config.yml and decrease number of parallel processes in build 2018-11-19 16:02:43 -08: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 revert appveyor skips as windows builds are pretty unstable 2018-10-17 13:38:53 +02:00
checkpoint.go move packer to hashicorp 2017-04-04 13:39:01 -07:00
commands.go Complete Atlas deprecation. 2018-08-02 20:23:28 -07:00
config.go move packer to hashicorp 2017-04-04 13:39:01 -07:00
go.mod go mod verify & go get github.com/hetznercloud/hcloud-go 2018-12-11 17:46:54 +01:00
go.sum go mod verify & go get github.com/hetznercloud/hcloud-go 2018-12-11 17:46:54 +01:00
log.go Use Sprint() instead of Sprintf() in log dedupe 2018-10-09 22:43:54 -04:00
main.go document wrapConfig a little 2018-09-24 16:24:43 +02: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
stdin.go Gracefully clean up on SIGTERM 2017-09-08 11:42:32 -07: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.