{"id":15068,"date":"2025-08-04T04:01:41","date_gmt":"2025-08-04T04:01:41","guid":{"rendered":"https:\/\/www.devopsschool.com\/blog\/?p=15068"},"modified":"2025-08-04T04:01:41","modified_gmt":"2025-08-04T04:01:41","slug":"deep-dive-into-jinja2-ansible-template-with-example","status":"publish","type":"post","link":"https:\/\/www.devopsschool.com\/blog\/deep-dive-into-jinja2-ansible-template-with-example\/","title":{"rendered":"Ansible: Deep Dive into Jinja2 Ansible Template with example"},"content":{"rendered":"\n

<\/h2>\n\n\n\n

Introduction to Ansible Templates and Jinja2<\/strong><\/h2>\n\n\n\n

Ansible templates are powerful tools for creating dynamic configuration files and scripts based on variables and logic. Templates in Ansible use the Jinja2 templating engine, which enables you to programmatically control the contents of files generated during playbook runs. Jinja2 allows you to access variables, use conditional statements, loops, and filters, making your automation flexible and reusable.<\/p>\n\n\n\n

What is Jinja2?<\/strong><\/h2>\n\n\n\n
    \n
  • Jinja2<\/strong> is a modern, designer-friendly templating language for Python. In Ansible, it empowers the creation of files that can adapt based on the current data (like host variables or facts), supporting variables, logic, and complex data structures.<\/li>\n\n\n\n
  • Key Syntax<\/strong>:\n
      \n
    • {{ variable }}<\/code> for variable interpolation<\/li>\n\n\n\n
    • {% control structures %}<\/code> for logic (if, for, etc.)<\/li>\n\n\n\n
    • Filters (e.g., {{ my_var | upper }}<\/code>)<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n\n\n\n

      Concepts and Features of Jinja2 in Ansible<\/strong><\/h2>\n\n\n\n
        \n
      • Variables:<\/strong> Insert values dynamically: textHello, {{ username }}!<\/code><\/li>\n\n\n\n
      • Expressions and Filters:<\/strong> Use built-in or custom filters to modify data: text{{ mylist | join(', ') }}<\/code><\/li>\n\n\n\n
      • Conditionals:<\/strong> text{% if is_admin %} You are an admin. {% else %} You are a user. {% endif %}<\/code><\/li>\n\n\n\n
      • Loops:<\/strong> text{% for item in items %} - {{ item }} {% endfor %}<\/code><\/li>\n\n\n\n
      • Includes and Macros:<\/strong> Reuse chunks of templates.<\/li>\n<\/ul>\n\n\n\n

        Using Templates in Ansible<\/strong><\/h2>\n\n\n\n

        Templates in Ansible are typically stored as .j2<\/code> (Jinja2) files. The template<\/code> module copies these files to managed nodes, rendering them with variables and logic.<\/p>\n\n\n\n

        Basic Workflow<\/strong><\/h2>\n\n\n\n
          \n
        1. Create the Template File<\/strong>\n
            \n
          • Example: templates\/config.j2<\/code> textuser={{ app_user }} path={{ app_path }}<\/code><\/li>\n<\/ul>\n<\/li>\n\n\n\n
          • Reference in Playbook<\/strong>\n
              \n
            • Use the template<\/code> module: text- name: Copy app config template: src: config.j2 dest: \/etc\/myapp\/config.cfg<\/code><\/li>\n<\/ul>\n<\/li>\n\n\n\n
            • Define Variables<\/strong>\n
                \n
              • In inventory, playbook, or host\/group vars: textvars: app_user: alice app_path: \/opt\/myapp<\/code><\/li>\n<\/ul>\n<\/li>\n<\/ol>\n\n\n\n

                Practical Examples<\/strong><\/h2>\n\n\n\n

                1. Dynamic HTML Page<\/strong><\/h2>\n\n\n\n

                Template: templates\/landing-page.html.j2<\/code><\/strong><\/p>\n\n\n\n

                text<!doctype html>\n<html lang=\"en\">\n<head>\n  <meta charset=\"utf-8\">\n  <title>{{ page_title }}<\/title>\n  <meta name=\"description\" content=\"Created with Ansible\">\n<\/head>\n<body>\n  <h1>{{ page_title }}<\/h1>\n  <p>{{ page_description }}<\/p>\n<\/body>\n<\/html>\n<\/code><\/pre>\n\n\n\n
                Playbook:<\/strong><\/p>\n\n\n\n
                text- name: Configure landing page\n  hosts: web\n  vars:\n    page_title: \"Welcome\"\n    page_description: \"This is an Ansible-generated page\"\n  tasks:\n    - name: Deploy HTML page\n      template:\n        src: landing-page.html.j2\n        dest: \/var\/www\/html\/index.html\n<\/code><\/pre>\n\n\n\n
                Result: The index.html<\/code> on the target server will be customized per the defined vars.<\/p>\n\n\n\n
                2. Configuring Nginx Virtual Host with Logic and Loops<\/strong><\/h2>\n\n\n\n
                Template: templates\/nginx_vhost.conf.j2<\/code><\/strong><\/p>\n\n\n\n
                textserver {\n  listen {{ nginx_port }} default_server;\n  server_name {{ domain_name }};\n  root {{ document_root }};\n  index index.html index.htm;\n  access_log \/var\/log\/nginx\/{{ domain_name }}_access.log;\n  error_log \/var\/log\/nginx\/{{ domain_name }}_error.log;\n  location \/ {\n    try_files $uri $uri\/ =404;\n    {% if enable_php %}\n    location ~ \\.php$ {\n      include snippets\/fastcgi-php.conf;\n      fastcgi_pass unix:\/var\/run\/php\/php7.4-fpm.sock;\n    }\n    {% endif %}\n  }\n}\n<\/code><\/pre>\n\n\n\n
                Playbook:<\/strong><\/p>\n\n\n\n
                text- name: Configure nginx virtual host\n  hosts: web_servers\n  vars:\n    nginx_port: 80\n    domain_name: \"example.com\"\n    document_root: \"\/var\/www\/html\"\n    enable_php: true\n  tasks:\n    - name: Create Nginx configuration\n      template:\n        src: nginx_vhost.conf.j2\n        dest: \/etc\/nginx\/sites-available\/{{ domain_name }}.conf\n<\/code><\/pre>\n\n\n\n
                Result: Nginx configs will dynamically adapt to each server or environment.<\/p>\n\n\n\n
                Advanced Jinja2 Usage in Ansible<\/strong><\/h2>\n\n\n\n
                  \n
                • Facts<\/strong>: Use system facts collected by Ansible, e.g., {{ ansible_facts['os_family'] }}<\/code><\/li>\n\n\n\n
                • Dictionaries\/Loops<\/strong>: Render configuration options dynamically: text{% for opt in floaterm_options %} let g:{{ opt }} = {{ floaterm_options[opt] }} {% endfor %}<\/code><\/li>\n\n\n\n
                • Macros<\/strong>: Reuse complex snippets within templates.<\/li>\n\n\n\n
                • Includes\/Extends<\/strong>: Organize and reuse base templates for consistency.<\/li>\n<\/ul>\n\n\n\n
                  Best Practices<\/strong><\/h2>\n\n\n\n
                    \n
                  • Use clear variable names<\/strong> and document their purpose.<\/li>\n\n\n\n
                  • Version control your templates<\/strong> for traceability.<\/li>\n\n\n\n
                  • Leverage roles for reusability<\/strong>\u2014combine variables, templates, and logic.<\/li>\n\n\n\n
                  • Test templates locally<\/strong> using ansible-playbook<\/code> in check mode or via dry runs.<\/li>\n<\/ul>\n\n\n\n
                    Summary Table: Jinja2 Features in Ansible Templates<\/strong><\/h2>\n\n\n\n
                    Jinja2 Feature<\/th>Example Syntax<\/th>Use-Case<\/th><\/tr><\/thead>
                    Variables<\/td>{{ variable }}<\/code><\/td>Insert dynamic values<\/td><\/tr>
                    Conditionals<\/td>{% if cond %}...{% endif %}<\/code><\/td>Show\/hide content<\/td><\/tr>
                    Loops<\/td>{% for item in items %}...{% endfor %}<\/code><\/td>Repeat content for lists<\/td><\/tr>
                    Filters<\/td>`{{ var<\/td>upper }}`<\/td><\/tr>
                    Includes<\/td>{% include \"file.j2\" %}<\/code><\/td>Code reuse within templates<\/td><\/tr>
                    Macros<\/td>{% macro name(args) %}...{% endmacro %}<\/code><\/td>Reusable snippets<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
                    Conclusion<\/strong><\/h2>\n\n\n\n
                    Ansible templates powered by Jinja2 make configuration management dynamic, flexible, and adaptable<\/strong>. Mastering their syntax\u2014along with how to combine variables, logic, loops, and facts\u2014enables DevOps teams to automate at scale, reduce errors, and manage highly customizable infrastructure.<\/p>\n\n\n\n
                    If you’re new, start with simple templates and gradually incorporate more advanced Jinja2 logic for maximum automation efficiency!<\/p>\n\n\n\n
                    \n\n\n\n
                    <\/p>\n\n\n\n