stove/rougail-tutorials
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
rougail-tutorials/doc.md

93 lines
11 KiB
Markdown
Raw Normal View History

[tutorial Ansible 1.0] a single string variable Proxy configuration =================== Add a single "host" variable --- env_proxy: host: proxy.example.net
2023-12-18 11:34:30 +01:00
---
gitea: none
include_toc: true
---
# Variables
[tutorial Ansible 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
## HTTP(s) proxy server overview and configuration (env_proxy)
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 Ansible 1.0] a single string variable Proxy configuration =================== Add a single "host" variable --- env_proxy: host: proxy.example.net
2023-12-18 11:34:30 +01:00
| Parameter | Comment |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
[tutorial Ansible 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
| **host**<br/>`mandatory`<br/>**Type:** [`domainname`](https://forge.cloud.silique.fr/stove/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | The proxy server’s address.<br/>Specifies the hostname of proxy server to enable proxy server access to all of your HTTP(s) requests. .<br/>**Example:** proxy.silique.fr |
[tutorial Ansible 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
| **port**<br/>`mandatory`<br/>**Type:** [`port`](https://forge.cloud.silique.fr/stove/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | The proxy server's port.<br/>**Default:** 3128 |
[tutorial Ansible 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
| **no_proxy**<br/>`multiple`<br/>**Type:** [`domainname`](https://forge.cloud.silique.fr/stove/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Exclude proxy server.<br/>Network address(es), network address range(s) and domains to exclude from using the proxy when initiating connection(s). .<br/>**Examples:** 192.168.1.1, 192.168.10.0/24, www.silique.fr, .internal.silique.fr |
[tutorial Ansible 1.0] a single string variable Proxy configuration =================== Add a single "host" variable --- env_proxy: host: proxy.example.net
2023-12-18 11:34:30 +01:00
[tutorial Ansible 2.0] a leadership family Apero configuration =================== Add access variables (login and password) --- env_apero: access: - login: srep password: oIJuheu27__u2 - login: snom password: oIJuheu27__u2 Examples of Ops inventory file ============================== 1/ VALID: 2/ INVALID, login and password are mandatory if a list is set: --- env_apero: access: - login: srep - login:
2023-12-18 11:34:33 +01:00
## Apero service (env_apero)
### Add access informations to Apero service (env_apero.access)
To access to Apero service, other services need an account and
a password.
This family is a leadership.
| Parameter | Comment |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
[tutorial Ansible 2.1] a choice option Apero configuration =================== Login is now mandatory Use an existant user login --- env_apero: access: - login: srep password: oIJuheu27__u2 - login: snom password: oIJuheu27__u2 env_srep: apero_user: srep Examples of Ops inventory file ============================== 1/ INVALID, use an unexisted user: --- env_apero: access: - login: srep password: oIJuheu27__u2 - login: snom password: oIJuheu27__u2 env_srep: apero_user: unknown
2023-12-18 11:34:33 +01:00
| **login**<br/>`mandatory`, `multiple`<br/>**Type:** [`unix_user`](https://forge.cloud.silique.fr/stove/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Login name.<br/>The account name is typically the name of foreign services. .<br/>**Example:** srep |
[tutorial Ansible 2.0] a leadership family Apero configuration =================== Add access variables (login and password) --- env_apero: access: - login: srep password: oIJuheu27__u2 - login: snom password: oIJuheu27__u2 Examples of Ops inventory file ============================== 1/ VALID: 2/ INVALID, login and password are mandatory if a list is set: --- env_apero: access: - login: srep - login:
2023-12-18 11:34:33 +01:00
| **password**<br/>`mandatory`<br/>**Type:** [`secret`](https://forge.cloud.silique.fr/stove/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Password. |
[tutorial Ansible 2.1] a choice option Apero configuration =================== Login is now mandatory Use an existant user login --- env_apero: access: - login: srep password: oIJuheu27__u2 - login: snom password: oIJuheu27__u2 env_srep: apero_user: srep Examples of Ops inventory file ============================== 1/ INVALID, use an unexisted user: --- env_apero: access: - login: srep password: oIJuheu27__u2 - login: snom password: oIJuheu27__u2 env_srep: apero_user: unknown
2023-12-18 11:34:33 +01:00
## SREP service (env_srep)
| Parameter | Comment |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **apero_user**<br/>`mandatory`<br/>**Type:** [`choice`](https://forge.cloud.silique.fr/stove/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Account to access to Apero service.<br/>**Choices:** see variable "env_apero.access.login"<br/>**Example:** srep |
[tutorial Ansible 3.0] a validator OMOGEN configuration ==================== Ask the keystore filename. This file must has jks extension. --- env_omogen: keystore: filename.jks Examples of Ops inventory file ============================== 1/ INVALID: --- env_omogen: keystore: filename.txt
2023-12-18 11:34:34 +01:00
## Configure OMOGEN (env_omogen)
| Parameter | Comment |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **keystore**<br/>`mandatory`<br/>**Type:** [`string`](https://forge.cloud.silique.fr/stove/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Keystore filename to access to OMOGEN.<br/>This filename must ends with "kjs" extension.<br/>**Example:** java.jks |
[tutorial Ansible 4.0] a boolean variable NFS configuration ================= Need could be activated. In this case, we need to add server domain name --- env_nfs: configure: true
2023-12-18 11:34:35 +01:00
## NFS configuration (env_nfs)
| Parameter | Comment |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **configure**<br/>`mandatory`<br/>**Type:** [`boolean`](https://forge.cloud.silique.fr/stove/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Configure NFS mount.<br/>To share documents between differents services, you need to configure a NFS server .<br/>**Default:** False |
[tutorial Ansible 4.1] conditional disabled variable NFS configuration ================= Need could be activated. In this case, we need to add server domain name --- env_nfs: configure: true server: another-nfs.silique.fr Examples of Ops inventory file ============================== 1/ INVALID, only with Rougail: --- env_nfs: configure: false server: another-nfs.silique.fr 2/ VALID: --- env_nfs: configure: true
2023-12-18 11:34:35 +01:00
| **server**<br/>`mandatory`<br/>**Type:** [`domainname`](https://forge.cloud.silique.fr/stove/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | NFS server name.<br/>Configure NFS server only if env_nfs.configure is true.<br/>**Default:** nfs.silique.fr |
[tutorial Ansible 4.0] a boolean variable NFS configuration ================= Need could be activated. In this case, we need to add server domain name --- env_nfs: configure: true
2023-12-18 11:34:35 +01:00
[tutorial Ansible 1.0] a single string variable Proxy configuration =================== Add a single "host" variable --- env_proxy: host: proxy.example.net
2023-12-18 11:34:30 +01:00
# Example with mandatories variables
```
env_proxy:
[tutorial Ansible 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
host: proxy.silique.fr
[tutorial Ansible 2.1] a choice option Apero configuration =================== Login is now mandatory Use an existant user login --- env_apero: access: - login: srep password: oIJuheu27__u2 - login: snom password: oIJuheu27__u2 env_srep: apero_user: srep Examples of Ops inventory file ============================== 1/ INVALID, use an unexisted user: --- env_apero: access: - login: srep password: oIJuheu27__u2 - login: snom password: oIJuheu27__u2 env_srep: apero_user: unknown
2023-12-18 11:34:33 +01:00
env_apero:
access:
- login: srep
password: xxx
env_srep:
apero_user: srep
[tutorial Ansible 3.0] a validator OMOGEN configuration ==================== Ask the keystore filename. This file must has jks extension. --- env_omogen: keystore: filename.jks Examples of Ops inventory file ============================== 1/ INVALID: --- env_omogen: keystore: filename.txt
2023-12-18 11:34:34 +01:00
env_omogen:
keystore: java.jks
[tutorial Ansible 1.0] a single string variable Proxy configuration =================== Add a single "host" variable --- env_proxy: host: proxy.example.net
2023-12-18 11:34:30 +01:00
```
# Example with all variables
```
env_proxy:
[tutorial Ansible 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
host: proxy.silique.fr
[tutorial Ansible 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:31 +01:00
port: '3128'
[tutorial Ansible 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:32 +01:00
no_proxy:
- 192.168.1.1
- 192.168.10.0/24
- www.silique.fr
- .internal.silique.fr
[tutorial Ansible 2.0] a leadership family Apero configuration =================== Add access variables (login and password) --- env_apero: access: - login: srep password: oIJuheu27__u2 - login: snom password: oIJuheu27__u2 Examples of Ops inventory file ============================== 1/ VALID: 2/ INVALID, login and password are mandatory if a list is set: --- env_apero: access: - login: srep - login:
2023-12-18 11:34:33 +01:00
env_apero:
access:
- login: srep
password: xxx
[tutorial Ansible 2.1] a choice option Apero configuration =================== Login is now mandatory Use an existant user login --- env_apero: access: - login: srep password: oIJuheu27__u2 - login: snom password: oIJuheu27__u2 env_srep: apero_user: srep Examples of Ops inventory file ============================== 1/ INVALID, use an unexisted user: --- env_apero: access: - login: srep password: oIJuheu27__u2 - login: snom password: oIJuheu27__u2 env_srep: apero_user: unknown
2023-12-18 11:34:33 +01:00
env_srep:
apero_user: srep
[tutorial Ansible 3.0] a validator OMOGEN configuration ==================== Ask the keystore filename. This file must has jks extension. --- env_omogen: keystore: filename.jks Examples of Ops inventory file ============================== 1/ INVALID: --- env_omogen: keystore: filename.txt
2023-12-18 11:34:34 +01:00
env_omogen:
keystore: java.jks
[tutorial Ansible 4.0] a boolean variable NFS configuration ================= Need could be activated. In this case, we need to add server domain name --- env_nfs: configure: true
2023-12-18 11:34:35 +01:00
env_nfs:
configure: false
[tutorial Ansible 1.0] a single string variable Proxy configuration =================== Add a single "host" variable --- env_proxy: host: proxy.example.net
2023-12-18 11:34:30 +01:00
```
Reference in a new issue Copy permalink