This plugin lets you take an existing ARM image, and modify it on your x86 machine. It is optimized for raspberry pi use case - MBR partition table, with the file system partition being the last partition.
With this plugin, you can:
- Provision new ARM images from existing ones.
- Use ARM binaries for provisioning ('apt-get install' for example)
- Resize the last partition (the filesystem partition in the raspberry pi) in case you need more space than the default.
Tested for Raspbian images on built on Ubuntu 19.10. It is based partly on the chroot AWS provisioner, though the code was copied to prevent AWS dependencies.
The plugin runs the provisioners in a chroot environment. Binary execution is done using
qemu-arm-static
, via binfmt_misc
.
This builder uses the following shell commands:
- kpartx - mapping the partitons to mountable devices
- qemu-user-static - Executing arm binaries
To install the needed binaries on derivatives of the Debian Linux variant:
sudo apt install kpartx qemu-user-static
Fedora:
sudo dnf install kpartx qemu-user-static
Other commands that are used are (that should already be installed) : mount, umount, cp, ls, chroot.
To resize the filesystem, the following commands are used:
- e2fsck
- resize2fs
To provide custom arguments to qemu-arm-static
using the qemu_args
config, gcc
is required (to compile a C wrapper).
Note: resizing is only supported for the last active partition in an MBR partition table (as there is no need to move things).
This builder uses the following uses this kernel feature:
- support for
/proc/sys/fs/binfmt_misc
so that ARM binaries are automatically executed with qemu
This provisioner allows you to run packer provisioners on your ARM image locally. It does so by mounting the image on to the local file system, and then using chroot
combined with binfmt_misc
to the provisioners in a simulated ARM environment.
To use, you need to provide an existing image that we will then modify. We re-use packer's support for downloading ISOs (though the image should not be an ISO file). Supporting also zipped images (enabling you downloading official raspbian images directly).
See raspbian_golang.json and builder.go for details.
Note if your image is arm64, set qemu_binary
to qemu-aarch64-static
in your configuration json file.
As this tool performs low-level OS manipulations - consider using a VM to run this code for isolation. While this is highly recommended, it is not mandatory.
This project uses go modules for dependencies introduced in Go 1.11. To build:
git clone https://github.com/solo-io/packer-builder-arm-image
cd packer-builder-arm-image
go mod download
go build
This project includes a Vagrant file and helper script that build a VM run time environment. The run time environment has custom provisions to build an image in an iterative fashion (thanks to @tommie-lie for adding this feature).
To use the Vagrant environment, run the following commands:
git clone https://github.com/solo-io/packer-builder-arm-image
cd packer-builder-arm-image
vagrant up
To build an image edit samples/raspbian_golang.json (or set PACKERFILE
to point to your json config), and use vagrant provision
like so:
vagrant provision --provision-with build-image
The example config produces an image with go installed and extends the filesystem by 1GB.
That's it! Flash it and run!
- Build the
packer-builder-arm
Docker image
docker build -t packer-builder-arm .
- Build the
samples/raspbian_golang.json
Packer image
docker run \
--rm \
--privileged \
-v ${PWD}:/build \
-v ${PWD}/packer_cache:/build/packer_cache \
-v ${PWD}/output:/build/output \
packer-builder-arm build samples/raspbian_golang.json
- Flashing your image
Follow the examples in the Flashing section of this document.
packer build samples/raspbian_golang.json
We have a post-processor stage for flashing.
go build cmd/flasher/main.go
It will auto-detect most things and guides you with questions.
(Tested on MacOS)
# find the identifier of the device you want to flash
diskutil list
# un-mount the disk
diskutil unmountDisk /dev/disk2
# flash the image, go for a coffee
sudo dd bs=4m if=output-arm-image/image of=/dev/disk2
# eject the disk
diskutil eject /dev/disk2
(see full examples in contrib folder) Add these provisioners to:
{
"type": "shell",
"inline": ["touch /boot/ssh"]
}
set the user variables name wifi_name
and wifi_password
. then:
{
"type": "shell",
"inline": [
"echo 'network={' >> /etc/wpa_supplicant/wpa_supplicant.conf",
"echo ' ssid=\"{{user `wifi_name`}}\"' >> /etc/wpa_supplicant/wpa_supplicant.conf",
"echo ' psk=\"{{user `wifi_password`}}\"' >> /etc/wpa_supplicant/wpa_supplicant.conf",
"echo '}' >> /etc/wpa_supplicant/wpa_supplicant.conf"
]
}
This example locks down the image to only use your current ssh key. Disabling password login makes it extra secure for networked environments. Note: this example requires you to run the plugin without a VM, as it copies your local ssh key.
{
"variables": {
"ssh_key_src": "{{env `HOME`}}/.ssh/id_rsa.pub",
"image_home_dir": "/home/pi"
},
"builders": [
{
"type": "arm-image",
"iso_url": "https://downloads.raspberrypi.org/raspbian_lite/images/raspbian_lite-2017-12-01/2017-11-29-raspbian-stretch-lite.zip",
"iso_checksum_type": "sha256",
"iso_checksum": "e942b70072f2e83c446b9de6f202eb8f9692c06e7d92c343361340cc016e0c9f"
}
],
"provisioners": [
{
"type": "shell",
"inline": [
"mkdir {{user `image_home_dir`}}/.ssh"
]
},
{
"type": "file",
"source": "{{user `ssh_key_src`}}",
"destination": "{{user `image_home_dir`}}/.ssh/authorized_keys"
},
{
"type": "shell",
"inline": [
"touch /boot/ssh"
]
},
{
"type": "shell",
"inline": [
"sed '/PasswordAuthentication/d' -i /etc/ssh/ssh_config",
"echo >> /etc/ssh/ssh_config",
"echo 'PasswordAuthentication no' >> /etc/ssh/ssh_config"
]
}
]
}
See everything included in here: contrib/pi-secure-wifi-ssh.json. Build like so:
sudo packer build -var wifi_name=SSID -var wifi_password=PASSWORD contrib/pi-secure-wifi-ssh.json
# or if running from vagrant ssh:
sudo packer build -var wifi_name=SSID -var wifi_password=PASSWORD /vagrant/contrib/pi-secure-wifi-ssh.json