packer-cn/website/pages/docs/builders/file.mdx

55 lines
1.3 KiB
Plaintext
Raw Normal View History

2016-08-30 13:51:49 -04:00
---
2017-06-14 21:04:16 -04:00
description: |
2020-03-18 18:46:47 -04:00
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.
2016-08-30 13:51:49 -04:00
layout: docs
2020-03-18 18:46:47 -04:00
page_title: File - Builders
2020-03-24 19:48:37 -04:00
sidebar_title: 'File'
2020-03-18 18:46:47 -04:00
sidebar_current: docs-builders-file
---
2016-08-30 13:51:49 -04:00
# 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.
2016-08-30 13:51:49 -04:00
## Basic Example
Below is a fully functioning example. It create a file at `target` with the
specified `content`.
2016-08-30 13:51:49 -04:00
```json
2016-08-30 13:51:49 -04:00
{
"type": "file",
"content": "Lorem ipsum dolor sit amet",
"target": "dummy_artifact"
2016-08-30 13:51:49 -04:00
}
```
## Configuration Reference
Configuration options are organized below into two categories: required and
optional. Within each category, the available options are alphabetized and
described.
2020-03-31 17:40:07 -04:00
Any [communicator](/docs/templates/communicator) defined is ignored.
2016-08-30 13:51:49 -04:00
### Required:
2020-03-18 18:46:47 -04:00
- `target` (string) - The path for a file which will be copied as the
artifact.
2016-08-30 13:51:49 -04:00
### Optional:
2018-10-26 20:02:51 -04:00
You can only define one of `source` or `content`. If none of them is defined
the artifact will be empty.
2016-08-30 13:51:49 -04:00
2020-03-18 18:46:47 -04:00
- `source` (string) - The path for a file which will be copied as the
artifact.
2016-08-30 13:51:49 -04:00
2020-03-18 18:46:47 -04:00
- `content` (string) - The content that will be put into the artifact.