packer

command module
Version: v0.12.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 2, 2017 License: MPL-2.0 Imports: 25 Imported by: 0

README

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 the following platforms:

  • Amazon EC2 (AMI). Both EBS-backed and instance-store AMIs
  • Azure
  • DigitalOcean
  • Docker
  • Google Compute Engine
  • OpenStack
  • Parallels
  • QEMU. Both KVM and Xen images.
  • VirtualBox
  • VMware

Support for other platforms can be added via plugins.

The images that Packer creates can easily be turned into Vagrant boxes.

Quick Start

Download and install packages and dependencies

go get github.com/mitchellh/packer

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:

http://www.packer.io/docs

Developing Packer

See CONTRIBUTING.md for best practices and instructions on setting up your development environment to work on Packer.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
builder
amazon/chroot
The chroot package is able to create an Amazon AMI without requiring the launch of a new instance for every build.
The chroot package is able to create an Amazon AMI without requiring the launch of a new instance for every build.
amazon/ebs
The amazonebs package contains a packer.Builder implementation that builds AMIs for Amazon EC2.
The amazonebs package contains a packer.Builder implementation that builds AMIs for Amazon EC2.
amazon/ebssurrogate
The ebssurrogate package contains a packer.Builder implementation that builds a new EBS-backed AMI using an ephemeral instance.
The ebssurrogate package contains a packer.Builder implementation that builds a new EBS-backed AMI using an ephemeral instance.
amazon/ebsvolume
The ebsvolume package contains a packer.Builder implementation that builds EBS volumes for Amazon EC2 using an ephemeral instance,
The ebsvolume package contains a packer.Builder implementation that builds EBS volumes for Amazon EC2 using an ephemeral instance,
amazon/instance
The instance package contains a packer.Builder implementation that builds AMIs for Amazon EC2 backed by instance storage, as opposed to EBS storage.
The instance package contains a packer.Builder implementation that builds AMIs for Amazon EC2 backed by instance storage, as opposed to EBS storage.
azure/pkcs12
Package pkcs12 provides some implementations of PKCS#12.
Package pkcs12 provides some implementations of PKCS#12.
azure/pkcs12/rc2
Package rc2 implements the RC2 cipher https://www.ietf.org/rfc/rfc2268.txt http://people.csail.mit.edu/rivest/pubs/KRRR98.pdf This code is licensed under the MIT license.
Package rc2 implements the RC2 cipher https://www.ietf.org/rfc/rfc2268.txt http://people.csail.mit.edu/rivest/pubs/KRRR98.pdf This code is licensed under the MIT license.
googlecompute
The googlecompute package contains a packer.Builder implementation that builds images for Google Compute Engine.
The googlecompute package contains a packer.Builder implementation that builds images for Google Compute Engine.
vmware/common
These functions are compatible with WS 9 and 10 on *NIX These functions are compatible with WS 9 and 10 on *NIX
These functions are compatible with WS 9 and 10 on *NIX These functions are compatible with WS 9 and 10 on *NIX
ssh
communicator
ssh
helper
plugin
The plugin package provides the functionality to both expose a Packer plugin binary and to connect to an existing Packer plugin binary.
The plugin package provides the functionality to both expose a Packer plugin binary and to connect to an existing Packer plugin binary.
rpc
plugin
example
This is an example plugin.
This is an example plugin.
post-processor
vagrant
vagrant implements the packer.PostProcessor interface and adds a post-processor that turns artifacts of known builders into Vagrant boxes.
vagrant implements the packer.PostProcessor interface and adds a post-processor that turns artifacts of known builders into Vagrant boxes.
vagrant-cloud
vagrant_cloud implements the packer.PostProcessor interface and adds a post-processor that uploads artifacts from the vagrant post-processor to Vagrant Cloud (vagrantcloud.com) or manages self hosted boxes on the Vagrant Cloud
vagrant_cloud implements the packer.PostProcessor interface and adds a post-processor that uploads artifacts from the vagrant post-processor to Vagrant Cloud (vagrantcloud.com) or manages self hosted boxes on the Vagrant Cloud
chef-client
This package implements a provisioner for Packer that uses Chef to provision the remote machine, specifically with chef-client (that is, with a Chef server).
This package implements a provisioner for Packer that uses Chef to provision the remote machine, specifically with chef-client (that is, with a Chef server).
chef-solo
This package implements a provisioner for Packer that uses Chef to provision the remote machine, specifically with chef-solo (that is, without a Chef server).
This package implements a provisioner for Packer that uses Chef to provision the remote machine, specifically with chef-solo (that is, without a Chef server).
powershell
This package implements a provisioner for Packer that executes shell scripts within the remote machine.
This package implements a provisioner for Packer that executes shell scripts within the remote machine.
puppet-masterless
This package implements a provisioner for Packer that executes Puppet on the remote machine, configured to apply a local manifest versus connecting to a Puppet master.
This package implements a provisioner for Packer that executes Puppet on the remote machine, configured to apply a local manifest versus connecting to a Puppet master.
puppet-server
This package implements a provisioner for Packer that executes Puppet on the remote machine connecting to a Puppet master.
This package implements a provisioner for Packer that executes Puppet on the remote machine connecting to a Puppet master.
salt-masterless
This package implements a provisioner for Packer that executes a saltstack state within the remote machine
This package implements a provisioner for Packer that executes a saltstack state within the remote machine
shell
This package implements a provisioner for Packer that executes shell scripts within the remote machine.
This package implements a provisioner for Packer that executes shell scripts within the remote machine.
windows-shell
This package implements a provisioner for Packer that executes shell scripts within the remote machine.
This package implements a provisioner for Packer that executes shell scripts within the remote machine.
Generate Plugins is a small program that updates the lists of plugins in command/plugin.go so they will be compiled into the main packer binary.
Generate Plugins is a small program that updates the lists of plugins in command/plugin.go so they will be compiled into the main packer binary.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL