Go to file
Rens Sikma 3d8bda31a4 modify docstring 2020-02-20 12:54:35 +01:00
.circleci pin to go 1.13 & cleanup go deps 2019-09-05 17:11:08 +02:00
.github fix rcp --> rpc typo (#8665) 2020-01-29 10:49:50 +01:00
builder modify docstring 2020-02-20 12:54:35 +01:00
cmd Rename method writeSpecField to goFieldToCtyType (#8687) 2020-02-04 16:37:25 +01:00
command remove extraneous files from when vsphere builder was a plugin, and move README into packer website as separated docs for vsphere-clone and vsphere-iso. Move option descriptions into struct code, and generate documentation directly from those structs as we do inside of the other builders 2020-01-07 16:59:31 -08:00
common Merge pull request #8689 from hashicorp/fix_8530 2020-02-04 13:43:09 -08: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 Format code with `gofmt -s -w` 2020-01-28 16:52:50 -05:00
hcl2template Fix HCL2 code generation for slices within another slice (#8669) 2020-02-03 17:03:28 +01:00
helper allow user to set winrm_host override like we do ssh_host override 2020-01-30 15:22:22 -08:00
packer Merge pull request #8654 from hashicorp/fix_8583 2020-01-28 08:50:48 -08:00
plugin/example delete unneeded plugin file 2017-09-28 10:52:54 -07:00
post-processor fix #8679 with source_image_project_id as list 2020-02-06 10:30:04 +01:00
provisioner Add packer.ExpandUser() function to support tilde in usage of config.ValidationKeyPath (#8657) 2020-01-28 14:33:42 +01:00
scripts scripts/vagrant: Update Vagrant bootstrapping scripts 2020-01-15 12:42:15 -05:00
template template: replace deprecated os.SEEK_SET with io.SeekStart 2020-02-05 08:56:59 -08:00
test test: Generalize README to avoid AWS 2019-12-03 14:57:41 +01:00
vendor builder/ncloud: Migrate ncloud-sdk-go-v1 to ncloud-sdk-go-v2 (#8678) 2020-02-03 14:55:01 +01:00
version update to 1.5.2-dev 2019-12-20 11:37:09 -08:00
website modify docstring 2020-02-20 12:54:35 +01: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
.hashibot.hcl Update .hashibot.hcl 2020-01-22 17:15:34 +01:00
.travis.yml test osx on travis 2019-09-27 15:08:22 +02:00
CHANGELOG.md update changelog 2020-01-27 12:00:36 -08:00
CODEOWNERS add @alexyueer to codeowners for alicloud 2020-01-07 12:48:38 -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 Merge pull request #8616 from hashicorp/packer-plugin-path 2020-01-28 12:09:55 -08:00
config_test.go Merge pull request #8616 from hashicorp/packer-plugin-path 2020-01-28 12:09:55 -08:00
go.mod builder/ncloud: Migrate ncloud-sdk-go-v1 to ncloud-sdk-go-v2 (#8678) 2020-02-03 14:55:01 +01:00
go.sum builder/ncloud: Migrate ncloud-sdk-go-v1 to ncloud-sdk-go-v2 (#8678) 2020-02-03 14:55:01 +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 config: Fix loading external plugins from a packerconfig 2020-01-15 13:08:30 -05: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.