Метки

Добавление меток к отдельным задачам

В простейшем случае можно назначить одну или несколько меток отдельной задаче. Метки можно добавлять к задачам в плейбуках, файлах задач или роли. В следующем примере к двум задачам добавлены разные метки:

tasks:
- name: Install the servers
  ansible.builtin.yum:
    name:
    - httpd
    - memcached
    state: present
  tags:
  - packages
  - webservers

- name: Configure the service
  ansible.builtin.template:
    src: templates/src.j2
    dest: /etc/foo.conf
  tags:
  - configuration

Одну и ту же метку можно назначить нескольким отдельным задачам. В этом примере несколько задач помечены одной и той же меткой «ntp»:

---
# file: roles/common/tasks/main.yml

- name: Install ntp
  ansible.builtin.yum:
    name: ntp
    state: present
  tags: ntp

- name: Configure ntp
  ansible.builtin.template:
    src: ntp.conf.j2
    dest: /etc/ntp.conf
  notify:
  - restart ntpd
  tags: ntp

- name: Enable and run ntpd
  ansible.builtin.service:
    name: ntpd
    state: started
    enabled: true
  tags: ntp

- name: Install NFS utils
  ansible.builtin.yum:
    name:
    - nfs-utils
    - nfs-util-lib
    state: present
  tags: filesharing

Если запустить эти четыре задачи в плейбуке с --tags ntp, Ansible выполнит три задачи с меткой ntp и пропустит задачу без этой метки.

# myrole/tasks/main.yml
- name: ntp tasks
  tags: ntp
  block:
  - name: Install ntp
    ansible.builtin.yum:
      name: ntp
      state: present

  - name: Configure ntp
    ansible.builtin.template:
      src: ntp.conf.j2
      dest: /etc/ntp.conf
    notify:
    - restart ntpd

  - name: Enable and run ntpd
    ansible.builtin.service:
      name: ntpd
      state: started
      enabled: true

- name: Install NFS utils
  ansible.builtin.yum:
    name:
    - nfs-utils
    - nfs-util-lib
    state: present
  tags: filesharing

- block:
  - debug: msg=run with tag, but always fail
    failed_when: true
    tags: example

  rescue:
  - debug: msg=I always run because the block always fails, except if you select to only run 'example' tag

  always:
  - debug: msg=I always run, except if you select to only run 'example' tag

- hosts: all
  tags: ntp
  tasks:
  - name: Install ntp
    ansible.builtin.yum:
      name: ntp
      state: present

  - name: Configure ntp
    ansible.builtin.template:
      src: ntp.conf.j2
      dest: /etc/ntp.conf
    notify:
    - restart ntpd

  - name: Enable and run ntpd
    ansible.builtin.service:
      name: ntpd
      state: started
      enabled: true

- hosts: fileservers
  tags: filesharing
  tasks:
  # ...

roles:
  - role: webserver
    vars:
      port: 5000
    tags: [ web, foo ]

---
- hosts: webservers
  roles:
    - role: foo
      tags:
        - bar
        - baz
    # using YAML shorthand, this is equivalent to:
    # - { role: foo, tags: ["bar", "baz"] }

---
# file: roles/common/tasks/main.yml

- name: Dynamic reuse of database tasks
  include_tasks: db.yml
  tags: db

---
- hosts: webservers
  tasks:
    - name: Include the bar role
      include_role:
        name: bar
      tags:
        - foo

---
- hosts: webservers
  tasks:
    - name: Import the foo role
      import_role:
        name: foo
      tags:
        - bar
        - baz

    - name: Import tasks from foo.yml
      import_tasks: foo.yml
      tags: [ web, foo ]

- name: Apply the db tag to the include and to all tasks in db.yml
  include_tasks:
    file: db.yml
    # adds 'db' tag to tasks within db.yml
    apply:
      tags: db
  # adds 'db' tag to this 'include_tasks' itself
  tags: db

- block:
   - name: Include tasks from db.yml
     include_tasks: db.yml
  tags: db

Always и Never

Ansible резервирует несколько имён меток для особого поведения; два из них — always и never. Если назначить метку always задаче или play, Ansible всегда будет выполнять эту задачу или play, кроме случаев, когда вы явно пропустите их (--skip-tags always) или другую метку, назначенную этой задаче.

Например:

tasks:
- name: Print a message
  ansible.builtin.debug:
    msg: "Always runs"
  tags:
  - always

- name: Print a message
  ansible.builtin.debug:
    msg: "runs when you use specify tag1, all(default) or tagged"
  tags:
  - tag1

- name: Print a message
  ansible.builtin.debug:
    msg: "always runs unless you explicitly skip, like if you use ``--skip-tags tag2``"
  tags:
     - always
     - tag2

Если назначить метку never задаче или play, Ansible пропустит эту задачу или play, если только вы явно не запросите её выполнение (--tags never) или другую метку, назначенную этой задаче.

Например:

tasks:
  - name: Run the rarely-used debug task, either with ``--tags debug`` or ``--tags never``
    ansible.builtin.debug:
     msg: '{{ showmevar }}'
    tags: [ never, debug ]

Редко используемая задача отладки в приведённом выше примере выполняется только при явном запросе меток debug или never.

Приоритет меток

Пропуск всегда имеет приоритет над явным выбором меток. Например, если указать одновременно --tags и --skip-tags, приоритет будет у последнего. Например, --tags tag1,tag3,tag4 --skip-tags tag3 выполнит только задачи с меткой tag1 или tag4, но не с tag3, даже если у задачи есть одна из других меток.

Предварительный просмотр результатов использования меток

При запуске роли или плейбука вы можете не знать или не помнить, какие метки назначены задачам и какие метки вообще существуют. Ansible предоставляет два флага командной строки для ansible-playbook, которые помогают работать с плейбуками, использующими метки:

• --list-tags — вывести список доступных меток
• --list-tasks — при использовании вместе с --tags tagname или --skip-tags tagname предварительно показать помеченные задачи

Например, если вы не знаете, называется ли метка для задач настройки config или conf в плейбуке, роли или файле задач, можно вывести список всех доступных меток, не запуская задачи:

ansible-playbook example.yml --list-tags

Если вы не знаете, какие задачи помечены configuration и packages, укажите эти метки и добавьте --list-tasks. Ansible выведет список задач, но не будет их выполнять.

ansible-playbook example.yml --tags "configuration,packages" --list-tasks

У этих флагов командной строки есть ограничение: они не могут показать метки и задачи внутри динамически включаемых файлов или ролей. Подробнее о различиях между статическими импортами и динамическими включениями см. в разделе Сравнение включений и импортов: динамическое и статическое повторное использование.

Выборочный запуск помеченных задач в повторно используемых файлах

Если в роли или файле задач метки заданы на уровне задач или блоков, можно выборочно запускать или пропускать эти помеченные задачи в плейбуке, используя динамическое включение вместо статического импорта. Одну и ту же метку необходимо назначить включаемым задачам и самой инструкции включения. Например, можно создать файл с помеченными и непомеченными задачами:

# mixed.yml
tasks:
- name: Run the task with no tags
  ansible.builtin.debug:
    msg: this task has no tags

- name: Run the tagged task
  ansible.builtin.debug:
    msg: this task is tagged with mytag
  tags: mytag

- block:
  - name: Run the first block task with mytag
    # ...
  - name: Run the second block task with mytag
    # ...
  tags:
  - mytag

Затем можно включить приведённый выше файл задач в плейбук:

# myplaybook.yml
- hosts: all
  tasks:
  - name: Run tasks from mixed.yml
    include_tasks:
      name: mixed.yml
    tags: mytag

При запуске плейбука с ansible-playbook -i hosts myplaybook.yml --tags "mytag" Ansible пропустит задачу без меток, выполнит отдельную помеченную задачу и обе задачи в блоке. Также могут быть собраны факты (неявная задача), поскольку эта задача помечена always.

Наследование меток: добавление меток к нескольким задачам

Чтобы назначить одну или несколько одинаковых меток нескольким задачам, не добавляя строку tags к каждой задаче, можно задать метки на уровне play или блока либо при добавлении роли или импорте файла. Ansible распространяет метки вниз по цепочке зависимостей на все дочерние задачи. Для ролей и импортов Ansible добавляет метки, заданные в разделе roles или импорте, к меткам, назначенным отдельным задачам или блокам внутри роли либо импортированного файла. Это называется наследованием меток. Наследование меток удобно, поскольку не нужно помечать каждую задачу. Однако метки всё равно применяются к задачам по отдельности.

Для play, блоков, ключевого слова role и статических импортов Ansible применяет наследование меток, добавляя заданные метки ко всем задачам внутри play, блока, роли или импортированного файла. Однако наследование меток не применяется при динамическом повторном использовании с include_role и include_tasks. При динамическом повторном использовании (включениях) заданные метки применяются только к самому включению. Если вам нужно наследование меток, используйте статический импорт. Если нельзя использовать импорт, поскольку в остальной части плейбука применяются включения, способы обойти это поведение описаны в разделе Наследование меток для включений: блоки и ключевое слово apply.

Метки можно назначать динамическим включениям в плейбуке. Как и метки отдельной задачи, метки задачи include_* применяются только к самому включению, но не к задачам внутри включённого файла или роли. Если добавить mytag к динамическому включению, а затем запустить плейбук с --tags mytag, Ansible выполнит само включение и задачи внутри включённого файла или роли, помеченные mytag, а задачи без этой метки пропустит. Подробнее см. в разделе Выборочный запуск помеченных задач в повторно используемых файлах.

Глобальная настройка меток

Если по умолчанию нужно выполнять или пропускать определённые метки, можно задать эти значения по умолчанию с помощью параметров TAGS_RUN и TAGS_SKIP в конфигурации Ansible.