From 8b81eb6d7e072eb6a637a32294d5b9be641fc678 Mon Sep 17 00:00:00 2001 From: Julian Labus Date: Wed, 12 Sep 2018 16:30:28 +0200 Subject: [PATCH] update READMEs --- roles/git-repos/README.md | 2 ++ roles/golang/README.md | 11 ++++++ roles/network-batman/README.md | 2 ++ roles/network-fastd/README.md | 8 +++-- roles/network-routing/README.md | 11 +++--- roles/prerequisites/README.md | 1 + roles/server-basic/README.md | 3 ++ roles/service-grafana/README.md | 14 ++++++++ roles/service-influxdb/README.md | 10 ++++++ roles/service-nginx-meshviewer/README.md | 46 ++++++++++++++++++++++++ roles/service-nginx/README.md | 3 +- roles/service-yanic/README.md | 23 ++++++++++++ roles/yarn/README.md | 6 ++++ 13 files changed, 132 insertions(+), 8 deletions(-) create mode 100644 roles/golang/README.md create mode 100644 roles/service-grafana/README.md create mode 100644 roles/service-influxdb/README.md create mode 100644 roles/service-nginx-meshviewer/README.md create mode 100644 roles/service-yanic/README.md create mode 100644 roles/yarn/README.md diff --git a/roles/git-repos/README.md b/roles/git-repos/README.md index 51f5acb..0744bcb 100644 --- a/roles/git-repos/README.md +++ b/roles/git-repos/README.md @@ -13,6 +13,8 @@ Diese Ansible role klont wichtige git Repositories. common_repos: name: # name des Repositories == Ordner Name repo_url: # HTTP-URL zum Repository + version: # Branch/Tag/Commit + force: # Update erzwingen ... ``` diff --git a/roles/golang/README.md b/roles/golang/README.md new file mode 100644 index 0000000..89adf83 --- /dev/null +++ b/roles/golang/README.md @@ -0,0 +1,11 @@ +# Ansible role golang + +Diese Ansible role installiert den Go Compiler. + +- installiert das Paket `golang-1.8` +- legt das Verzeichnis `$GOPATH` an +- legt /etc/profile.d/go.sh mit der Variable `$GOPATH` an + +## Benötigte Variablen + +- Variable `gopath` diff --git a/roles/network-batman/README.md b/roles/network-batman/README.md index 669922b..aed65d4 100644 --- a/roles/network-batman/README.md +++ b/roles/network-batman/README.md @@ -40,6 +40,8 @@ meshes: - Host Variable `magic` +- Host Variable `ffmwu_server_type` + ## MAC-Adressen Die MAC-Adressen der Interfaces werden aus dem IPv4-Subnetz sowie der `magic`-Nummer des Hosts berechnet. diff --git a/roles/network-fastd/README.md b/roles/network-fastd/README.md index 73bce32..a2a5f63 100644 --- a/roles/network-fastd/README.md +++ b/roles/network-fastd/README.md @@ -34,9 +34,11 @@ meshes: - Host Variable `magic` +- Host Variable `ffmwu_server_type` + ## MAC-Adressen -Die MAC-Adressen der Interfaces werden aus dem IPv4-Subnetz sowie der `magic`-Nummer des Hosts berechnet. +Die MAC-Adressen der Interfaces werden aus dem IPv4-Subnetz sowie der `magic`-Nummer des Hosts berechnet. x = ID der fastd-Instanz. -xxvpn-$mtu prefix: `02:2x` # x = ID der fastd-Instanz -xxigvpn-$mtu prefix: `02:3x` # x = ID der fastd-Instanz +- xxvpn-$mtu prefix: `02:2x` +- xxigvpn-$mtu prefix: `02:3x` diff --git a/roles/network-routing/README.md b/roles/network-routing/README.md index 98bf7bc..06b763c 100644 --- a/roles/network-routing/README.md +++ b/roles/network-routing/README.md @@ -22,15 +22,18 @@ meshes: ipv6_public: ``` -- List `sysctl_settings_routing` (Rollen-Variable) +- Listen `sysctl_settings_routing_basic` und `sysctl_settings_routing_gateway` (Rollen-Variablen) ``` -sysctl_settings_routing: +sysctl_settings_routing_(basic|gateway): - name: # sysctl-Parameter value: # zu setzender Wert ... -- Host Variable `ffrl_public_ipv4_nat` # Format ip-adresse/prefix -- Host Dictionary `ffrl_exit_server ``` +- Host Variable `ffrl_public_ipv4_nat` # Format ip-adresse/prefix + +- Host Dictionary `ffrl_exit_server` - Host Variable `magic` + +- Host Variable `ffmwu_server_type` diff --git a/roles/prerequisites/README.md b/roles/prerequisites/README.md index 5cd087a..8726864 100644 --- a/roles/prerequisites/README.md +++ b/roles/prerequisites/README.md @@ -16,3 +16,4 @@ Die folgenden Variablen werden über einen DNS Lookup gesetzt: - Variable `dns_host_ipv6_address` (Rollen-Variable) - Variable `dns_gate_num_cname` (Rollen-Variable) - Variable `dns_gate_icvpn_cname` (Rollen-Variable) +- Variable `ffmwu_server_type` diff --git a/roles/server-basic/README.md b/roles/server-basic/README.md index 5340846..8ab542c 100644 --- a/roles/server-basic/README.md +++ b/roles/server-basic/README.md @@ -12,4 +12,7 @@ Diese Ansible role installiert Pakete, die auf allen MWU-Server benötigt werden - Liste `packages` (Rollen Variable) - Variable `default_locale` (Rollen-Variable) + +## Optionale Variablen + - Variable `debian_apt_mirror` diff --git a/roles/service-grafana/README.md b/roles/service-grafana/README.md new file mode 100644 index 0000000..21cb407 --- /dev/null +++ b/roles/service-grafana/README.md @@ -0,0 +1,14 @@ +# Ansible role service-grafana + +Diese Ansible role installiert Grafana und legt den nginx vHost an. + +- fügt das APT Repo für Grafana hinzu +- installiert das Paket `grafana` +- schreibt grafana.ini +- schreibt grafana.conf +- aktiviert die systemd unit `grafana-server.service` + +## Benötigte Variablen +- Variable `http_grafana_internal` (Rollen Variable) +- Variable `http_grafana_external` (Rollen Variable) +- Variable `http_grafana_prefix` # string: Subdomain diff --git a/roles/service-influxdb/README.md b/roles/service-influxdb/README.md new file mode 100644 index 0000000..f982cc1 --- /dev/null +++ b/roles/service-influxdb/README.md @@ -0,0 +1,10 @@ +# Ansible role service-influxdb + +Diese Ansible role installiert InfluxDB. + +- fügt das APT Repo für InfluxDB hinzu +- installiert das Paket `influxdb` (apt) +- bindet die TCP Ports an localhost +- installiert das Paket `python-requests` (apt) +- installiert das Paket `python-influxdb` (pip) +- aktiviert die systemd unit `influxdb.service` diff --git a/roles/service-nginx-meshviewer/README.md b/roles/service-nginx-meshviewer/README.md new file mode 100644 index 0000000..7de4576 --- /dev/null +++ b/roles/service-nginx-meshviewer/README.md @@ -0,0 +1,46 @@ +# Ansible role service-nginx-meshviewer + +Diese Ansible role installert den Meshviewer und konfiguriert den nginx vHosts. + +- schreibt config.js +- schreibt meshviewer.conf +- legt Meschviewer Verzeichnis an +- installiert Abhängigkeiten via `yarn` +- baut den Meschviewer +- installert den Meshviewer + +## Benötigte Variablen + +- Variable `meshviewer_src` (Rollen Variable) +- Variable `meshviewer_path` (Rollen Variable) +- Variable `http_meshviewer_external` (Rollen Variable) +- Variable `http_meshviewer_internal` (Rollen Variable) +- Variable `http_meshviewer_prefix` # string: Subdomain +- Variable `http_domain_external` # string: Externe Freifunk MWU Domain +- Variable `http_domain_internal` # string: Interne Freifunk MWU Domain +- Dictionary `meshes` +``` +meshes: + - id: xx +... + site_code: # string + site_name: # string + sites_virtual: # (optinal) + ffxx: # string + +... + http_domain_external: # string: Externe Mesh Domain + http_domain_internal: # string: Interne Mesh Domain +``` + +- Dictionary `map_layers` (Rollen Variable) + +``` +map_layers: + - xxx: + name: # string + url: # string + max_zoom: # integer + attribution: # string +... +``` diff --git a/roles/service-nginx/README.md b/roles/service-nginx/README.md index 8b00cb7..47487a1 100644 --- a/roles/service-nginx/README.md +++ b/roles/service-nginx/README.md @@ -6,9 +6,10 @@ Diese Ansible role installiert und konfiguriert den Web Server nginx. - installiert nginx - schreibt nginx.conf - schreibt default.conf -- installiert die Standard MWU Gateway Webseite +- installiert die Standard MWU Server Webseite ## Benötigte Variablen - Variable `acme_server` +- Variable `ffmwu_server_type` - Variable `inventory_hostname_short` diff --git a/roles/service-yanic/README.md b/roles/service-yanic/README.md new file mode 100644 index 0000000..f56535c --- /dev/null +++ b/roles/service-yanic/README.md @@ -0,0 +1,23 @@ +# Ansible role service-yanic + +Diese Ansible role installiert Yanic. + +- legt den Benutzer und Gruppe für Yanic an +- legt das Yanic Verzeichnis aus +- legt die InfluxDB Datenbank für Yanic an +- schreibt yanic.conf +- schreibt yanic.service +- kompiliert und installiert Yanic +- aktiviert die systemd unit `yanic.service` + +# Benötigte Variablen + +- Variable `gopath` + +# Optionale Variablen + +- Variable `yanic_user` +- Variable `yanic_home` +- Variable `yanic_path` +- Variable `yanic_config` +- Variable `yanic_database` diff --git a/roles/yarn/README.md b/roles/yarn/README.md new file mode 100644 index 0000000..6546999 --- /dev/null +++ b/roles/yarn/README.md @@ -0,0 +1,6 @@ +# Ansible role yarn + +Diese Ansible role installiert die Yarn Paketverwaltung. + +- fügt das APT Repo für Yarn hinzu +- installiert das Paket `yarn`