File items
Manage regular files.
files = {
"/path/to/file": {
"mode": "0644",
"owner": "root",
"group": "root",
"content_type": "mako",
"encoding": "utf-8",
"source": "my_template",
},
}
Attribute reference
See also: The list of generic builtin item attributes
content
May be used instead of source
to provide file content without a template file.
content_type
How the file pointed to by source
or the string given to content
should be interpreted.
Value | Effect |
---|---|
any | only cares about file owner, group, and mode |
base64 | content is decoded from base64 |
binary | file is uploaded verbatim, no content processing occurs |
jinja2 | content is interpreted by the Jinja2 template engine |
mako | content is interpreted by the Mako template engine |
text (default) | like binary , but will be diffed in interactive mode |
context
Only used with Mako and Jinja2 templates. The values of this dictionary will be available from within the template as variables named after the respective keys.
delete
When set to True
, the path of this file will be removed. It doesn't matter if there is not a file but a directory or something else at this path. When using delete
, no other attributes are allowed.
encoding
Encoding of the target file. Note that this applies to the remote file only, your template is still conveniently written in UTF-8 and will be converted by BundleWrap. Defaults to "utf-8". Other possible values (e.g. "latin-1") can be found here.
group
Name of the group this file belongs to. Defaults to None
(don't care about group).
mode
File mode as returned by stat -c %a <file>
. Defaults to None
(don't care about mode).
owner
Username of the file's owner. Defaults to None
(don't care about owner).
source
File name of the file template. If this says my_template
, BundleWrap will look in data/my_bundle/files/my_template
and then bundles/my_bundle/files/my_template
. Most of the time, you will want to put config templates into the latter directory. The data/
subdirectory is meant for files that are very specific to your infrastructure (e.g. DNS zone files). This separation allows you to write your bundles in a generic way so that they could be open-sourced and shared with other people. Defaults to the filename of this item (e.g. foo.conf
when this item is /etc/foo.conf
).
See also: Writing file templates
verify_with
This can be used to run external validation commands on a file before it is applied to a node. The file is verified locally on the machine running BundleWrap. Verification is considered successful when the exit code of the verification command is 0. Use {}
as a placeholder for the shell-quoted path to the temporary file. Here is an example for verifying sudoers files:
visudo -cf {}
Keep in mind that all team members will have to have the verification command installed on their machines.