Chapter: Working with Jinja templates in Ansible¶

Introduction¶

Ansible provides a powerful and straightforward way to manage configurations using Jinja templates through the built-in template module. This chapter explores two essential ways to utilize Jinja templates in Ansible:

adding variables to a configuration file
building complex files with loops and intricate data structures.

Adding variables to a configuration file¶

Step 1: create a Jinja template¶

Create a Jinja template file, e.g., sshd_config.j2, with placeholders for variables:

# /path/to/sshd_config.j2

Port {{ ssh_port }}
PermitRootLogin {{ permit_root_login }}
# Add more variables as needed

Step 2: use the Ansible template module¶

In your Ansible playbook, use the template module to render the Jinja template with specific values:

---
- name: Generate sshd_config
  hosts: your_target_hosts
  tasks:
    - name: Template sshd_config
      template:
        src: /path/to/sshd_config.j2
        dest: /etc/ssh/sshd_config
      vars:
        ssh_port: 22
        permit_root_login: no
      # Add more variables as needed

Step 3: apply configuration changes¶

Execute the Ansible playbook to apply the changes to the target hosts:

ansible-playbook your_playbook.yml

This step ensures that the configuration changes are applied consistently across your infrastructure.

Building a complete file with loops and complex data structures¶

Step 1: enhance the Jinja template¶

Extend your Jinja template to handle loops and complex data structures. Here's an example for configuring a hypothetical application with multiple components:

# /path/to/app_config.j2

{% for component in components %}
[{{ component.name }}]
    Path = {{ component.path }}
    Port = {{ component.port }}
    # Add more configurations as needed
{% endfor %}

Step 2: integrate Ansible template module¶

In your Ansible playbook, integrate the template module to generate a complete configuration file:

---
- name: Generate Application Configuration
  hosts: your_target_hosts
  vars:
    components:
      - name: web_server
        path: /var/www/html
        port: 80
      - name: database
        path: /var/lib/db
        port: 3306
      # Add more components as needed
  tasks:
    - name: Template Application Configuration
      template:
        src: /path/to/app_config.j2
        dest: /etc/app/config.ini

Execute the Ansible playbook to apply the changes to the target hosts:

ansible-playbook your_playbook.yml

This step ensures that the configuration changes are applied consistently across your infrastructure.

The Ansible template module provides a way to use Jinja templates for dynamically generating configuration files during playbook execution. This module allows you to separate configuration logic and data, making your Ansible playbooks more flexible and maintainable.

Key features¶

Template Rendering:
The module renders Jinja templates to create configuration files with dynamic content.
Variables defined in the playbook or inventory can be injected into templates, enabling dynamic configurations.
Usage of Jinja2:
The template module leverages the Jinja2 templating engine, providing powerful features like conditionals, loops, and filters for advanced template manipulation.
Source and Destination Paths:
Specifies the source Jinja template file and the destination path for the generated configuration file.
Variable Passing:
Variables can be passed directly in the playbook task or loaded from external files, allowing for flexible and dynamic configuration generation.
Idempotent Execution:
The template module supports idempotent execution, ensuring that the template is only applied if changes are detected.

Example playbook snippet¶

---
- name: Generate Configuration File
  hosts: your_target_hosts
  tasks:
    - name: Template Configuration File
      template:
        src: /path/to/template.j2
        dest: /etc/config/config_file
      vars:
        variable1: value1
        variable2: value2

Use cases¶

Configuration Management:
Ideal for managing system configurations by dynamically generating files based on specific parameters.
Application Setup:
Useful for creating application-specific configuration files with varying settings.
Infrastructure as Code:
Facilitates Infrastructure as Code practices by allowing dynamic adjustments to configurations based on variables.

Best practices¶

Separation of Concerns:
Keep the actual configuration logic in Jinja templates, separating it from the playbook's main structure.
Version Control:
Store Jinja templates in version-controlled repositories for better tracking and collaboration.
Testability:
Test templates independently to ensure they produce the expected configuration output.

By leveraging the template module, Ansible users can enhance the manageability and flexibility of configuration tasks, promoting a more streamlined and efficient approach to system and application setup.

References¶

Ansible Template Module Documentation.

Author: Srinivas Nishant Viswanadha

Contributors: Steven Spencer, Antoine Le Morvan, Ganna Zhyrnova