Go to file
Megan Marsh 673858a63c
Merge pull request #9513 from hashicorp/undocument_ssh_temp_key
Undocument ssh options not used by all builders
2020-07-07 14:26:21 -07:00
.circleci Add Algolia indexing to CI 2020-06-29 15:43:35 -04:00
.github .github/workflows/issues: Add milestone labeling action 2020-06-10 15:10:48 -04:00
builder Merge pull request #9513 from hashicorp/undocument_ssh_temp_key 2020-07-07 14:26:21 -07:00
cmd appease linter 2020-05-29 09:40:31 -07:00
command Update build_windows_test.go 2020-07-07 12:00:36 +02:00
common add on-error flag option to run cleanup provisioner 2020-06-16 15:34:00 +02:00
communicator show a better error message in ssh.scpSession (#9217) 2020-05-13 15:57:05 +02:00
contrib Fix zsh auto-completion 2019-09-26 12:13:02 +01:00
examples Add complete HCL2 examples + allow to name a singular build.source blocks (#9490) 2020-07-02 11:07:59 +02:00
fix Refactor communicator config for Qemu and add SkipNatMapping option (#9307) 2020-06-02 11:56:36 +02:00
hcl2template fix error message typo (#9541) 2020-07-07 16:50:15 +02:00
helper undocument ssh_keypair_name and ssh_agent_auth 2020-07-02 14:55:58 +02:00
packer Update provisioner.go 2020-07-07 11:52:08 +02:00
plugin/example Add golangci-lint to project (#8686) 2020-02-14 11:42:29 -05:00
post-processor Merge pull request #9513 from hashicorp/undocument_ssh_temp_key 2020-07-07 14:26:21 -07:00
provisioner Correct check if PackerHttpAddr is implemented or not (#9498) 2020-06-29 16:17:21 +02:00
scripts ignore website label to prepare_changelog.sh (#9422) 2020-06-15 11:25:45 +02:00
template remove outdated comment 2020-05-29 09:43:31 -07:00
test builder/hyperone: Add tests for HCL syntax 2020-05-19 01:21:00 +02:00
vendor update ucloud-uhost builder (#9466) 2020-06-24 14:31:05 +02:00
version Putting source back into Dev Mode 2020-06-09 21:15:36 +00:00
website Merge pull request #9513 from hashicorp/undocument_ssh_temp_key 2020-07-07 14:26:21 -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-07-02 14:40:11 -07:00
CODEOWNERS Add CODEOWNERS of bats tests (#9259) 2020-05-19 15:05:57 -04: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 make generate: don't error when find does not find any file (#9413) 2020-06-12 16:30:44 +02:00
README.md Add Codecov badge and remove report style (#8896) 2020-03-16 15:59:55 +01: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 update ucloud-uhost builder (#9466) 2020-06-24 14:31:05 +02:00
go.sum update ucloud-uhost builder (#9466) 2020-06-24 14:31:05 +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 GoDoc 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.