mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-26 04:11:25 -07:00
27b4d7ed31
* First pass at making 'private' work on include_role, imports are always public * Prevent dupe task execution and overwriting handlers * New functionality will use public instead of deprecated private * Add tests for public exposure * Validate vars before import/include to ensure they don't expose too early * Add porting guide docs about public argument and change to import_role * Add additional docs about public and vars exposure to module docs * Insert role handlers at parse time, exposing them globally
89 lines
2.7 KiB
Python
89 lines
2.7 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
# Copyright: Ansible Project
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
from __future__ import absolute_import, division, print_function
|
|
__metaclass__ = type
|
|
|
|
|
|
ANSIBLE_METADATA = {
|
|
'metadata_version': '1.1',
|
|
'status': ['preview'],
|
|
'supported_by': 'core'
|
|
}
|
|
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
author: Ansible Core Team (@ansible)
|
|
module: import_role
|
|
short_description: Import a role into a play
|
|
description:
|
|
- Much like the `roles:` keyword, this task loads a role, but it allows you to control it when the role tasks run in
|
|
between other tasks of the play.
|
|
- Most keywords, loops and conditionals will only be applied to the imported tasks, not to this statement itself. If
|
|
you want the opposite behavior, use M(include_role) instead. To better understand the difference you can read
|
|
the L(Including and Importing Guide,../user_guide/playbooks_reuse_includes.html).
|
|
version_added: "2.4"
|
|
options:
|
|
name:
|
|
description:
|
|
- The name of the role to be executed.
|
|
required: True
|
|
tasks_from:
|
|
description:
|
|
- File to load from a role's C(tasks/) directory.
|
|
default: main
|
|
vars_from:
|
|
description:
|
|
- File to load from a role's C(vars/) directory.
|
|
default: main
|
|
defaults_from:
|
|
description:
|
|
- File to load from a role's C(defaults/) directory.
|
|
default: main
|
|
allow_duplicates:
|
|
description:
|
|
- Overrides the role's metadata setting to allow using a role more than once with the same parameters.
|
|
type: bool
|
|
default: 'yes'
|
|
private:
|
|
description:
|
|
- This option is a no op, and the functionality described in previous versions was not implemented. This
|
|
option will be removed in Ansible v2.8.
|
|
type: bool
|
|
default: 'no'
|
|
notes:
|
|
- Handlers are made available to the whole play.
|
|
- Variables defined in C(vars) and C(default) for the role are exposed at playbook parsing time. Due to this,
|
|
these variables will be accessible to roles and tasks executed before the the location of the C(import_role) task.
|
|
- Unlike C(include_role) variable exposure is not configurable, and will always be exposed.
|
|
'''
|
|
|
|
EXAMPLES = """
|
|
- hosts: all
|
|
tasks:
|
|
- import_role:
|
|
name: myrole
|
|
|
|
- name: Run tasks/other.yaml instead of 'main'
|
|
import_role:
|
|
name: myrole
|
|
tasks_from: other
|
|
|
|
- name: Pass variables to role
|
|
import_role:
|
|
name: myrole
|
|
vars:
|
|
rolevar1: value from task
|
|
|
|
- name: Apply condition to each task in role
|
|
import_role:
|
|
name: myrole
|
|
when: not idontwanttorun
|
|
"""
|
|
|
|
RETURN = """
|
|
# This module does not return anything except tasks to execute.
|
|
"""
|