README.md

README.md

@@ -64,6 +64,7 @@ Installiert das lokale Monitoring-Tool [Monit] mit einer Standard-Konfiguration
 * $monit_filesystems_config_template (optional) = Puppet-Pfad zu einem Template für die Konfiguration der Überwachung der Dateisysteme (Default:  ```'ubuntu_server/etc/monit/conf.d/filesystems.erb'```). Das Default-Template ersetllt Einträge für alle lokalen und NFS-Dateisysteme.
 * $monit_config_dir (optional) = Puppet-Pfad zu einem Verzeichnis mit weiteren Konfigurationsdateien für zusätzliche Tests (Default: ```'puppet:///modules/ubuntu_server/etc/monit/conf.d'```)
 * $docker_check (optional) = Falls ```true``` wird ein Skript installiert und ein Test eingerichtet, der auf gestoppte Container prüft. (Default: ```false```)
+* $puppet_check (optional) = Fall ```true``` wird ein Test installiert, der ```last_run_report.yaml``` des Puppet Agent auf Fehler und ein Alter größer als 1 Stunde prüft. (Default: ```false```)
 
 [Monit]: https://mmonit.com/monit/#about
 
@@ -77,7 +78,61 @@ Deaktiviert IPv6 im Kernel durch ```sysctl```.
 
 ### ubuntu_server::nrpe
 
-* $nrpe_local_cfg = Hauptkonfiguration für den NRPE-Daemon (Default: ```'puppet:///modules/ubuntu_server/etc/nagios/nrpe_local.cfg'```)
-* $nrpe_scripts = Verzeichnis mit zusätzlichen Skripts, die durch NRPE für Tests verwendet werden können. (Default: ```'puppet:///modules/ubuntu_server/opt/nagios'```)
-* $daemon_options = zusätzliche Optionen für den Aufruf des Daemon (Default: ```'--no-ssl'```)
-* $enable_sudo_docker = Aktiviert einen Check, der auf gestoppte Docker-Containern prüft. Hierzu wird Nagios per sudo das Ausführen des Skripts erlaubt. (Default: ```false```)
+Installiert NRPE-Daemon und Tests.
+
+* $nrpe_local_cfg (optional) = Hauptkonfiguration für den NRPE-Daemon (Default: ```'puppet:///modules/ubuntu_server/etc/nagios/nrpe_local.cfg'```)
+* $nrpe_scripts (optional) = Verzeichnis mit zusätzlichen Skripts, die durch NRPE für Tests verwendet werden können. (Default: ```'puppet:///modules/ubuntu_server/opt/nagios'```)
+* $daemon_options (optional) = zusätzliche Optionen für den Aufruf des Daemon (Default: ```'--no-ssl'```)
+* $enable_sudo_docker (optional) = Aktiviert einen Check, der auf gestoppte Docker-Containern prüft. Hierzu wird Nagios per sudo das Ausführen des Skripts erlaubt. (Default: ```false```)
+
+### ubuntu_server::ntp
+
+* $gwdg_ntp_servers (optional) = Array mit NTP-Server. (Default: NTP-Server der GWDG)
+
+### ubuntu_server::openssh_server
+
+Installiert OpenSSH-Server und schränkt Zugriffe auf Mitglieder der Gruppe ```root``` (Default) ein, entfernt einige schwache Cipher.
+
+* $port (optional) = Port des SSH-Servers. (Default: ```22```)
+* $groups_only (optional) = Einschränkung der SSH-Anmeldung auf folgende Gruppen als String. (Default: ```root```)
+* $authorized_keys (optional) = ```false``` oder ein Puppet-Pfad zu einer ```authorized_keys```-Datei für den ```root```-Benutzer. (Default: ```false```)
+
+### ubuntu_server::postfix
+
+Einfach Installation und Konfiguration von Postfix, primär zum Aufnehmen und Weiterleiten von Systemnachrichten.
+
+* $root_emails = Array mit Empängern für die Weiterleitungen von Nachrichten an ```root```.
+* $relayhost (optional) = Emailserver, der die Weiterleitungen engegen nimmt. (Default: ```mailer.gwdg.de```)
+* $generic_maps (optional) = Mapping für das Umschrieben von ausgehenden Emails, siehe [Postfix-Dokumentation](http://www.postfix.org/ADDRESS_REWRITING_README.html#generic). (Default = ```puppet:///modules/ubuntu_server/etc/postfix/generic_maps```)
+
+### ubuntu_server::puppet_agent
+
+Konfiguriert vorhandenen Puppet-Agent für die Ausführung durch ```cron```. Zusätzlich werden per ```rsyslog``` die Meldungen des Puppet-Agents in ein eigenes Log geleitet.
+
+* $nightly_only (optional) = Begrenzt die Zeiten im Cron-Job auf Stunden in der Nacht zur Ausführung von Puppet-Agent. (Default: ```false```)
+* $on_reboot_once (optional) = Legt einen zusätzlichen Cron-job an, der nach dem Boot den Puppet-Agent ausführt. (Default: true)
+
+### ubuntu_server::remove_pkg
+
+Entfernt einige, für den normalen Server-Betrieb unnötige Standard-Pakete von Ubuntu, z.B. ```'mpt-status','avahi-*','landscape-common','landscape-client'```.
+
+### ubuntu_server::ring_parameters
+
+Defined Type für ```ubuntu_server::ethtool_setup```.
+
+### ubuntu_server::simple_security
+
+Installiert Tools für die Sicherheit des Servers, z.B. ```'fail2ban','molly-guard'```.
+
+### ubuntu_server::sysctl_hung_task_panic
+
+Konfiguriert Kernel so, dass bei nach 120 Blockade eines Tasks eine Kernel-Panik ausgelöst wird und dass eine Kernel-Panik zum Neustart des Hosts führt ([siehe auch](http://www.nico.schottelius.org/blog/reboot-linux-if-task-blocked-for-more-than-n-seconds/)).
+
+### ubuntu_server::unattended_upgrades
+
+Installiert das Apt-Modul für automatische Updates. Die Konfiguration installiert Updates aus ofizillen Ubuntu-Quellen und Docker, wobei aber ```docker-engine``` nicht automatisch aktualisert wird.
+
+* $automatic_reboot (optional) = Aktiviert automatischen Neustart in der Nacht, falls dies für Aktualisierungen notwendig ist. (Default: ```false```)
+* $autoremove (optional) = Entfernt nicht mehr benötigte Pakete, z.B. alte Kernel. (Default: ```true```)
+* $allowed_origins (optional) = Array mit Quellenangaben für Apt, aus denen Updates installiert werden dürfen. (Default: ```["\${distro_id}:\${distro_codename}-updates","LP-PPA-ubuntu-lxc-lxd-stable:\${distro_codename}","Docker:ubuntu-\${distro_codename}","Puppetlabs:\${distro_codename}"]```)
+* $package_blacklist (optional) = ein Array mit Paketnamen, die von automatischen Updates ausgeschlossen werden. (Default: 'docker-engine')