Ansible Role: Proxy

An Ansible role that configures proxy server settings on Linux.

Requirements

None.

Role Variables

Available variables are listed below, along with default values (see defaults/main.yml):

http_proxy: "{{ ansible_env.http_proxy }}"
https_proxy: "{{ ansible_env.https_proxy }}"
ftp_proxy: "{{ ansible_env.ftp_proxy }}"
no_proxy: "{{ ansible_env.no_proxy }}"

The proxy variables are taken by default from the host machine via ansible_env. Override them if the proxy configured differs from the host. These are used to set up /etc/environment and the package manager (apt/yum) proxies.

install_docker_service_proxy: true
install_docker_containers_proxy: true

The install_docker_service_proxy variable controls whether or not to install docker service proxy (/etc/systemd/system/docker.service.d/proxy.conf), which allows the docker service to access the internet when running behind proxy server - meaning that docker can fetch images from the internet.

The install_docker_containers_proxy variable controls whether or not to install docker container proxy (~/.docker/config.json) for the specified users. This allows docker containers to access the internet behind proxy.

Dependencies

None.

Example Playbooks

The following playbook setups the system and user proxy for root and tomereli users, using proxy environment variables from the host machine:

- hosts: all
  roles:
    - role: tomereli.proxy
      vars:
        users:
          - username: root
          - username: tomereli

The following playbook setups the system proxy only using the given proxy settings:

- hosts: all
  roles:
    - role: tomereli.proxy
      vars:
        http_proxy: 'http://example-proxy-server.com:911/'
        https_proxy: 'http://example-proxy-server.com:911/'
        ftp_proxy: 'http://example-proxy-server.com:911/'
        no_proxy: 'localhost'

License

MIT / BSD

Author Information

This role was created in 2020 by Tomer Arbel-Eliyahu