Як використовувати модуль шаблону з різним набором змінних?


92

Мої випадки використання такі:

У мене є файл шаблону, і я хотів би створити 2 різних файли з цього шаблону, причому змінні заповнюються різним набором змінних для кожного файлу.

Наприклад, скажімо, я хочу створити шаблон файлу, що містить рядок:

mkdir -p {{myTemplateVariable}}

Я хотів би знайти правильний спосіб заповнити цю змінну "File1" та "File2". Щось на зразок :

- name: template test 1
  template: 
        src=myTemplateFile
        dest=result1


- name: template test 2
  template: 
        src=myTemplateFile
        dest=result2

де я міг би вказати для першого шаблону, що змінною, яку використовуватиметься, є = "Файл1", а для другого, b = "Файл2".


Це саме те, що я роблю з усіма своїми рецептами, дивіться цей коментар stackoverflow.com/a/40189525/1571310 , сподіваюся, що це допоможе!
Tecnocat

Відповіді:


51

Для Ansible 2.x:

- name: template test
  template: 
    src: myTemplateFile
    dest: result1
  vars:
    myTemplateVariable: File1

- name: template test
  template: 
    src: myTemplateFile
    dest: result2
  vars:
    myTemplateVariable: File2

Для Ansible 1.x:

На жаль, templateмодуль не підтримує передачу йому змінних, які можна використовувати всередині шаблону. Був запит на функцію, але він був відхилений.

Я можу придумати два способи вирішення:

1. Включити

Оператор includeпідтримує передачу змінних. Таким чином, ви можете мати своє templateзавдання всередині додаткового файлу і включити його двічі з відповідними параметрами:

my_include.yml:

- name: template test
  template: 
        src=myTemplateFile
        dest=destination

main.yml:

- include: my_include.yml destination=result1 myTemplateVariable=File1

- include: my_include.yml destination=result2 myTemplateVariable=File2

2. Повторно визначте myTemplateVariable

Іншим способом було б просто перевизначити myTemplateVariable безпосередньо перед кожним templateзавданням.

- set_fact:
     myTemplateVariable: File1

- name: template test 1
  template: 
        src=myTemplateFile
        dest=result1

- set_fact:
     myTemplateVariable: File2

- name: template test 2
  template: 
        src=myTemplateFile
        dest=result2

Дякую за відповідь. Однак чи справді неможливо обійтися без обхідних шляхів? На даний момент я пробую щось на зразок: stackoverflow.com/questions/26020465/… , але все ще маю деякі помилки (можливо, не пов’язані безпосередньо).
Kestemont Max

Так, це можна зробити і за допомогою циклу - все одно це обхідний шлях. :)
udondan

14
більше не потрібно. "vars" тепер підтримується. див. відповідь @ konstantin-suvorov нижче.
sonjz

123

За допомогою Ansible 2.x ви можете використовувати vars: із завданнями.

Шаблон test.j2:

mkdir -p {{myTemplateVariable}}

Playbook:

- template: src=test.j2 dest=/tmp/File1
  vars:
    myTemplateVariable: myDirName

- template: src=test.j2 dest=/tmp/File2
  vars:
    myTemplateVariable: myOtherDir

Це передасть різні myTemplateVariableзначення у test.j2.


9
спочатку я помилився і мав vars: з відступом, як і інші аргументи шаблону (наприклад, src :). Я думаю, рівень відступу означає vars: це завдання, а не шаблон. Таким чином, ви можете робити це де завгодно, не лише шаблони. приємно.
Грег

39

Ви можете зробити це дуже просто, подивіться мій рецепт супервізора:

- name: Setup Supervisor jobs files
  template:
    src: job.conf.j2
    dest: "/etc/supervisor/conf.d/{{ item.job }}.conf"
    owner: root
    group: root
    force: yes
    mode: 0644
  with_items:
    - { job: bender, arguments: "-m 64", instances: 3 }
    - { job: mailer, arguments: "-m 1024", instances: 2 }
  notify: Ensure Supervisor is restarted

job.conf.j2:

[program:{{ item.job }}]
user=vagrant
command=/usr/share/nginx/vhosts/parclick.com/app/console rabbitmq:consumer {{ item.arguments }} {{ item.job }} -e prod
process_name=%(program_name)s_%(process_num)02d
numprocs={{ item.instances }}
autostart=true
autorestart=true
stderr_logfile=/var/log/supervisor/{{ item.job }}.stderr.log
stdout_logfile=/var/log/supervisor/{{ item.job }}.stdout.log

Вихід:

TASK [Supervisor : Setup Supervisor jobs files] ********************************
changed: [loc.parclick.com] => (item={u'instances': 3, u'job': u'bender', u'arguments': u'-m 64'})
changed: [loc.parclick.com] => (item={u'instances': 2, u'job': u'mailer', u'arguments': u'-m 1024'})

Насолоджуйтесь!


Це слід позначити як правильну відповідь. З моменту його підтримки зараз
PoX

23

Це рішення / хак я використовую:

task / main.yml:

- name: parametrized template - a
  template:
    src: test.j2
    dest: /tmp/templateA
  with_items: var_a

- name: parametrized template - b
  template:
    src: test.j2
    dest: /tmp/templateB
  with_items: var_b

vars / main.yml

var_a:
  - 'this is var_a'
var_b:
  - 'this is var_b'

templates / test.j2:

{{ item }}

Після запуску цього ви потрапляєте this is var_aв / tmp / templateA та this is var_b/ tmp / templateB.

В основному ви зловживаєте, with_itemsщоб відображати шаблон з кожним елементом у списку з одним елементом. Це працює, оскільки ви можете контролювати, яким буде список при використанні with_items.

Недоліком цього є те, що ви повинні використовувати itemяк ім'я змінної у вашому шаблоні.

Якщо ви хочете таким чином передати більше однієї змінної, ви можете диктувати елементи списку таким чином:

var_a:
  -
    var_1: 'this is var_a1'
    var_2: 'this is var_a2'
var_b:
  -
    var_1: 'this is var_b1'
    var_2: 'this is var_b2'

а потім зверніться до них у своєму шаблоні так:

{{ item.var_1 }}
{{ item.var_2 }}

1
Чисте рішення, але капелюх використовуватиwith_items: '{{ var_a }}'
Peter Ajtai

8

Я зробив це таким чином.

У завданнях / main.yml

- name: template test
  template: 
        src=myTemplateFile.j2
        dest={{item}}
   with_dict: some_dict

та у vars / main.yml

some_dict:
  /path/to/dest1:
    var1: 1
    var2: 2
  /path/to/dest2:
    var1: 3
    var2: 4

та в templates / myTemplateFile.j2

some_var = {{ item.value.var1 }}
some_other_var = {{ item.value.var2 }}

Сподіваюся, це вирішить вашу проблему.


with_dictє кращим рішенням.
zx1986

1
- name: copy vhosts
  template: src=site-vhost.conf dest=/etc/apache2/sites-enabled/{{ item }}.conf
  with_items:
    - somehost.local
    - otherhost.local
  notify: restart apache

ВАЖЛИВО: Зверніть увагу, що елемент не повинен бути просто рядком, це може бути об'єкт зі скільки завгодно властивостей, так що ви можете передавати будь-яку кількість змінних.

У шаблоні я маю:

<VirtualHost *:80>
    ServerAdmin me@example.org
    ServerName {{ item }}
    DocumentRoot /vagrant/public


    ErrorLog ${APACHE_LOG_DIR}/error-{{ item }}.log
    CustomLog ${APACHE_LOG_DIR}/access.log combined

</VirtualHost>

1
Як я можу зробити це предметом?
camdixon

1

Мені довелося вирішити подібну проблему, ось просте рішення про те, як передати змінні файлам шаблонів, фокус полягає в тому, щоб написати файл шаблону, використовуючи перевагу змінної. Вам потрібно створити словник (список також можливий), який містить набір змінних, що відповідають кожному файлу. Потім у файлі шаблону отримати до них доступ.

Дивіться нижче:

the template file: test_file.j2
# {{ ansible_managed }} created by xbalaji@gmail.com

{% set dkey  = (item | splitext)[0]  %}
{% set fname = test_vars[dkey].name  %}
{% set fip   = test_vars[dkey].ip    %}
{% set fport = test_vars[dkey].port  %}
filename: {{ fname }}
ip address: {{ fip }}
port: {{ fport }}

ігрової книги

---
#
# file: template_test.yml
# author: xbalaji@gmail.com
#
# description: playbook to demonstrate passing variables to template files
#
# this playbook will create 3 files from a single template, with different
# variables passed for each of the invocation
#
# usage:
# ansible-playbook -i "localhost," template_test.yml

- name: template variables testing
  hosts: all
  gather_facts: false

  vars:
    ansible_connection: local
    dest_dir: "/tmp/ansible_template_test/"
    test_files:
      - file_01.txt
      - file_02.txt
      - file_03.txt
    test_vars:
      file_01:
        name: file_01.txt
        ip: 10.0.0.1
        port: 8001
      file_02:
        name: file_02.txt
        ip: 10.0.0.2
        port: 8002
      file_03:
        name: file_03.txt
        ip: 10.0.0.3
        port: 8003

  tasks:
    - name: copy the files
      template:
        src: test_file.j2
        dest: "{{ dest_dir }}/{{ item }}"
      with_items:
        - "{{ test_files }}"

0

Ще один реальний приклад використання списку

витяг для шаблону для php.ini

{% if 'cli/php.ini' in item.d %}
max_execution_time = 0
memory_limit = 1024M
{% else %}
max_execution_time = 300
memory_limit = 512M
{% endif %}

Це var

php_templates:
  - { s: 'php.ini.j2', d: "/etc/php/{{php_version}}/apache2/php.ini" }
  - { s: 'php.ini.j2', d: "/etc/php/{{php_version}}/cli/php.ini" }

Тоді я розгортаю це

- name: push templated files
  template:
    src: "{{item.s}}"
    dest: "{{item.d}}"
    mode: "{{item.m | default(0644) }}"
    owner: "{{item.o | default('root') }}"
    group: "{{item.g | default('root') }}"
    backup: yes
  with_items: "{{php_templates}}"
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.