From a97d27779dbb6051e498bdf2ea43492df03d227d Mon Sep 17 00:00:00 2001 From: Julian Labus Date: Wed, 28 Feb 2018 15:20:51 +0100 Subject: [PATCH] Fix READMEs --- roles/network-batman/README.md | 6 ++++-- roles/network-fastd/README.md | 10 ++++++---- roles/network-ffrl/README.md | 5 +++-- roles/network-iptables-gateway/README.md | 5 +++-- roles/network-meshbridge/README.md | 6 ++++-- roles/network-routetables/README.md | 6 +++--- roles/network-routing/README.md | 9 ++++++--- roles/packages/{read.me => README.md} | 2 ++ roles/service-bind-slave/README.md | 8 +++++--- roles/service-bird-ffrl/README.md | 10 +++++++--- roles/service-bird/README.md | 9 ++++++--- roles/service-dhcpd/README.md | 6 ++++-- roles/service-fastd-intragate/README.md | 1 + roles/service-fastd-mesh/README.md | 6 ++++-- roles/service-nginx-firmware/README.md | 5 +++-- roles/service-radvd/README.md | 6 ++++-- roles/service-respondd/README.md | 5 +++-- roles/service-tinc/README.md | 2 ++ roles/system-sysctl-gateway/README.md | 4 ++-- 19 files changed, 72 insertions(+), 39 deletions(-) rename roles/packages/{read.me => README.md} (99%) diff --git a/roles/network-batman/README.md b/roles/network-batman/README.md index 0e11f2d..08eddd0 100644 --- a/roles/network-batman/README.md +++ b/roles/network-batman/README.md @@ -10,7 +10,8 @@ Diese Ansible role konfiguriert batman-adv Netzwerk Interfaces. ## Benötigte Variablen - Dictionary `meshes` -´´´ + +``` meshes: - id: xx ... @@ -35,7 +36,8 @@ meshes: mtu: # integer ... -´´´ +``` + - Host Variable `magic` ## MAC-Adressen diff --git a/roles/network-fastd/README.md b/roles/network-fastd/README.md index 10202a8..a46ed83 100644 --- a/roles/network-fastd/README.md +++ b/roles/network-fastd/README.md @@ -5,13 +5,14 @@ Diese Ansible role konfiguriert Netzwerk Interfaces für die definierten fastd I Es wird zwischen node- und intragate-Instanzen unterschieden. ## Interface-Benamung -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" +- 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" ## Benötigte Variablen - Dictionary `meshes` -´´´ + +``` meshes: - id: xx ... @@ -29,7 +30,8 @@ meshes: mtu: # integer ... -´´´ +``` + - Host Variable `magic` ## MAC-Adressen diff --git a/roles/network-ffrl/README.md b/roles/network-ffrl/README.md index 4ba787e..1ae6752 100644 --- a/roles/network-ffrl/README.md +++ b/roles/network-ffrl/README.md @@ -4,7 +4,8 @@ Diese Ansible role konfiguriert die GRE-Tunnel Interfaces, die für den Internet ## Benötigte Variablen - Dictionary `ffrl_exit_server` (Host Variable) -´´´ + +``` ffrl_exit_server: ffrl-a-ak-ber: public_ipv4_address: 185.66.195.0 @@ -30,4 +31,4 @@ ffrl_exit_server: public_ipv4_address: 185.66.194.1 tunnel_ipv4_network: tunnel_ipv6_network: -´´´ +``` diff --git a/roles/network-iptables-gateway/README.md b/roles/network-iptables-gateway/README.md index bd8c854..ee6ccc2 100644 --- a/roles/network-iptables-gateway/README.md +++ b/roles/network-iptables-gateway/README.md @@ -9,7 +9,8 @@ Diese Ansible role konfiguriert iptables Regeln für IPv4+IPv6 eines Freifunk Ga ## Benötigte Variablen - List `sysctl_settings_netfilter` (Rollen Variable) -´´´ + +``` sysctl_settings_netfilter: - name: # sysctl-Parameter value: # zu setzender Wert @@ -22,8 +23,8 @@ meshes: ... ipv4_network: ... +``` -´´´ - Variable `internet_exit_tcp_mss_ipv4` - Variable `internet_exit_tcp_mss_ipv6` - Host Variable `ffrl_public_ipv4_nat` # Format ip-adresse/prefix diff --git a/roles/network-meshbridge/README.md b/roles/network-meshbridge/README.md index ada7e95..9afcb6f 100644 --- a/roles/network-meshbridge/README.md +++ b/roles/network-meshbridge/README.md @@ -9,7 +9,8 @@ Diese Ansible role konfiguriert die Linux Bridges für die Freifunk Meshes. ## Benötigte Variablen - Dictionary `meshes` -´´´ + +``` meshes: -id: xx ... @@ -20,7 +21,8 @@ meshes: ipv6_public: - 2xxx.../48 # ipv6 public prefix -´´´ +``` + - Host Variable `magic` ## MAC-Adressen diff --git a/roles/network-routetables/README.md b/roles/network-routetables/README.md index 0ecc6d1..6629687 100644 --- a/roles/network-routetables/README.md +++ b/roles/network-routetables/README.md @@ -5,8 +5,8 @@ Diese Ansible role legt die erforderlichen routing tables an. ## Benötigte Variablen - `routing_tables` -´´´ + +``` routing_tables: $name: # integer - -´´´ +``` diff --git a/roles/network-routing/README.md b/roles/network-routing/README.md index db00a5b..125c2b1 100644 --- a/roles/network-routing/README.md +++ b/roles/network-routing/README.md @@ -11,7 +11,8 @@ Diese Ansible role konfiguriert System Einstellung bzgl. IP Routing. ## Benötigte Variablen - Dictionary `meshes` -´´´ + +``` meshes: - id: xx ... @@ -19,8 +20,10 @@ meshes: ipv4_network: ipv6_ula: ipv6_public: -´´´ +``` + - List `sysctl_settings_gateway` (Rollen-Variable) + ``` sysctl_settings_routing: - name: # sysctl-Parameter @@ -28,6 +31,6 @@ sysctl_settings_routing: ... - Host Variable `ffrl_public_ipv4_nat` # Format ip-adresse/prefix - Host Dictionary `ffrl_exit_server +``` -´´´ - Host Variable `magic` diff --git a/roles/packages/read.me b/roles/packages/README.md similarity index 99% rename from roles/packages/read.me rename to roles/packages/README.md index b73dc46..8952f5c 100644 --- a/roles/packages/read.me +++ b/roles/packages/README.md @@ -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 be skipped. See below for examples. +``` pkg_repo_list: # example repo_keys: - cool_guy: @@ -30,3 +31,4 @@ pkg_pip_list: # example # this flag controls the execution of the role; used to subdue if needed really_do: True +``` diff --git a/roles/service-bind-slave/README.md b/roles/service-bind-slave/README.md index 42d4f12..a8d6b3f 100644 --- a/roles/service-bind-slave/README.md +++ b/roles/service-bind-slave/README.md @@ -13,7 +13,8 @@ Die Gateways agieren lediglich als Slave-DNS Server. ## Benötigte Variablen - Dictionary `meshes` -´´´ + +``` meshes: - id: xx ... @@ -27,8 +28,9 @@ meshes: forward_zones: - name: $zone # DNS-Domain master: # optional: IP-Adresse des DNS Masters, wenn die vom übergeordneten abweicht. - -´´´ + +``` + - Variable `icvpn_ipv4_transfer_net` - Variable `icvpn_ipv6_transfer_net` - Host Variable `magic` diff --git a/roles/service-bird-ffrl/README.md b/roles/service-bird-ffrl/README.md index 78f98b3..d30f3a7 100644 --- a/roles/service-bird-ffrl/README.md +++ b/roles/service-bird-ffrl/README.md @@ -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 - Dictionary `meshes` + ``` meshes: - id: xx @@ -16,8 +17,10 @@ meshes: ipv6_public: - # Public IPv6-Netzwerk ``` + - Host Dictionary `ffrl_exit_server` -´´´ + +``` ffrl_exit_server: ffrl-a-ak-ber: public_ipv4_address: 185.66.195.0 @@ -43,8 +46,9 @@ ffrl_exit_server: public_ipv4_address: 185.66.194.1 tunnel_ipv4_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` ## Benötigte roles diff --git a/roles/service-bird/README.md b/roles/service-bird/README.md index 22995c5..9224ece 100644 --- a/roles/service-bird/README.md +++ b/roles/service-bird/README.md @@ -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_as_private_mwu` # Private ASN von Freifunk MWU - Dictionary `bgp_mwu_servers` + ``` spinat: # kurzer Hostname des Peers ipv4: 10.37.0.7 # IPv4-Adresse des Peers ipv6: fd37:b4dc:4b1e::a25:7 # IPv6-Adresse des Peers ... +``` + +- Dictionary `meshes` ``` -- Dictionary `meshes` -´´´ meshes: - id: xx ... ipv4_network: ipv6_ula: - # IPv6-ULA Network -´´´ +``` + - Host Variable `magic` diff --git a/roles/service-dhcpd/README.md b/roles/service-dhcpd/README.md index 7e1dcb2..66bc317 100644 --- a/roles/service-dhcpd/README.md +++ b/roles/service-dhcpd/README.md @@ -9,7 +9,8 @@ Wir nutzen diesen nur zur Verteilung von IPv4-Adressen. ## Benötigte Variablen - Dictionary `meshes` -´´´ + +``` meshes: - id: xx ... @@ -20,7 +21,8 @@ meshes: - $domain # string kea_dnssl_binary: # kea < 1.2 only supports dnssl data in hex format iface_mtu: # integer -´´´ +``` + - Host Variable `magic` - Host Variable `ipv4_dhcp_range` diff --git a/roles/service-fastd-intragate/README.md b/roles/service-fastd-intragate/README.md index 2127c19..5902db0 100644 --- a/roles/service-fastd-intragate/README.md +++ b/roles/service-fastd-intragate/README.md @@ -13,6 +13,7 @@ Diese Ansible role konfiguriert die fastd-Instanz für die Intra-Server Kommunik ## Benötigte Variablen - Dictionary `meshes` + ``` meshes: - id: xx diff --git a/roles/service-fastd-mesh/README.md b/roles/service-fastd-mesh/README.md index f7fad8e..42d764c 100644 --- a/roles/service-fastd-mesh/README.md +++ b/roles/service-fastd-mesh/README.md @@ -11,12 +11,13 @@ Diese Ansible role konfiguriert die fastd-Instanz für die Knoten Kommunikation. - klont bingener fastd peer repo (im Moment hardcoded) ## Instanz-Benamung -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" +- 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" ## Benötigte Variablen - Dictionary `meshes` + ``` meshes: - id: xx @@ -33,6 +34,7 @@ meshes: pass: # String - Pfad des fastd secrets im Admin Pass ... ``` + - Liste `legacy_gateways` ## fastd Secrets diff --git a/roles/service-nginx-firmware/README.md b/roles/service-nginx-firmware/README.md index 77e5c75..5a5e197 100644 --- a/roles/service-nginx-firmware/README.md +++ b/roles/service-nginx-firmware/README.md @@ -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_internal` # string: Interne Freifunk MWU Domain - Dictionary `meshes` -´´´ + +``` meshes: - id: xx ... @@ -19,4 +20,4 @@ meshes: ... http_domain_external: # string: Externe Mesh Domain http_domain_internal: # string: Interne Mesh Domain -´´´ +``` diff --git a/roles/service-radvd/README.md b/roles/service-radvd/README.md index be02ed7..47c7a9e 100644 --- a/roles/service-radvd/README.md +++ b/roles/service-radvd/README.md @@ -9,7 +9,8 @@ Diese Ansible role installiert und konfiguriert den radvd daemon. ## Benötigte Variablen - Dictionary `meshes` -´´´ + +``` meshes: - id: xx ... @@ -18,5 +19,6 @@ meshes: ipv6_public: - # Public-Prefix - String iface_mtu: # Integer -´´´ +``` + - Host Variable `magic` diff --git a/roles/service-respondd/README.md b/roles/service-respondd/README.md index e8a5579..535f1e8 100644 --- a/roles/service-respondd/README.md +++ b/roles/service-respondd/README.md @@ -9,8 +9,9 @@ Pro Mesh Netzwerk muss eine `mesh-announce`-Instanz laufen. ## Benötigte Variablen - Dictionary `meshes` -´´´ + +``` meshes: - id: xx site_code: # string -´´´ +``` diff --git a/roles/service-tinc/README.md b/roles/service-tinc/README.md index 855df5c..1be3443 100644 --- a/roles/service-tinc/README.md +++ b/roles/service-tinc/README.md @@ -13,6 +13,7 @@ Diese Ansible role installiert und konfiguriert den tinc daemon, der für die Ve ## Benötigte Variablen - Dictionary `icvpn` + ``` icvpn: prefix: mwu @@ -22,6 +23,7 @@ icvpn: - Variable `icvpn_ipv4_transfer_net` - Variable `icvpn_ipv6_transfer_net` - Dictionary `routing_tables` + ``` routing_tables: icvpn: 23 diff --git a/roles/system-sysctl-gateway/README.md b/roles/system-sysctl-gateway/README.md index 13c5d33..3570115 100644 --- a/roles/system-sysctl-gateway/README.md +++ b/roles/system-sysctl-gateway/README.md @@ -3,10 +3,10 @@ Diese Ansible role setzt Freifunk Gateway spezifische sysctl-Parameter. ## Benötigte Variablen - List `sysctl_settings_gateway` (Rollen-Variable) + ``` sysctl_settings_gateway: - name: # sysctl-Parameter value: # zu setzender Wert ... - -´´´ +```