mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-26 20:31:27 -07:00
utilities: Clean up parameter types and add seealso (#53063)
* utilities: Clean up parameter types and add seealso * Add inventory modules * Add more references, clarify with-loops
This commit is contained in:
parent
77a03af394
commit
f47191674e
21 changed files with 468 additions and 321 deletions
|
@ -1,20 +1,19 @@
|
|||
#!/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 = '''
|
||||
DOCUMENTATION = r'''
|
||||
---
|
||||
author: Ansible Core Team (@ansible)
|
||||
module: include
|
||||
|
@ -23,11 +22,11 @@ description:
|
|||
- Includes a file with a list of plays or tasks to be executed in the current playbook.
|
||||
- Files with a list of plays can only be included at the top level. Lists of tasks can only be included where tasks
|
||||
normally run (in play).
|
||||
- Before Ansible version 2.0, all includes were 'static' and were executed when the play was compiled.
|
||||
- Before Ansible 2.0, all includes were 'static' and were executed when the play was compiled.
|
||||
- Static includes are not subject to most directives. For example, loops or conditionals are applied instead to each
|
||||
inherited task.
|
||||
- Since Ansible 2.0, task includes are dynamic and behave more like real tasks. This means they can be looped,
|
||||
skipped and use variables from any source. Ansible tries to auto detect this, but you can use the `static`
|
||||
skipped and use variables from any source. Ansible tries to auto detect this, but you can use the C(static)
|
||||
directive (which was added in Ansible 2.1) to bypass autodetection.
|
||||
- This module is also supported for Windows targets.
|
||||
version_added: "0.6"
|
||||
|
@ -40,10 +39,18 @@ notes:
|
|||
- Include has some unintuitive behaviours depending on if it is running in a static or dynamic in play or in playbook context,
|
||||
in an effort to clarify behaviours we are moving to a new set modules (M(include_tasks), M(include_role), M(import_playbook), M(import_tasks))
|
||||
that have well established and clear behaviours.
|
||||
This module will still be supported for some time but we are looking at deprecating it in the near future.
|
||||
- B(This module will still be supported for some time but we are looking at deprecating it in the near future.)
|
||||
seealso:
|
||||
- module: import_playbook
|
||||
- module: import_role
|
||||
- module: import_tasks
|
||||
- module: include_role
|
||||
- module: include_tasks
|
||||
- ref: playbooks_reuse_includes
|
||||
description: More information related to including and importing playbooks, roles and tasks.
|
||||
'''
|
||||
|
||||
EXAMPLES = """
|
||||
EXAMPLES = r'''
|
||||
- hosts: localhost
|
||||
tasks:
|
||||
- debug:
|
||||
|
@ -73,8 +80,8 @@ EXAMPLES = """
|
|||
include: "{{ hostvar }}.yaml"
|
||||
static: no
|
||||
when: hostvar is defined
|
||||
"""
|
||||
'''
|
||||
|
||||
RETURN = """
|
||||
RETURN = r'''
|
||||
# This module does not return anything except plays or tasks to execute.
|
||||
"""
|
||||
'''
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue