変数の異なるセットでテンプレートモジュールを使用する方法

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"で、2番目のテンプレートでb = "File2"であることを指定できます。

ansible  ansible-template 
— ケステモントマックス
ソース
それは私が私のすべてのレシピで行うこととまったく同じです、このコメントstackoverflow.com/a/40189525/1571310を見て、この助けを願っています！
— Tecnocat、2016年

回答:

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モジュールはテンプレートへの変数の受け渡しをサポートしていません。テンプレート内で使用できます。機能のリクエストがありましたが、拒否されました。

2つの回避策が考えられます。

1.含める

include声明のサポートは、変数を渡します。したがってtemplate、追加のファイル内にタスクを作成し、適切なパラメーターを使用して2回含めることができます。

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
はい、あなたはループでそれを行うこともできます-それでもそれは回避策です。:)
— うどんだん2015
14
もう必要ありません。「vars」がサポートされるようになりました。以下の@ konstantin-suvorovの回答を参照してください。
— sonjz 2017
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

これはmyTemplateVariabletest.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 2018年
23

これは私が使っている解決策/ハックです：

tasks / 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に、1アイテムリストの各アイテムを含むテンプレートをレンダリングするために悪用します。これは、を使用するときにリストを制御できるため機能します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 }}'
— 難しい
8

こうやってやった。

tasks / 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 '31年
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 2017
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}}"
— クラド
ソース
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.