cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

clarified some points on environment keyword usage (#64065)

Browse source
This commit is contained in:
Brian Coca 2019-10-29 13:17:41 -04:00 committed by Sandra McCann
parent 1aee11c860
commit 885ee62b53
1 changed files with 12 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
docs/docsite/rst/user_guide/playbooks_environment.rst
View file

@ -5,11 +5,11 @@ Setting the Environment (and Working With Proxies)
.. versionadded:: 1.1 .. versionadded:: 1.1
It is quite possible that you may need to get package updates through a proxy, or even get some package The ``environment`` keyword allows you to set an environment varaible for the action to be taken on the remote target.
updates through a proxy and access other packages not through a proxy. Or maybe a script you might wish to For example, it is quite possible that you may need to set a proxy for a task that does http requests.
call may also need certain environment variables set to run properly. Or maybe a utility or script that are called may also need certain environment variables set to run properly.
Ansible makes it easy for you to configure the remote execution environment by using the 'environment' keyword. Here is an example:: Here is an example::
- hosts: all - hosts: all
remote_user: root remote_user: root
@ -23,6 +23,10 @@ Ansible makes it easy for you to configure the remote execution environment by u
environment: environment:
http_proxy: http://proxy.example.com:8080 http_proxy: http://proxy.example.com:8080
.. note::
``environment:`` does not affect Ansible itself, ONLY the context of the specific task action and this does not include
Ansible's own configuration settings nor the execution of any other plugins, including lookups, filters, and so on.
The environment can also be stored in a variable, and accessed like so:: The environment can also be stored in a variable, and accessed like so::
- hosts: all - hosts: all
@ -104,6 +108,10 @@ Some language-specific version managers (such as rbenv and nvm) require environm
path: '{{ node_app_dir }}' path: '{{ node_app_dir }}'
when: packagejson.stat.exists when: packagejson.stat.exists
.. note::
``ansible_env:`` is normally populated by fact gathering (M(gather_facts)) and the value of the variables depends on the user
that did the gathering action. If you change remote_user/become_user you might end up using the wrong values for those variables.
You might also want to simply specify the environment for a single task:: You might also want to simply specify the environment for a single task::
--- ---
@ -119,9 +127,6 @@ You might also want to simply specify the environment for a single task::
RBENV_ROOT: '{{ rbenv_root }}' RBENV_ROOT: '{{ rbenv_root }}'
PATH: '{{ rbenv_root }}/bin:{{ rbenv_root }}/shims:{{ rbenv_plugins }}/ruby-build/bin:{{ ansible_env.PATH }}' PATH: '{{ rbenv_root }}/bin:{{ rbenv_root }}/shims:{{ rbenv_plugins }}/ruby-build/bin:{{ ansible_env.PATH }}'
.. note::
``environment:`` does not affect Ansible itself, ONLY the context of the specific task action and this does not include Ansible's own configuration settings.
.. seealso:: .. seealso::
:ref:`playbooks_intro` :ref:`playbooks_intro`