Go to file
PacoDw 1055007cba :chore: added OSC API Client Connection 2020-08-17 10:02:00 -05:00
.circleci Add Algolia indexing to CI 2020-06-29 15:43:35 -04:00
.github Update feature_requests.md 2020-07-24 13:34:15 +02:00
builder :chore: added OSC API Client Connection 2020-08-17 10:02:00 -05:00
cmd fix generator to work even in nested packer/packer dirs 2020-08-06 13:24:15 -07:00
command HCL2: add post-processors block to run multiple post-processor after a build (#9638) 2020-07-28 10:02:37 +02:00
common Merge pull request #9697 from backerman/personal/backerman/9695 2020-08-10 12:47:48 -07:00
communicator adding basic support for OpenSSH CertificateFile support 2020-07-10 16:54:08 -07:00
contrib Fix zsh auto-completion 2019-09-26 12:13:02 +01:00
examples Don't deprovision in chroot. 2020-08-08 18:44:39 -07:00
fix Refactor communicator config for Qemu and add SkipNatMapping option (#9307) 2020-06-02 11:56:36 +02:00
hcl2template Make max_retries a string to allow variable interpolation (#9673) 2020-08-05 17:41:20 +02:00
helper refactor initialization out from packer configs + tests (#9627) 2020-07-24 10:58:03 +02:00
packer skip post-processors when build is cancelled 2020-08-06 14:40:02 +02:00
plugin/example Add golangci-lint to project (#8686) 2020-02-14 11:42:29 -05:00
post-processor Fix ReregisterVM to default to true instead of false. (#9736) 2020-08-10 13:13:14 +02:00
provisioner Merge pull request #9726 from acornies/feature/salt-masterless-formulas 2020-08-10 09:19:49 -07:00
scripts ignore website label to prepare_changelog.sh (#9422) 2020-06-15 11:25:45 +02:00
template Make max_retries a string to allow variable interpolation (#9673) 2020-08-05 17:41:20 +02:00
test builder/hyperone: Add tests for HCL syntax 2020-05-19 01:21:00 +02:00
vendor Updated implementation to go-getter/v2 2020-08-10 09:41:44 -04:00
version Putting source back into Dev Mode 2020-07-30 20:51:22 +00:00
website Merge pull request #9741 from hashicorp/on_error_docs 2020-08-10 13:57:34 -07:00
.codecov.yml remove codecov status (#9225) 2020-05-14 16:02:51 +02:00
.gitattributes clean up documentation for new NIC and storage params 2020-04-13 14:28:50 -04:00
.gitignore scrape builder docs from https://www.packer.io/docs/ 2019-06-05 16:41:20 +02:00
.golangci.yml Add golangci-lint to project (#8686) 2020-02-14 11:42:29 -05:00
.hashibot.hcl update hashibot config not to comment when locking super old and stale issues 2020-04-03 11:37:34 -07:00
CHANGELOG.md update changelog 2020-08-07 10:00:55 -07:00
CODEOWNERS Add record to CODEOWNERS 2020-07-08 22:01:52 +03: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 change default target to just make the dev binaries (#9706) 2020-08-05 13:32:24 +02:00
README.md Add CircleCI badge 2020-07-22 19:56:55 +02:00
Vagrantfile vagrantfile: add support for docker provider 2018-10-31 16:58:06 +03: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 make period stripping more strict so that users can disable provisiners by adding .old or whatever; this is pretty typical convention. 2020-02-13 12:59:47 -08:00
config_test.go Merge pull request #8616 from hashicorp/packer-plugin-path 2020-01-28 12:09:55 -08:00
go.mod Updated implementation to go-getter/v2 2020-08-10 09:41:44 -04:00
go.sum tencentcloud cvm use CLOUD_PREMIUM disk by default (#9663) 2020-07-29 15:10:00 +02: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 enable force, debug, and on-error for hcl2 builds 2020-05-14 16:22:51 -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 PkgGoDev GoReportCard codecov

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.

Unmaintained Plugins

As contributors' circumstances change, development on a community maintained plugin can slow. When this happens, the Packer team may mark a plugin as unmaintained, to clearly signal the plugin's status to users.

What does unmaintained mean?

  1. The code repository and all commit history will still be available.
  2. Documentation will remain on the Packer website.
  3. Issues and pull requests are monitored as a best effort.
  4. No active development will be performed by the Packer team.

If anyone form them community is interested in maintaining a community supported plugin, please feel free to submit contributions via a pull- request for review; reviews are generally prioritized over feature work when possible. For a list of open plugin issues and pending feature requests see the Packer Issue Tracker.