From d8e67a0b6f41524997439163d2e6389faf01bbee Mon Sep 17 00:00:00 2001 From: Rickard von Essen Date: Tue, 30 Aug 2016 19:51:49 +0200 Subject: [PATCH] Added file builder documentation. --- website/source/docs/builders/file.html.md | 52 +++++++++++++++++++++++ website/source/layouts/docs.erb | 1 + 2 files changed, 53 insertions(+) create mode 100644 website/source/docs/builders/file.html.md diff --git a/website/source/docs/builders/file.html.md b/website/source/docs/builders/file.html.md new file mode 100644 index 000000000..dc73c4016 --- /dev/null +++ b/website/source/docs/builders/file.html.md @@ -0,0 +1,52 @@ +--- +description: | + The `file` Packer builder is not really a builder, it just creates an + artifact from a file. It can be used to debug post-processors without + incurring high wait times. It does not run any provisioners. +layout: docs +page_title: File Builder +... + +# File Builder + +Type: `file` + +The `file` Packer builder is not really a builder, it just creates an artifact +from a file. It can be used to debug post-processors without incurring high +wait times. It does not run any provisioners. + +## Basic Example + +Below is a fully functioning example. It doesn't do anything useful, since no +provisioners are defined, but it will connect to the specified host via ssh. + +``` {.javascript} +{ + "type": "file", + "content": "Lorem ipsum dolor sit amet", + "target": "dummy_artifact" +} +``` + +## Configuration Reference + +Configuration options are organized below into two categories: required and +optional. Within each category, the available options are alphabetized and +described. + +Any [communicator](/docs/templates/communicator.html) defined is ignored. + +### Required: + +- `target` (string) - The path for a file which will be copied as the + artifact. + +### Optional: + +You can only define one of `source` or `content`. If none of them is +defined the artifact will be empty. + +- `source` (string) - The path for a file which will be copied as the + artifact. + +- `content` (string) - The content that will be put into the artifact. diff --git a/website/source/layouts/docs.erb b/website/source/layouts/docs.erb index 4a43da5e7..5ed31a1f4 100644 --- a/website/source/layouts/docs.erb +++ b/website/source/layouts/docs.erb @@ -39,6 +39,7 @@
  • Azure Resource Manager
  • DigitalOcean
  • Docker
  • +
  • File
  • Google Compute Engine
  • Null
  • OpenStack