import_role with extra-vars option

[Altiire]

SUMMARY

variable from extra-vars is not set while import_role is parsed

ISSUE TYPE

• Bug Report

COMPONENT NAME

import_role

ANSIBLE VERSION

ansible 2.9.7
  config file = /etc/ansible/ansible.cfg
  configured module search path = [u'/home/altiire/.ansible/plugins/modules', u'/usr/share/ansible/plugins/modules']
  ansible python module location = /usr/lib/python2.7/dist-packages/ansible
  executable location = /usr/bin/ansible
  python version = 2.7.16 (default, Oct 10 2019, 22:02:15) [GCC 8.3.0]

CONFIGURATION

ALLOW_WORLD_READABLE_TMPFILES(/etc/ansible/ansible.cfg) = True

OS / ENVIRONMENT

Debian 10 hosted on GCP compute engine

STEPS TO REPRODUCE

ansible-playbook --connection=local --inventory 127.0.0.1, deploy.yml --tags "docker-compose" --extra-vars '{"deployment_name": test,"del_services": [webserver]}'

---
- name: Create or update a deployment
  hosts: all
  tasks:
    - name: import deploy role with its overriden variables
      import_role:
        name: deploy
        vars_from: "{{ deployment_name }}"

EXPECTED RESULTS

run tasks specified by the tags

ACTUAL RESULTS

ansible-playbook 2.9.7
  config file = /etc/ansible/ansible.cfg
  configured module search path = [u'/home/altiire/.ansible/plugins/modules', u'/usr/share/ansible/plugins/modules']
  ansible python module location = /usr/lib/python2.7/dist-packages/ansible
  executable location = /usr/bin/ansible-playbook
  python version = 2.7.16 (default, Oct 10 2019, 22:02:15) [GCC 8.3.0]
Using /etc/ansible/ansible.cfg as config file
setting up inventory plugins
Set default localhost to 127.0.0.1
Parsed 127.0.0.1, inventory source with host_list plugin
ERROR! Could not find specified file in role: vars/{{ deployment_name }}

[sivel]

I'm not positive if there is a resolution to this. It may not be feasible to consult extra vars at this phase of the playbook run. I'd recommend that you switch to include_role instead of import_role to resolve this issue.

[Altiire]

Tags are not taken into account if I use include_role

[sivel]

Tags are not taken into account if I use include_role

Look into using apply for include_role, which allows you to apply tags to the included tasks.

[Altiire]

I can't succeed to make it works

my deploy.yml file

---
- name: Create or update a deployment
  hosts: all

  vars:
    - deployment_template_path: "{{ deployment_path }}/deployment_template"
    - current_deployment_path: "{{ deployment_path }}/{{ deployment_name }}"

  tasks:
    - name: include deploy role with its overriden variables
      include_role:
        name: deploy
        vars_from: "{{ deployment_name }}"
        apply:
          tags:
            - dockercompose

and my roles/deploy/tasks/main.yml

---
- fail:
    msg: The variable 'locale' is not set
  when: locale is none
- debug:
    msg: The variable 'sftp_password' is not set
  when: sftp_password is none
- include: stop-inotify.yml
- include: files.yml
- include: common_database.yml
- include: network.yml
- include: sftp.yml
- include_tasks:
    file: docker.yml
    apply:
      tags:
        - dockercompose
  tags:
    - dockercompose
- include: stop-inotify.yml
- include: backend.yml
- include: db.yml
- include: module_seed.yml
- include: office.yml
- include: start-inotify.yml
- include: cron.yml

My tasks in docker.yml are not executed

[sivel]

apply only affects the tasks within the deploy role. It does not tag the include_role itself. As such if you are using -t dockercompose from the CLI, it will skip the include_rolebecause it is not tagged.

You would need to use something like:

    - name: include deploy role with its overriden variables
      include_role:
        name: deploy
        vars_from: "{{ deployment_name }}"
        apply:
          tags:
            - dockercompose
      tags:
        - dockercompose

[Altiire]

But if I set tags on the include_role, all my tasks in the role get tagged too.

PLAY [Create or update a deployment] *******************************************************************************************************************************************************************************

TASK [Gathering Facts] *********************************************************************************************************************************************************************************************
ok: [127.0.0.1]

TASK [include deploy role with its overriden variables] ************************************************************************************************************************************************************

TASK [deploy : fail] ***********************************************************************************************************************************************************************************************
skipping: [127.0.0.1]

TASK [deploy : debug] **********************************************************************************************************************************************************************************************
ok: [127.0.0.1] => {
    "msg": "The variable 'sftp_password' is not set"
}

TASK [deploy : Stop inotify service] *******************************************************************************************************************************************************************************
changed: [127.0.0.1]

[sivel]

But if I set tags on the include_role, all my tasks in the role get tagged too

No, that is what apply does.

I think we've confused something here. You stated:

Tags are not taken into account if I use include_role

Which I assumed meant you wanted to use tags: on that include_role, but I think what you are saying, is that if a task is tagged somewhere inside of the included role, that it isn't found. I think what you want instead is to use the always tag:

    - name: include deploy role with its overriden variables
      include_role:
        name: deploy
        vars_from: "{{ deployment_name }}"
      tags:
        - always

Then the include_role always happens, and can then still filter tags that are specified on tasks explicitly within the role.

[Altiire]

I was thinking of the always tag too but the real problem was the story with apply/tags.

Thank you very much, it is now working and I learned a few things.

I let the issue open for the original issue.

Regards,

[xammi]

+1 user with this problem;

Have changed "include_role" on "import_role" and nothing good happened.

Created my own issue here - #69916