如何使用具有不同变量集的模板模块?


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

在这里我可以为第一个模板指定要使用的变量为a =“ File1”,为第二个模板指定b =“ File2”。


正是我使用所有食谱做的,请查看此评论stackoverflow.com/a/40189525/1571310,希望能有所帮助!
Tecnocat

Answers:


50

对于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

另一种方法是在每个template任务之前简单地重新定义myTemplateVariable 。

- 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 2015年

是的,您也可以使用循环来完成它-仍然是一种解决方法。:)
udondan

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:是任务的,而不是模板的。因此,您可以在任何地方执行此操作,而不仅仅是模板。很好
格雷格

37

您可以非常轻松地完成此操作,请查看我的主管配方:

- 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

这是我正在使用的解决方案/黑客:

任务/ 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在模板中使用它作为变量名。

如果您想通过这种方式传递多个变量,可以将dict当作这样的列表项:

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

我是这样做的。

在task / 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 '18

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 %}

这是变种

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}}"
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.