update READMEs

This commit is contained in:
Julian Labus 2018-09-12 16:30:28 +02:00
parent 3e2b02cfd5
commit 8b81eb6d7e
No known key found for this signature in database
GPG key ID: 8AF209F2C6B3572A
13 changed files with 132 additions and 8 deletions

View file

@ -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
...
```

11
roles/golang/README.md Normal file
View file

@ -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`

View file

@ -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.

View file

@ -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`

View file

@ -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`

View file

@ -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`

View file

@ -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`

View file

@ -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

View file

@ -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`

View file

@ -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
...
```

View file

@ -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`

View file

@ -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`

6
roles/yarn/README.md Normal file
View file

@ -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`