Как использовать модуль шаблона с другим набором переменных?

93

Мой вариант использования следующий:

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

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

mkdir -p {{myTemplateVariable}}

Я хотел бы найти правильный способ заполнить эту переменную «File1» и «File2». Что-то типа :

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


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

где я мог бы указать для первого шаблона, что использовать переменную a = "File1", а для второго b = "File2".

Кестемонт Макс
источник
Это именно то, что я делаю со всеми своими рецептами, посмотрите этот комментарий stackoverflow.com/a/40189525/1571310 , надеюсь, это поможет!
Tecnocat,

Ответы:

52

Для 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 01
Да, вы также можете сделать это с помощью цикла - все же это обходной путь. :)
udondan 01
14
больше не требуется. "vars" теперь поддерживается. см. ответ @ konstantin-suvorov ниже.
sonjz
123

С Ansible 2.x вы можете использовать vars:с задачами.

Шаблон test.j2:

mkdir -p {{myTemplateVariable}}

Пособие:

- 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: is of the task, not the template. Таким образом, вы можете делать это где угодно, а не только в шаблонах. отлично.
Грег
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'})

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

Tecnocat
источник
Это должно быть отмечено как правильный ответ. С тех пор, как он поддерживается сейчас
PoX
23

Я использую это решение / хак:

задачи / 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'

шаблоны / test.j2:

{{ item }}

После запуска вы попадете this is var_aв / tmp / templateA и this is var_bв / tmp / templateB.

Обычно вы злоупотребляете with_itemsвизуализацией шаблона с каждым элементом в списке из одного элемента. Это работает, потому что вы можете контролировать, что это за список при использовании with_items.

Обратной стороной этого является то, что вы должны использовать itemимя переменной в своем шаблоне.

Если вы хотите передать более одной переменной таким образом, вы можете dicts в качестве элементов списка следующим образом:

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 }}'
Питер Аджтай
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 }}"
xbalaji
источник
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 %}

Это вар

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}}"
крад
источник