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
Gennady Lipenkov b02401c41b
Update doc and example.
6 years ago
.circleci Add Algolia indexing to CI 6 years ago
.github
builder Fill up build variables (aka `generated_data`) 6 years ago
cmd
command Add yandex-import post-processor 6 years ago
common
communicator
contrib
examples Add complete HCL2 examples + allow to name a singular build.source blocks (#9490) 6 years ago
fix
hcl2template fix error message typo (#9541) 6 years ago
helper undocument ssh_keypair_name and ssh_agent_auth 6 years ago
packer fix typo 6 years ago
plugin/example
post-processor Update doc and example. 6 years ago
provisioner Correct check if PackerHttpAddr is implemented or not (#9498) 6 years ago
scripts
template
test
vendor builder/googlecompute: add support for oslogin (#9339) 6 years ago
version
website Update doc and example. 6 years ago
.codecov.yml
.gitattributes
.gitignore
.golangci.yml
.hashibot.hcl
CHANGELOG.md Add changelog record 6 years ago
CODEOWNERS Add record to CODEOWNERS 6 years ago
Dockerfile
LICENSE
Makefile
README.md Update copy for folks interested in maintaining a plugin 6 years ago
Vagrantfile
background_check.go
background_check_openbsd.go
checkpoint.go
commands.go
config.go
config_test.go
go.mod update ucloud-uhost builder (#9466) 6 years ago
go.sum builder/googlecompute: add support for oslogin (#9339) 6 years ago
log.go
main.go
main_test.go
panic.go
tty.go
tty_solaris.go

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.

Unmaintained Plugins

As contributors' circumstances change, development on a community-maintained plugins 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.