mirror of https://github.com/ansible/ansible.git
Some simplification of include_vars and renamed include_files to include_vars.
parent
684cbf8154
commit
dd6af369af
@ -1,44 +0,0 @@
|
||||
# -*- mode: python -*-
|
||||
|
||||
# Ansible is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
author: Benno Joy
|
||||
module: include_files
|
||||
short_description: Load variables in a file from a task
|
||||
description:
|
||||
- This module allows loading variables from a yaml file similar to vars_files but from a task.
|
||||
it would be specially useful for conditionally loading vars file from a role.
|
||||
- These variables will survive between plays.
|
||||
options:
|
||||
free-form:
|
||||
description:
|
||||
- Add the file name from which variables should be loaded, if called from a role it will look for
|
||||
the file in files directory else the path would be relative to playbook. An absolute path can
|
||||
also be provided.
|
||||
required: false
|
||||
version_added: "1.4"
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
# Example loading variable conditionally based on os distribution
|
||||
- include_files: "{{ ansible_os_distribution }}.yml"
|
||||
|
||||
# Example loading multiple variable files
|
||||
- include_files: "{{ item }}"
|
||||
with_fileglob: "*.yml"
|
||||
|
||||
#Example loading the first available file
|
||||
- include_files:
|
||||
first_available_file:
|
||||
- "foo.yml"
|
||||
- "bar.yml"
|
||||
|
||||
'''
|
@ -0,0 +1,38 @@
|
||||
# -*- mode: python -*-
|
||||
|
||||
# Ansible is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
author: Benno Joy
|
||||
module: include_vars
|
||||
short_description: Load variables from files, dynamically within a task.
|
||||
description:
|
||||
- Loads variables from a YAML file dynamically during task runtime. It can work with conditionals, or use host specific variables to determine the path name to load from.
|
||||
options:
|
||||
free-form:
|
||||
description:
|
||||
- The file name from which variables should be loaded, if called from a role it will look for
|
||||
the file in files/ subdirectory of the role, otherwise the path would be relative to playbook. An absolute path can also be provided.
|
||||
required: true
|
||||
version_added: "1.4"
|
||||
'''
|
||||
|
||||
EXAMPLES = """
|
||||
# Conditionally decide to load in variables when x is 0, otherwise do not.
|
||||
- include_vars: contingency_plan.yml
|
||||
when: x == 0
|
||||
|
||||
# Load a variable file based on the OS type, or a default if not found.
|
||||
- include_vars: "{{ item }}"
|
||||
with_first_found:
|
||||
- "{{ ansible_os_distribution }}.yml"
|
||||
- "default.yml"
|
||||
|
||||
"""
|
Loading…
Reference in New Issue