From 05f072929f37ff63b947d3603113d61480ca39ed Mon Sep 17 00:00:00 2001 From: Chris Lundquist Date: Fri, 1 Jul 2016 06:45:48 +0000 Subject: [PATCH] [lxd] first pass at docs --- website/source/docs/builders/lxd.html.md | 50 ++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 website/source/docs/builders/lxd.html.md diff --git a/website/source/docs/builders/lxd.html.md b/website/source/docs/builders/lxd.html.md new file mode 100644 index 000000000..716c8bf20 --- /dev/null +++ b/website/source/docs/builders/lxd.html.md @@ -0,0 +1,50 @@ +--- +description: | + The `lxd` Packer builder builds containers for LXD. The builder starts an LXD + container, runs provisioners within this container, then saves the container + as an LXD image. +layout: docs +page_title: LXD Builder +... + +# LXD Builder + +Type: `lxd` + +The `lxd` Packer builder builds containers for LXD. The builder starts an LXD +container, runs provisioners within this container, then saves the container +as an LXD image. + +The LXD builder requires a modern linux kernel and the `lxd` package. +This builder does not work with LXC. + +## Basic Example + +Below is a fully functioning example. + +``` {.javascript} +{ + "builders": [ + { + "type": "lxd", + "name": "lxd-xenial", + "image": "ubuntu-daily:xenial", + "output_image": "ubuntu-xenial" + } + ] +} +``` + +## Configuration Reference + +### Required: + +- `image` (string) - The source image to use when creating the build container. This can be a (local or remote) image (name or fingerprint). E.G. my-base-image, ubuntu-daily:x, 08fababf6f27... + Note: The builder may appear to pause if required to download a remote image, as they are usually 100-200MB. `/var/log/lxd/lxd.log` will mention starting such downloads. + +### Optional: + +- `name` (string) - The name of the started container. Defaults to `packer-$PACKER_BUILD_NAME`. + +- `output_image` (string) - The name of the output artifact. Defaults to `name` +