Jak korzystać z modułu szablonu z innym zestawem zmiennych?

92

Mój przypadek użycia jest następujący:

Mam plik szablonu i chciałbym utworzyć 2 różne pliki z tego szablonu, w których zmienne są wypełniane przez inny zestaw zmiennych dla każdego pliku.

Na przykład, powiedzmy, że chcę utworzyć szablon pliku zawierającego wiersz:

mkdir -p {{myTemplateVariable}}

Chciałbym znaleźć właściwy sposób na wypełnienie tej zmiennej przez „Plik1” i „Plik2”. Coś jak :

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


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

gdzie mógłbym określić dla pierwszego szablonu, że zmienną do użycia jest a = "Plik1", a dla drugiego b = "Plik2".

Kestemont Max
źródło
Czy właśnie to robię ze wszystkimi moimi przepisami, spójrz na ten komentarz stackoverflow.com/a/40189525/1571310 , mam nadzieję, że to pomoże!
Tecnocat

Odpowiedzi:

51

W przypadku 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

Dla Ansible 1.x:

Niestety templatemoduł nie obsługuje przekazywania do niego zmiennych, których można użyć wewnątrz szablonu. Pojawiła się prośba o funkcję, ale została odrzucona.

Przychodzą mi do głowy dwa obejścia:

1. Uwzględnij

Te includepodpory rachunku przechodzącą zmienne. Możesz więc templateumieścić swoje zadanie w dodatkowym pliku i dołączyć je dwukrotnie z odpowiednimi parametrami:

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. Ponownie zdefiniuj zmienną myTemplateVariable

Innym sposobem byłoby po prostu ponowne zdefiniowanie zmiennej myTemplateVariable tuż przed każdym templatezadaniem.

- 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
udondan
źródło
Dziękuję za Twoją odpowiedź. Jednak czy naprawdę nie da się obejść bez obejść? Obecnie próbuję czegoś takiego jak: stackoverflow.com/questions/26020465/… , ale nadal mam pewne błędy (może nie są bezpośrednio związane).
Kestemont Max
Tak, możesz to również zrobić za pomocą pętli - nadal jest to obejście. :)
udondan
14
nie jest już wymagane. Obsługiwane jest teraz „vars”. zobacz odpowiedź @ konstantin-suvorov poniżej.
sonjz
123

Ansible 2.x umożliwia vars:wykonywanie zadań.

Szablon test.j2:

mkdir -p {{myTemplateVariable}}

Poradnik:

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

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

Spowoduje to przekazanie różnych myTemplateVariablewartości do pliku test.j2.

Konstantin Suvorov
źródło
9
początkowo popełniłem błąd i miałem vars: z wcięciem, jak pozostałe argumenty szablonu (jak src :). Myślę, że poziom wcięcia oznacza vars: należy do zadania, a nie do szablonu. Możesz to zrobić wszędzie, nie tylko w szablonach. ładny.
Greg
39

Możesz to zrobić bardzo łatwo, spójrz na mój przepis na przełożonego:

- 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

Wynik:

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'})

Cieszyć się!

Tecnocat
źródło
Powinno to być oznaczone jako poprawna odpowiedź. Ponieważ jest teraz obsługiwany
PoX
23

To jest rozwiązanie / hack, którego używam:

zadania / 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'

szablony / test.j2:

{{ item }}

Po uruchomieniu tego otrzymasz this is var_aw / tmp / templateA i this is var_bw / tmp / templateB.

Zasadniczo nadużywasz with_itemsrenderowania szablonu z każdym elementem na liście zawierającej jedną pozycję. To działa, ponieważ możesz kontrolować, jaka jest lista podczas używania with_items.

Wadą tego jest to, że musisz użyć itemnazwy zmiennej w swoim szablonie.

Jeśli chcesz przekazać w ten sposób więcej niż jedną zmienną, możesz dyktować jako elementy listy w następujący sposób:

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'

a następnie odnieś się do nich w swoim szablonie w ten sposób:

{{ item.var_1 }}
{{ item.var_2 }}
asmigala
źródło
1
Czyste rozwiązanie, ale kapelusz do użyciawith_items: '{{ var_a }}'
Peter Ajtai
8

Zrobiłem to w ten sposób.

W zadaniach / main.yml

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

oraz w vars / main.yml

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

oraz w plikach templates / myTemplateFile.j2

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

Mam nadzieję, że to rozwiązuje twój problem.

Nabarun Chatterjee
źródło
with_dictto lepsze rozwiązanie.
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

WAŻNE: Zwróć uwagę, że element nie musi być tylko ciągiem znaków, może to być obiekt z dowolną liczbą właściwości, dzięki czemu możesz przekazać dowolną liczbę zmiennych.

W szablonie mam:

<VirtualHost *:80>
    ServerAdmin [email protected]
    ServerName {{ item }}
    DocumentRoot /vagrant/public


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

</VirtualHost>
Bart McLeod
źródło
1
Jak mogę zrobić z tego przedmiot?
camdixon,
1

Miałem podobny problem do rozwiązania, oto proste rozwiązanie jak przekazywać zmienne do plików szablonów, sztuka polega na zapisaniu pliku szablonu z wykorzystaniem zmiennej. Musisz stworzyć słownik (możliwa jest również lista), który zawiera zestaw zmiennych odpowiadających każdemu z plików. Następnie w pliku szablonu uzyskaj do nich dostęp.

patrz poniżej:

the template file: test_file.j2
# {{ ansible_managed }} created by [email protected]

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

poradnik

---
#
# file: template_test.yml
# author: [email protected]
#
# 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
źródło
0

Kolejny przykład ze świata rzeczywistego z użyciem listy

wyciąg z szablonu dla 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 %}

To jest 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" }

Następnie wdrażam z tym

- 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}}"
krad
źródło