rougail-tutorials/Rougail/socle/03-proxy.yml

---
version: '1.0'
env_proxy:
  description: HTTP(s) proxy server overview and configuration
  help: |
    A proxy server acts as an intermediary gateway between a client and another
    HTTP(s) server, such as the Internet.

    It makes service requests on behalf of a local client and allows the client
    to make network connections to network services outside its own network.
  host:
    description: The proxy server’s address
    help: |
      Specifies the hostname of proxy server to enable proxy server access to
      all of your HTTP(s) requests.
    type: domainname
    test:
      - proxy.silique.fr
  port:
    description: The proxy server's port
    type: port
    default: "3128"
  no_proxy:
    description: Exclude proxy server
    help: |
      Network address(es), network address range(s) and domains to exclude from
      using the proxy when initiating connection(s).
    type: "domainname"
    params:
      allow_ip: true
      allow_cidr_network: true
      allow_without_dot: true
      allow_startswith_dot: true
    multi: true
    test:
      - 192.168.1.1
      - 192.168.10.0/24
      - www.silique.fr
      - .internal.silique.fr
    mandatory: false
-												[tutorial Rougail 1.0] a single string variable

Proxy configuration
===================

Add a single "host" variable

---
env_proxy:
  host: proxy.example.net

											
										
										
											2023-12-18 11:34:29 +01:00
+								---
 								version: '1.0'
 								env_proxy:
-												[tutorial Rougail 1.1] advanced hostname variable

Proxy configuration
===================

Modify the "host" variable

Examples of Ops inventory file
==============================

1/ VALID:

---
env_proxy:
  host: proxy.example.net

2/ INVALID, host is null:

---
env_proxy:
  host:

3/ INVALID, host is an integer:

---
env_proxy:
  host: 1

4/ INVALID but only for rougail:

---
env_proxy:
  host: the proxy

											
										
										
											2023-12-18 11:34:30 +01:00
+								  description: HTTP(s) proxy server overview and configuration
 								  help: |
 								    A proxy server acts as an intermediary gateway between a client and another
 								    HTTP(s) server, such as the Internet.
 								    It makes service requests on behalf of a local client and allows the client
 								    to make network connections to network services outside its own network.
-												[tutorial Rougail 1.0] a single string variable

Proxy configuration
===================

Add a single "host" variable

---
env_proxy:
  host: proxy.example.net

											
										
										
											2023-12-18 11:34:29 +01:00
+								  host:
-												[tutorial Rougail 1.1] advanced hostname variable

Proxy configuration
===================

Modify the "host" variable

Examples of Ops inventory file
==============================

1/ VALID:

---
env_proxy:
  host: proxy.example.net

2/ INVALID, host is null:

---
env_proxy:
  host:

3/ INVALID, host is an integer:

---
env_proxy:
  host: 1

4/ INVALID but only for rougail:

---
env_proxy:
  host: the proxy

											
										
										
											2023-12-18 11:34:30 +01:00
+								    description: The proxy server’s address
 								    help: |
 								      Specifies the hostname of proxy server to enable proxy server access to
 								      all of your HTTP(s) requests.
 								    type: domainname
 								    test:
 								      - proxy.silique.fr
-												[tutorial Rougail 1.2] a port variable

Proxy configuration
===================

Add the env_proxy.port variable

---
env_proxy:
  host: proxy.example.net
  port: "3128"

Examples of Ops inventory file
==============================

1/ INVALID only with rougail:

---
env_proxy:
  host: proxy.example.net
  port: 3128

2/ INVALID, port is missing:

---
env_proxy:
  host: proxy.example.net

											
										
										
											2023-12-18 11:34:30 +01:00
+								  port:
 								    description: The proxy server's port
 								    type: port
-												[tutorial Rougail 1.3] default variable

Proxy configuration
===================

env_proxy.port has a default value
with ansible we needs to define a new mapping variable: env_proxy_all

Examples of Ops inventory file
==============================

1/ VALID:

---
env_proxy:
  host: proxy.example.net

2/ VALID:

---
env_proxy:
  host: proxy.example.net
  port: "3129"

											
										
										
											2023-12-18 11:34:31 +01:00
+								    default: "3128"
-												[tutorial Rougail 1.4] a variable with multiple values

Proxy configuration
===================

Add env_proxy.no_proxy for proxy exception

---
env_proxy:
  host: proxy.example.net
  no_proxy:
    - localhost
    - 192.168.1.1
    - .ac-dijon.fr

Examples of Ops inventory file
==============================

1/ INVALID, must be a list:

---
env_proxy:
  host: proxy.example.net
  no_proxy: localhost

2/ INVALID, an integer:

---
env_proxy:
  host: proxy.example.net
  no_proxy:
    - 1

3/ INVALID, without value:

---
env_proxy:
  host: proxy.example.net

											
										
										
											2023-12-18 11:34:31 +01:00
+								  no_proxy:
 								    description: Exclude proxy server
 								    help: |
 								      Network address(es), network address range(s) and domains to exclude from
 								      using the proxy when initiating connection(s).
 								    type: "domainname"
 								    params:
 								      allow_ip: true
 								      allow_cidr_network: true
 								      allow_without_dot: true
 								      allow_startswith_dot: true
 								    multi: true
 								    test:
 								      - 192.168.1.1
 								      - 192.168.10.0/24
 								      - www.silique.fr
 								      - .internal.silique.fr
-												[tutorial Rougail 1.5] variable is not mandatory

Proxy configuration
===================

The variable env_proxy.no_proxy is not mandatory

Examples of Ops inventory file
==============================

Modify the file: Ops/group_vars/all.yml

1/ VALID:

---
env_proxy:
  host: proxy.example.net
  no_proxy:
    - localhost
    - 192.168.1.1
    - .ac-dijon.fr

2/ VALID:

---
env_proxy:
  host: proxy.example.net

											
										
										
											2023-12-18 11:34:32 +01:00
+								    mandatory: false