Template

The builtin.template resource allows you to create file on node with dynamic content defined by variables that you set, or using facts.

INFO

Templates can only really be used within a role only, as this is the only place where we can define raw templates. This behavior might change in the future.

Writing a template

Templates in Peekl are made possible using the official Golang templates engines. It's a little bit more tricky that other templates file format such as Jinja2 or ERB. Here are a few example so that you get an overview on what you can do with it. For more advanced use, you should refer yourself to the official documentation. Digital Ocean' blog also have a nice article that covers most things that you need to know.

Here's an example on how you can create a simple configuration file with simple values.

listen_ip: {{ .listen_ip }}
listen_port: {{ .listen_port }}
daemon: {{ .daemon }}

Builtin variables

On top of variables that you can define in your roles, your inventory, and on direct task invocation, you will also be able to use builtin variables, such as facts and tags.

Resource parameters

Name	Description	Required	Default
name	The name of the template to use. It correspond to the name of the final in the templates folder, minus the .tmpl file extension.	true
path	Path at which to create the file based on the template	true
owner	Set owner of the file	false	root
group	Set group of the file	false	root
mode	Set permissions of the file	false	0755
variables	A list of variables that you want to pass to the template on top of other pre-existing variables.	false

Examples

Create file /etc/my_app/config based on the template called config

- title: "Create configuration for my_app"
  type: "builtin.template"
  present: true
  data:
    name: "config"
    path: "/etc/my_app/config"
    variables:
      hello: "world"