packer-cn/README.md
Josh Soref b68168807a Miscellaneous doc improvements
backticks, spaces, commas

In general, a list of items should have a space after each comma.
While there are editorial styles that suggest commas inside quotations,
they're horrible advice when the backticks are describing specific
character for a user to enter.

one off indent filters section

singular

backticks...

word wrap long lines...

spelling: macOS

contributing: clarify closing case
contributing: link to changelog
contributing: point to git remote...
contributing: split commands from descriptions
contributing: grammar
spelling: github
grammar: comma after etc.
spelling: macOS
grammar: i.e.
alicloud: use relative link
alicloud: use backticks
alicloud: bits
alicloud: such as
grammar: comma after etc.
avoid linking periods
grammar: period
amazon-chroot: IOPS
amazon-chroot: use backticks
amazon-chroot: link to section
amazon-chroot: whether-or-not; period
amazon-ebs: period
amazon-ebs: use relative link
amazon-ebs: use backticks
amazon-ebs: comma
amazon-ebs: bold
amazon-ebssurrogate: comma after etc.
amazon-ebssurrogate: this builder
amazon-instance: this builder
amazon-ebssurrogate: set this
amazon-ebssurrogate: whether-or-not
amazon-ebssurrogate: period
amazon-ebssurrogate: bold section reference
amazon-ebssurrogate: backticks...
amazon-ebssurrogate: commas around e.g.
spelling: precedence
spelling: i.e.
amazon-ebssurrogate: backticks...
2018-10-18 19:09:49 -04:00

3.4 KiB

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 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.