From 3a13e47f34eaed460ade62afbb8262b02d3e241c Mon Sep 17 00:00:00 2001 From: Mitchell Hashimoto Date: Sat, 9 Nov 2013 13:28:00 -0800 Subject: [PATCH] website: start documenting the builder --- .../source/docs/builders/docker.html.markdown | 41 +++++++++++++++++++ website/source/layouts/docs.erb | 1 + 2 files changed, 42 insertions(+) create mode 100644 website/source/docs/builders/docker.html.markdown diff --git a/website/source/docs/builders/docker.html.markdown b/website/source/docs/builders/docker.html.markdown new file mode 100644 index 000000000..a38691f76 --- /dev/null +++ b/website/source/docs/builders/docker.html.markdown @@ -0,0 +1,41 @@ +--- +layout: "docs" +--- + +# Docker Builder + +Type: `docker` + +The Docker builder builds [Docker](http://www.docker.io) images using +Docker. The builder starts a Docker container, runs provisioners within +this container, then exports the container for re-use. + +The Docker builder must run on a machine that supports Docker. + +## Basic Example + +Below is a fully functioning example. It doesn't do anything useful, since +no provisioners are defined, but it will effectively repackage an image. + +
+{
+  "type": "docker",
+  "image": "ubuntu",
+  "export_path": "image.tar"
+}
+
+ +## Configuration Reference + +All configuration options are currently required. + +* `export_path` (string) - The path where the final container will be exported + as a tar file. + +* `image` (string) - The base image for the Docker container that will + be started. This image will be pulled from the Docker registry if it + doesn't already exist. + +## Dockerfiles + +TODO diff --git a/website/source/layouts/docs.erb b/website/source/layouts/docs.erb index f400ec930..d340b6edc 100644 --- a/website/source/layouts/docs.erb +++ b/website/source/layouts/docs.erb @@ -32,6 +32,7 @@
  • Builders

  • Amazon EC2 (AMI)
  • DigitalOcean
  • +
  • Docker
  • OpenStack
  • QEMU
  • VirtualBox