Packer is a tool for creating identical machine images for multiple platforms from a single source configuration.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Go to file
Megan Marsh 19bdc8b49e
fix conflicts
5 years ago
.circleci Use docker mirror 5 years ago
.github update tests and website and generated partials to reflect new package format 5 years ago
builder fix conflicts 5 years ago
cmd move hcl2template kv types into the config/custom_types with trilean definitions 5 years ago
command fix tests by moving mock hooks and communicators, and BasicUi definition, into SDK 5 years ago
contrib docs tweaks 5 years ago
examples Extract plugin-specific examples to plugin directories (#10228) 5 years ago
fix fix fixer deprecated options conflict 5 years ago
hcl2template Move hook and communicator definitions to packer-plugin-sdk 5 years ago
helper fix tests by moving mock hooks and communicators, and BasicUi definition, into SDK 5 years ago
packer fix imports, vendoring, and linting 5 years ago
packer-plugin-sdk fix imports, vendoring, and linting 5 years ago
plugin/example Add golangci-lint to project (#8686) 6 years ago
post-processor fix conflicts 5 years ago
provisioner fix conflicts 5 years ago
scripts scripts/generate-plugins.go: ignore "common" packages 5 years ago
test Fix line ending issues for test files (#10096) 5 years ago
vendor fix imports, vendoring, and linting 5 years ago
version move version and useragent definitions into sdk 5 years ago
website Fix SSH-Private-Key-File to the vsphere-iso mdx file 5 years ago
.codecov.yml add step_add_floppy unit tests 5 years ago
.gitattributes Update .gitattributes 5 years ago
.gitignore Added support for IAM credential in the token field and YC_TOKEN env 5 years ago
.golangci.yml Add golangci-lint to project (#8686) 6 years ago
.hashibot.hcl update hashibot config not to comment when locking super old and stale issues 6 years ago
CHANGELOG.md Merge branch 'master' into yandex/prepare-user-data 5 years ago
CODEOWNERS update scaleway code owners (#9852) 6 years ago
Dockerfile Use docker mirror 5 years ago
LICENSE LICENSE: MPL2 13 years ago
Makefile move version and useragent definitions into sdk 5 years ago
README.md Fix a broken link in the README (#10259) 5 years ago
Vagrantfile vagrantfile: add support for docker provider 7 years ago
background_check.go surface notimplemented errs too 7 years ago
background_check_openbsd.go copypasta 7 years ago
checkpoint.go move packer to hashicorp 9 years ago
commands.go Add packer fmt command (#10225) 5 years ago
config.go Move hook and communicator definitions to packer-plugin-sdk 5 years ago
config_test.go Merge pull request #8616 from hashicorp/packer-plugin-path 6 years ago
go.mod move Ui definition into the packer plugin sdk. 5 years ago
go.sum move steps and step configs from packer/common to packer/common/commonsteps 5 years ago
log.go log errors in scanner and manually close logging pipe if we hit an error in the scanner 6 years ago
main.go fix tests by moving mock hooks and communicators, and BasicUi definition, into SDK 5 years ago
main_test.go move packer to hashicorp 9 years ago
panic.go Add telemetry reporting through checkpoint 9 years ago
tty.go allow building packer on solaris by removing progress bar and tty imports 7 years ago
tty_solaris.go fix imports, vendoring, and linting 5 years ago

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.

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.