From 05c7d08bb219e3a583a0dd479c708fba95e2a139 Mon Sep 17 00:00:00 2001 From: Eric Lathrop Date: Thu, 4 Jul 2013 15:07:53 -0400 Subject: [PATCH] Add file provisioner documentation. --- .../docs/provisioners/file.html.markdown | 31 +++++++++++++++++++ .../docs/provisioners/shell.html.markdown | 2 +- website/source/layouts/docs.erb | 1 + 3 files changed, 33 insertions(+), 1 deletion(-) create mode 100644 website/source/docs/provisioners/file.html.markdown diff --git a/website/source/docs/provisioners/file.html.markdown b/website/source/docs/provisioners/file.html.markdown new file mode 100644 index 000000000..30d082f0c --- /dev/null +++ b/website/source/docs/provisioners/file.html.markdown @@ -0,0 +1,31 @@ +--- +layout: "docs" +--- + +# File Provisioner + +Type: `file` + +The file provisioner uploads files to machines build by Packer. + +## Basic Example + +
+{
+  "type": "file",
+  "source": "app.tar.gz",
+  "destination": "/tmp/app.tar.gz"
+}
+
+ +## Configuration Reference + +The available configuration options are listed below. All elements are required. + +* `source` (string) - The path to a local file to upload to the machine. The + path can be absolute or relative. If it is relative, it is relative to the + working directory when ?Packer is executed. + +* `destination` (string) - The path where the file will be uploaded to in the + machine. This value must be a writable location and any parent directories + must already exist. diff --git a/website/source/docs/provisioners/shell.html.markdown b/website/source/docs/provisioners/shell.html.markdown index 9dc0d64c0..51ddce502 100644 --- a/website/source/docs/provisioners/shell.html.markdown +++ b/website/source/docs/provisioners/shell.html.markdown @@ -23,7 +23,7 @@ The example below is fully functional. ## Configuration Reference -The reference of available configuratin options is listed below. The only +The reference of available configuration options is listed below. The only required element is either "inline" or "script". Every other option is optional. Exactly _one_ of the following is required: diff --git a/website/source/layouts/docs.erb b/website/source/layouts/docs.erb index 2582862e9..a6ed7f2cd 100644 --- a/website/source/layouts/docs.erb +++ b/website/source/layouts/docs.erb @@ -36,6 +36,7 @@