设置远程环境

版本 1.1 中的新增功能。

您可以在播放、块或任务级别使用 environment 关键字为远程主机上的操作设置环境变量。使用此关键字，您可以启用对执行 http 请求的任务使用代理，设置特定语言的版本管理器所需的環境變數，以及更多操作。

当您在播放或块级别使用 environment: 设置值时，它仅对同一用户执行的播放或块中的任务可用。 environment: 关键字不会影响 Ansible 本身、Ansible 配置设置、其他用户的环境或其他插件（如查找和过滤器）的执行。使用 environment: 设置的变量不会自动成为 Ansible 事实，即使您在播放级别设置它们也是如此。您必须在剧本中包含显式的 gather_facts 任务，并在该任务上设置 environment 关键字才能将这些值转换为 Ansible 事实。

在任务中设置远程环境 

您可以在任务级别直接设置环境。

- hosts: all
  remote_user: root

  tasks:

    - name: Install cobbler
      ansible.builtin.package:
        name: cobbler
        state: present
      environment:
        http_proxy: http://proxy.example.com:8080

您可以通过将环境设置定义为剧本中的变量并在任务中访问它们（就像访问任何存储的 Ansible 变量一样）来重复使用环境设置。

- hosts: all
  remote_user: root

  # create a variable named "proxy_env" that is a dictionary
  vars:
    proxy_env:
      http_proxy: http://proxy.example.com:8080

  tasks:

    - name: Install cobbler
      ansible.builtin.package:
        name: cobbler
        state: present
      environment: "{{ proxy_env }}"

您可以将环境设置存储在 group_vars 文件中，以便在多个剧本中重复使用。

---
# file: group_vars/boston

ntp_server: ntp.bos.example.com
backup: bak.bos.example.com
proxy_env:
  http_proxy: http://proxy.bos.example.com:8080
  https_proxy: http://proxy.bos.example.com:8080

您可以在播放级别设置远程环境。

- hosts: testing

  roles:
     - php
     - nginx

  environment:
    http_proxy: http://proxy.example.com:8080

这些示例展示了代理设置，但您可以通过这种方式提供任意数量的设置。

使用特定语言的版本管理器

某些特定语言的版本管理器（如 rbenv 和 nvm）要求您在这些工具使用时设置环境变量。手动使用这些工具时，您通常会从脚本或添加到 shell 配置文件中的行中获取一些环境变量。在 Ansible 中，您可以在播放级别使用 environment 关键字来做到这一点。

---
### A playbook demonstrating a common npm workflow:
# - Check for package.json in the application directory
# - If package.json exists:
#   * Run npm prune
#   * Run npm install

- hosts: application
  become: false

  vars:
    node_app_dir: /var/local/my_node_app

  environment:
    NVM_DIR: /var/local/nvm
    PATH: /var/local/nvm/versions/node/v4.2.1/bin:{{ ansible_env.PATH }}

  tasks:
  - name: Check for package.json
    ansible.builtin.stat:
      path: '{{ node_app_dir }}/package.json'
    register: packagejson

  - name: Run npm prune
    ansible.builtin.command: npm prune
    args:
      chdir: '{{ node_app_dir }}'
    when: packagejson.stat.exists

  - name: Run npm install
    community.general.npm:
      path: '{{ node_app_dir }}'
    when: packagejson.stat.exists

注意

上面的示例使用 ansible_env 作为 PATH 的一部分。基于 ansible_env 的变量存在风险。Ansible 通过收集事实来填充 ansible_env 值，因此变量的值取决于 Ansible 在收集这些事实时使用的 remote_user 或 become_user。如果您更改 remote_user/become_user，ansible_env 中的值可能不是您预期的。

警告

环境变量通常以明文形式传递（取决于 shell 插件），因此不建议将它们用作将机密信息传递到正在执行的模块的方法。

您也可以在任务级别指定环境。

---
- name: Install ruby 2.3.1
  ansible.builtin.command: rbenv install {{ rbenv_ruby_version }}
  args:
    creates: '{{ rbenv_root }}/versions/{{ rbenv_ruby_version }}/bin/ruby'
  vars:
    rbenv_root: /usr/local/rbenv
    rbenv_ruby_version: 2.3.1
  environment:
    CONFIGURE_OPTS: '--disable-install-doc'
    RBENV_ROOT: '{{ rbenv_root }}'
    PATH: '{{ rbenv_root }}/bin:{{ rbenv_root }}/shims:{{ rbenv_plugins }}/ruby-build/bin:{{ ansible_env.PATH }}'

另请参阅

Ansible 剧本: 剧本简介
通信: 有疑问？需要帮助？想分享你的想法？请访问 Ansible 通信指南

设置远程环境

在任务中设置远程环境

使用特定语言的版本管理器

在任务中设置远程环境 