Fix READMEs

This commit is contained in:
Julian Labus 2018-02-28 15:20:51 +01:00
parent 004681b553
commit a97d27779d
No known key found for this signature in database
GPG key ID: 8AF209F2C6B3572A
19 changed files with 72 additions and 39 deletions

View file

@ -10,7 +10,8 @@ Diese Ansible role konfiguriert batman-adv Netzwerk Interfaces.
## Benötigte Variablen ## Benötigte Variablen
- Dictionary `meshes` - Dictionary `meshes`
´´´
```
meshes: meshes:
- id: xx - id: xx
... ...
@ -35,7 +36,8 @@ meshes:
mtu: # integer mtu: # integer
... ...
´´´ ```
- Host Variable `magic` - Host Variable `magic`
## MAC-Adressen ## MAC-Adressen

View file

@ -5,13 +5,14 @@ Diese Ansible role konfiguriert Netzwerk Interfaces für die definierten fastd I
Es wird zwischen node- und intragate-Instanzen unterschieden. Es wird zwischen node- und intragate-Instanzen unterschieden.
## Interface-Benamung ## Interface-Benamung
Node-Interfaces: $mesh.id + vpn + '-' + $mesh.fastd.nodes.instances.xx.mtu, z.B. "mzvpn-1312" - Node-Interfaces: _$mesh.id_ + vpn + '-' + _$mesh.fastd.nodes.instances.xx.mtu_, z.B. "mzvpn-1312"
Intragate-Interfaces: $mesh.id + 'ig' + vpn + '-' + $mesh.fastd.intragate.instances.xx.mtu, z.B. "mzigvpn-1312" - Intragate-Interfaces: _$mesh.id_ + 'ig' + vpn + '-' + _$mesh.fastd.intragate.instances.xx.mtu_, z.B. "mzigvpn-1312"
## Benötigte Variablen ## Benötigte Variablen
- Dictionary `meshes` - Dictionary `meshes`
´´´
```
meshes: meshes:
- id: xx - id: xx
... ...
@ -29,7 +30,8 @@ meshes:
mtu: # integer mtu: # integer
... ...
´´´ ```
- Host Variable `magic` - Host Variable `magic`
## MAC-Adressen ## MAC-Adressen

View file

@ -4,7 +4,8 @@ Diese Ansible role konfiguriert die GRE-Tunnel Interfaces, die für den Internet
## Benötigte Variablen ## Benötigte Variablen
- Dictionary `ffrl_exit_server` (Host Variable) - Dictionary `ffrl_exit_server` (Host Variable)
´´´
```
ffrl_exit_server: ffrl_exit_server:
ffrl-a-ak-ber: ffrl-a-ak-ber:
public_ipv4_address: 185.66.195.0 public_ipv4_address: 185.66.195.0
@ -30,4 +31,4 @@ ffrl_exit_server:
public_ipv4_address: 185.66.194.1 public_ipv4_address: 185.66.194.1
tunnel_ipv4_network: tunnel_ipv4_network:
tunnel_ipv6_network: tunnel_ipv6_network:
´´´ ```

View file

@ -9,7 +9,8 @@ Diese Ansible role konfiguriert iptables Regeln für IPv4+IPv6 eines Freifunk Ga
## Benötigte Variablen ## Benötigte Variablen
- List `sysctl_settings_netfilter` (Rollen Variable) - List `sysctl_settings_netfilter` (Rollen Variable)
´´´
```
sysctl_settings_netfilter: sysctl_settings_netfilter:
- name: # sysctl-Parameter - name: # sysctl-Parameter
value: # zu setzender Wert value: # zu setzender Wert
@ -22,8 +23,8 @@ meshes:
... ...
ipv4_network: ipv4_network:
... ...
```
´´´
- Variable `internet_exit_tcp_mss_ipv4` - Variable `internet_exit_tcp_mss_ipv4`
- Variable `internet_exit_tcp_mss_ipv6` - Variable `internet_exit_tcp_mss_ipv6`
- Host Variable `ffrl_public_ipv4_nat` # Format ip-adresse/prefix - Host Variable `ffrl_public_ipv4_nat` # Format ip-adresse/prefix

View file

@ -9,7 +9,8 @@ Diese Ansible role konfiguriert die Linux Bridges für die Freifunk Meshes.
## Benötigte Variablen ## Benötigte Variablen
- Dictionary `meshes` - Dictionary `meshes`
´´´
```
meshes: meshes:
-id: xx -id: xx
... ...
@ -20,7 +21,8 @@ meshes:
ipv6_public: ipv6_public:
- 2xxx.../48 # ipv6 public prefix - 2xxx.../48 # ipv6 public prefix
´´´ ```
- Host Variable `magic` - Host Variable `magic`
## MAC-Adressen ## MAC-Adressen

View file

@ -5,8 +5,8 @@ Diese Ansible role legt die erforderlichen routing tables an.
## Benötigte Variablen ## Benötigte Variablen
- `routing_tables` - `routing_tables`
´´´
```
routing_tables: routing_tables:
$name: # integer $name: # integer
```
´´´

View file

@ -11,7 +11,8 @@ Diese Ansible role konfiguriert System Einstellung bzgl. IP Routing.
## Benötigte Variablen ## Benötigte Variablen
- Dictionary `meshes` - Dictionary `meshes`
´´´
```
meshes: meshes:
- id: xx - id: xx
... ...
@ -19,8 +20,10 @@ meshes:
ipv4_network: ipv4_network:
ipv6_ula: ipv6_ula:
ipv6_public: ipv6_public:
´´´ ```
- List `sysctl_settings_gateway` (Rollen-Variable) - List `sysctl_settings_gateway` (Rollen-Variable)
``` ```
sysctl_settings_routing: sysctl_settings_routing:
- name: # sysctl-Parameter - name: # sysctl-Parameter
@ -28,6 +31,6 @@ sysctl_settings_routing:
... ...
- Host Variable `ffrl_public_ipv4_nat` # Format ip-adresse/prefix - Host Variable `ffrl_public_ipv4_nat` # Format ip-adresse/prefix
- Host Dictionary `ffrl_exit_server - Host Dictionary `ffrl_exit_server
```
´´´
- Host Variable `magic` - Host Variable `magic`

View file

@ -4,6 +4,7 @@ It expects the arguments pkg_repo_list, pkg_pkg_list and pkg_pip_list
to be filled. If any argument is undefined, the repectibe action will to be filled. If any argument is undefined, the repectibe action will
be skipped. See below for examples. be skipped. See below for examples.
```
pkg_repo_list: # example pkg_repo_list: # example
repo_keys: repo_keys:
- cool_guy: - cool_guy:
@ -30,3 +31,4 @@ pkg_pip_list: # example
# this flag controls the execution of the role; used to subdue if needed # this flag controls the execution of the role; used to subdue if needed
really_do: True really_do: True
```

View file

@ -13,7 +13,8 @@ Die Gateways agieren lediglich als Slave-DNS Server.
## Benötigte Variablen ## Benötigte Variablen
- Dictionary `meshes` - Dictionary `meshes`
´´´
```
meshes: meshes:
- id: xx - id: xx
... ...
@ -28,7 +29,8 @@ meshes:
- name: $zone # DNS-Domain - name: $zone # DNS-Domain
master: # optional: IP-Adresse des DNS Masters, wenn die vom übergeordneten abweicht. master: # optional: IP-Adresse des DNS Masters, wenn die vom übergeordneten abweicht.
´´´ ```
- Variable `icvpn_ipv4_transfer_net` - Variable `icvpn_ipv4_transfer_net`
- Variable `icvpn_ipv6_transfer_net` - Variable `icvpn_ipv6_transfer_net`
- Host Variable `magic` - Host Variable `magic`

View file

@ -9,6 +9,7 @@ Diese Ansible role ergänzt die benötigte bird + bird6 Konfiguration für den I
- Variable `as_public_ffrl` # Public ASN Freifunk Rheinland - Variable `as_public_ffrl` # Public ASN Freifunk Rheinland
- Dictionary `meshes` - Dictionary `meshes`
``` ```
meshes: meshes:
- id: xx - id: xx
@ -16,8 +17,10 @@ meshes:
ipv6_public: ipv6_public:
- # Public IPv6-Netzwerk - # Public IPv6-Netzwerk
``` ```
- Host Dictionary `ffrl_exit_server` - Host Dictionary `ffrl_exit_server`
´´´
```
ffrl_exit_server: ffrl_exit_server:
ffrl-a-ak-ber: ffrl-a-ak-ber:
public_ipv4_address: 185.66.195.0 public_ipv4_address: 185.66.195.0
@ -43,8 +46,9 @@ ffrl_exit_server:
public_ipv4_address: 185.66.194.1 public_ipv4_address: 185.66.194.1
tunnel_ipv4_network: tunnel_ipv4_network:
tunnel_ipv6_network: tunnel_ipv6_network:
´´´ ```
- Host Variable `ffrl_public_ipv4_nat` # Format ip-adresse/prefix
- Host Variable `ffrl_public_ipv4_nat` (Format ip-adresse/prefix)
- Host Variable `magic` - Host Variable `magic`
## Benötigte roles ## Benötigte roles

View file

@ -16,20 +16,23 @@ Im iBGP peeren wir mangels separatem Transfernetz (im Moment) im Mainzer Mesh Ne
- Variable `bgp_ipv6_transfer_net` # IPv6-Range des Mainzer Meshes, das aktuell als Transfernetz benutzt wird. - Variable `bgp_ipv6_transfer_net` # IPv6-Range des Mainzer Meshes, das aktuell als Transfernetz benutzt wird.
- Variable `bgp_as_private_mwu` # Private ASN von Freifunk MWU - Variable `bgp_as_private_mwu` # Private ASN von Freifunk MWU
- Dictionary `bgp_mwu_servers` - Dictionary `bgp_mwu_servers`
``` ```
spinat: # kurzer Hostname des Peers spinat: # kurzer Hostname des Peers
ipv4: 10.37.0.7 # IPv4-Adresse des Peers ipv4: 10.37.0.7 # IPv4-Adresse des Peers
ipv6: fd37:b4dc:4b1e::a25:7 # IPv6-Adresse des Peers ipv6: fd37:b4dc:4b1e::a25:7 # IPv6-Adresse des Peers
... ...
```
- Dictionary `meshes`
``` ```
- Dictionary `meshes`
´´´
meshes: meshes:
- id: xx - id: xx
... ...
ipv4_network: ipv4_network:
ipv6_ula: ipv6_ula:
- # IPv6-ULA Network - # IPv6-ULA Network
´´´ ```
- Host Variable `magic` - Host Variable `magic`

View file

@ -9,7 +9,8 @@ Wir nutzen diesen nur zur Verteilung von IPv4-Adressen.
## Benötigte Variablen ## Benötigte Variablen
- Dictionary `meshes` - Dictionary `meshes`
´´´
```
meshes: meshes:
- id: xx - id: xx
... ...
@ -20,7 +21,8 @@ meshes:
- $domain # string - $domain # string
kea_dnssl_binary: # kea < 1.2 only supports dnssl data in hex format kea_dnssl_binary: # kea < 1.2 only supports dnssl data in hex format
iface_mtu: # integer iface_mtu: # integer
´´´ ```
- Host Variable `magic` - Host Variable `magic`
- Host Variable `ipv4_dhcp_range` - Host Variable `ipv4_dhcp_range`

View file

@ -13,6 +13,7 @@ Diese Ansible role konfiguriert die fastd-Instanz für die Intra-Server Kommunik
## Benötigte Variablen ## Benötigte Variablen
- Dictionary `meshes` - Dictionary `meshes`
``` ```
meshes: meshes:
- id: xx - id: xx

View file

@ -11,12 +11,13 @@ Diese Ansible role konfiguriert die fastd-Instanz für die Knoten Kommunikation.
- klont bingener fastd peer repo (im Moment hardcoded) - klont bingener fastd peer repo (im Moment hardcoded)
## Instanz-Benamung ## Instanz-Benamung
Node-Instanzen: $mesh.id + vpn + '-' + $mesh.fastd.nodes.instances.xx.mtu, z.B. "mzvpn-1312" - Node-Instanzen: _$mesh.id_ + vpn + '-' + _$mesh.fastd.nodes.instances.xx.mtu_, z.B. "mzvpn-1312"
Intragate-Instanzen: $mesh.id + 'ig' + vpn + '-' + $mesh.fastd.intragate.instances.xx.mtu, z.B. "mzigvpn-1312" - Intragate-Instanzen: _$mesh.id_ + 'ig' + vpn + '-' + _$mesh.fastd.intragate.instances.xx.mtu_, z.B. "mzigvpn-1312"
## Benötigte Variablen ## Benötigte Variablen
- Dictionary `meshes` - Dictionary `meshes`
``` ```
meshes: meshes:
- id: xx - id: xx
@ -33,6 +34,7 @@ meshes:
pass: # String - Pfad des fastd secrets im Admin Pass pass: # String - Pfad des fastd secrets im Admin Pass
... ...
``` ```
- Liste `legacy_gateways` - Liste `legacy_gateways`
## fastd Secrets ## fastd Secrets

View file

@ -11,7 +11,8 @@ Diese Ansible role konfiguriert die Firmware Synchronisation und die erforderlic
- Variable `http_domain_external` # string: Externe Freifunk MWU Domain - Variable `http_domain_external` # string: Externe Freifunk MWU Domain
- Variable `http_domain_internal` # string: Interne Freifunk MWU Domain - Variable `http_domain_internal` # string: Interne Freifunk MWU Domain
- Dictionary `meshes` - Dictionary `meshes`
´´´
```
meshes: meshes:
- id: xx - id: xx
... ...
@ -19,4 +20,4 @@ meshes:
... ...
http_domain_external: # string: Externe Mesh Domain http_domain_external: # string: Externe Mesh Domain
http_domain_internal: # string: Interne Mesh Domain http_domain_internal: # string: Interne Mesh Domain
´´´ ```

View file

@ -9,7 +9,8 @@ Diese Ansible role installiert und konfiguriert den radvd daemon.
## Benötigte Variablen ## Benötigte Variablen
- Dictionary `meshes` - Dictionary `meshes`
´´´
```
meshes: meshes:
- id: xx - id: xx
... ...
@ -18,5 +19,6 @@ meshes:
ipv6_public: ipv6_public:
- # Public-Prefix - String - # Public-Prefix - String
iface_mtu: # Integer iface_mtu: # Integer
´´´ ```
- Host Variable `magic` - Host Variable `magic`

View file

@ -9,8 +9,9 @@ Pro Mesh Netzwerk muss eine `mesh-announce`-Instanz laufen.
## Benötigte Variablen ## Benötigte Variablen
- Dictionary `meshes` - Dictionary `meshes`
´´´
```
meshes: meshes:
- id: xx - id: xx
site_code: # string site_code: # string
´´´ ```

View file

@ -13,6 +13,7 @@ Diese Ansible role installiert und konfiguriert den tinc daemon, der für die Ve
## Benötigte Variablen ## Benötigte Variablen
- Dictionary `icvpn` - Dictionary `icvpn`
``` ```
icvpn: icvpn:
prefix: mwu prefix: mwu
@ -22,6 +23,7 @@ icvpn:
- Variable `icvpn_ipv4_transfer_net` - Variable `icvpn_ipv4_transfer_net`
- Variable `icvpn_ipv6_transfer_net` - Variable `icvpn_ipv6_transfer_net`
- Dictionary `routing_tables` - Dictionary `routing_tables`
``` ```
routing_tables: routing_tables:
icvpn: 23 icvpn: 23

View file

@ -3,10 +3,10 @@ Diese Ansible role setzt Freifunk Gateway spezifische sysctl-Parameter.
## Benötigte Variablen ## Benötigte Variablen
- List `sysctl_settings_gateway` (Rollen-Variable) - List `sysctl_settings_gateway` (Rollen-Variable)
``` ```
sysctl_settings_gateway: sysctl_settings_gateway:
- name: # sysctl-Parameter - name: # sysctl-Parameter
value: # zu setzender Wert value: # zu setzender Wert
... ...
```
´´´