Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Packer 1.7 support #5

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
packer-builder-qemu-chroot
packer-plugin-qemu-chroot
cover.out
output-qemu-chroot/
vendor/
Expand Down
7 changes: 7 additions & 0 deletions .markdownlint.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---

default: true
MD007:
indent: 4
MD013:
line_length: 300
3 changes: 2 additions & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
language: go
go:
- "1.11.x"
- "1.17"
before_install:
- curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh
- curl https://raw.githubusercontent.com/go-task/task/master/install-task.sh | sh
Expand Down
21 changes: 21 additions & 0 deletions .yamllint
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
extends: default
ignore: |
.git/
*_cache/
*-info/
build/
dist/
output-qemu-chroot/
vendor/
tmp/

rules:
braces:
min-spaces-inside: 1
max-spaces-inside: 1
comments:
min-spaces-from-content: 1
empty-values: enable
line-length:
max: 120
144 changes: 0 additions & 144 deletions Gopkg.lock

This file was deleted.

3 changes: 0 additions & 3 deletions Gopkg.toml

This file was deleted.

49 changes: 25 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ A builder plugin of Packer to support building QEMU images within chroot.

## Prerequirements

This plugin depends on the following tools:
This plugin depends on the following:

- Packer
- QEMU Utilities (`qemu-nbd` and `qemu-img`)
- NBD kernel module
- [Packer](https://github.com/hashicorp/packer)
- [QEMU Utilities](https://www.qemu.org) (`qemu-nbd` and `qemu-img`)
- [Network block device](https://github.com/NetworkBlockDevice/nbd) (NBD) kernel module

## Install

Expand All @@ -20,11 +20,11 @@ Download the binary from the [Releases](https://github.com/summerwind/packer-bui

## Building plugin

To build the binary you need to install [Go](https://golang.org/), [dep](https://github.com/golang/dep) and [task](https://github.com/go-task/task).
To build the binary you need to install [Go](https://golang.org/), [packer-sdc](https://www.packer.io/guides/hcl/component-object-spec) and [task](https://github.com/go-task/task).

```
$ task vendor
$ task build
```sh
> task vendor
> task build
```

## How does it work?
Expand All @@ -37,17 +37,17 @@ Using this process eliminates the need to start the virtual machine, so you can

To use this plugin, you need to load the NBD kernel module first. Note that this process must be executed on a Linux.

```
$ sudo modprobe nbd
```sh
sudo modprobe nbd
```

Prepare the following template file.

```
$ vim template.json
```sh
vim template.json
```

```
```json
{
"builders": [
{
Expand All @@ -64,14 +64,14 @@ $ vim template.json
"apt update"
]
}
]
]
}
```

Once you have the template, build it using Packer.

```
$ sudo packer build template.json
```sh
sudo packer build template.json
```

## Configuration Reference
Expand All @@ -82,16 +82,18 @@ $ sudo packer build template.json

### Optional

- `output_directory` (string) - This is the path to the directory where the resulting image file will be created. By default this is "output-BUILDNAME" where "BUILDNAME" is the name of the builder.
- `output_directory` (string) - This is the path to the directory where the resulting image file will be created. By default this is `output-BUILDNAME` where "BUILDNAME" is the name of the builder.
- `image_name` (string) - The name of the resulting image file.
- `compression` (boolean) - Apply compression to the QCOW2 disk file using `qemu-img` convert. Defaults to false.
- `device_path` (string) - The path to the device where the volume of the source image will be attached.
- `mount_path` (string) - The path where the volume will be mounted. This is where the chroot environment will be. This defaults to /mnt/packer-builder-qemu-chroot/{{.Device}}. This is a configuration template where the .Device variable is replaced with the name of the device where the volume is attached.
- `mount_partition` (integer) - The partition number containing the / partition. By default this is the first partition of the volume.
- `mount_path` (string) - The path where the volume will be mounted. This is where the chroot environment will be. This defaults to `/mnt/packer-builder-qemu-chroot/{{.Device}}`.
This is a configuration template where the `.Device` variable is replaced with the name of the device where the volume is attached.
- `mount_partition` (integer) - The partition number containing the `/` partition. By default this is the first partition of the volume.
- `mount_options` (array of string) - Options to supply the mount command when mounting devices. Each option will be prefixed with `-o` and supplied to the mount command ran by this plugin.
- `chroot_mounts` (array of array of string) - This is a list of devices to mount into the chroot environment. This configuration parameter requires some additional documentation which is in the "Chroot Mounts" section below. Please read that section for more information on how to use this.
- `copy_files` (array of string) - Paths to files on the running EC2 instance that will be copied into the chroot environment prior to provisioning. Defaults to /etc/resolv.conf so that DNS lookups work. Pass an empty list to skip copying /etc/resolv.conf. You may need to do this if you're building an image that uses systemd.
- `command_wrapper` (string) - How to run shell commands. This defaults to {{.Command}}. This may be useful to set if you want to set environmental variables or perhaps run it with sudo or so on. This is a configuration template where the .Command variable is replaced with the command to be run. Defaults to "{{.Command}}".
- `copy_files` (array of string) - Paths to files on the running EC2 instance that will be copied into the chroot environment prior to provisioning. Defaults to `/etc/resolv.conf` so that DNS lookups work. Pass an empty list to skip copying `/etc/resolv.conf`.
You may need to do this if you're building an image that uses systemd.
- `command_wrapper` (string) - How to run shell commands. This defaults to `{{.Command}}`. This may be useful to set if you want to set environmental variables or perhaps run it with sudo or so on. This is a configuration template where the .Command variable is replaced with the command to be run.

### Chroot Mounts

Expand All @@ -103,9 +105,9 @@ The `chroot_mounts` configuration can be used to mount specific devices within t
- `/dev/pts` (devpts)
- `/proc/sys/fs/binfmt_misc` (binfmt_misc)

These default mounts are usually good enough for anyone and are sane defaults. However, if you want to change or add the mount points, you may using the chroot_mounts configuration. Here is an example configuration which only mounts /prod and /dev:
These default mounts are usually good enough for anyone and are sane defaults. However, if you want to change or add the mount points, you may using the chroot_mounts configuration. Here is an example configuration which only mounts `/prod` and `/dev`:

```
```json
{
"chroot_mounts": [
["proc", "proc", "/proc"],
Expand All @@ -126,4 +128,3 @@ These default mounts are usually good enough for anyone and are sane defaults. H
Mozilla Public License 2.0

Note that this plugin is implemented by forking [AMI Builder (chroot)](https://www.packer.io/docs/builders/amazon-chroot.html) of Packer.

18 changes: 12 additions & 6 deletions Taskfile.yml
Original file line number Diff line number Diff line change
@@ -1,13 +1,18 @@
version: '2'
---
version: "3"

vars:
NAME: packer-builder-qemu-chroot
VERSION: 1.1.0
COMMIT: {sh: git rev-parse --verify HEAD}
NAME: packer-plugin-qemu-chroot
VERSION: 1.1.0-u1
COMMIT: { sh: git rev-parse --verify HEAD }
BUILD_FLAGS: -ldflags "-X main.VERSION={{.VERSION}} -X main.COMMIT={{.COMMIT}}"

tasks:
generate:
cmds:
- go generate github.com/summerwind/packer-plugin-qemu-chroot/qemu/chroot
build:
deps: [generate]
cmds:
- go build {{.BUILD_FLAGS}} .
test:
Expand All @@ -28,10 +33,11 @@ tasks:
cmds:
- mkdir -p dist
- task: package
vars: {OS: "linux", ARCH: "amd64"}
vars: { OS: "linux", ARCH: "amd64" }
vendor:
cmds:
- dep ensure -v
- go mod init github.com/summerwind/packer-plugin-qemu-chroot || true
- go mod tidy
clean:
cmds:
- rm -rf {{.NAME}} dist cover.out
3 changes: 2 additions & 1 deletion examples/ubuntu.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"builders": [
{
"name": "build-test",
"type": "qemu-chroot",
"source_image": "ubuntu-16.04-server-cloudimg-amd64-disk1.img",
"image_name": "ubuntu-16.04.img",
Expand All @@ -14,5 +15,5 @@
"apt update"
]
}
]
]
}
Loading