content¶
May be used instead of source to provide file content without a template file. Must be a UTF-8 string. Defaults to "".
File items¶
Manages regular files.
files = {
"/path/to/file": {
"mode": "0644",
"owner": "root",
"group": "root",
"content_type": "mako",
"encoding": "utf-8",
"source": "my_template",
},
}
Attribute reference¶
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 |
| binary | file is uploaded verbatim, no content processing occurs |
| jinja2 | content is interpreted by the Jinja2 template engine |
| mako (default) | content is interpreted by the Mako template engine |
| text | like binary, but will be diffed in interactive mode |
Note
In order to use Jinja2, you’ll also need to install it manually, since BundleWrap doesn’t explicitly depend on it:
pip install Jinja2
context¶
Only used with Mako 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.
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.
See also