diff --git a/README.md b/README.md index 448af50b6efebf62dd2a6d678c14bbc309be21ac..518219c0fa2986d01cb7cc1023398079840b5b6e 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,56 @@ -# DualStackDemo -## Edit test +# DualStackDemo für Docker stack mit zentralen Fluentd Logger + +## Beschreibung +Die Demo besteht aus 2 Docker Stacks mit je 2 Services: +* Elasticsearch Stack mit folgenden Services : Kibana und Elasticsearch +* NGinx Stack mit folgenden Services : Fluentd ( Logger) und Nginx + +Der Elasticsearch Stack ist in docker-compose-es-stack.yml definiert. +Der Nginx Stack benutzt neben docker-compose.yml ( Fluentd Service ) auch docker-compose.override.yml in der der +NGinx Service definiert wird. Nebenbei demonstriert der NGINX Stack das Sharing von Docker Compose File: +* [Docker: Share Compose File Configurations](https://docs.docker.com/compose/extends/) + +## Installation +Voraussetzung: Einloggen im Netz der TH Nürnberg bzw. eine VPN Verbindung zu öffnen. + +### Lokaler Build +Das Projekt kann mit Docker selbst gebaut werden. Es ist nur docker-compose erforderlich. Alle nötigen Build Tools werden bereitgestellt und es muss keine Java, NodeJS oder Angular Installation lokal vorhanden sein. +Mit dem nachfolgenden docker-compose build werden der NGinx und der Fluentd container gebaut. + + docker-compose build + + +## Starten der Demo +#### Starten des Elasticsearch Stacks +Zum Starten folgenden Befehl ausführen: + + docker stack deploy --compose-file docker-compose-es-stack.yml ElastikSearchStack + +####Starten des Nginx/Fluentd Stacks + + docker stack deploy --compose-file docker-compose.yml --compose-file docker-compose.override.yml NginxTesting + + +## Nutzung +Nach dem Start eine nicht vorhanden Webseite in Browser aufrufen um Nginx Log Entries zu erzeugen +* http://localhost/Invaild_Page + +#### Einloggen über Kibana +* http://localhost:5601/ + +#### Kibana Index Pattern anlegen und anzeigen + * Top Level Menu Kibana -> Index Pattern -> Create Index Pattern + * Index pattern: fluentd* + * Time Filter field name : @timestamp + +#### Kibana Log Entries anzeigen + * Discover anwählen und fluentd* als Index pattern auswählen + * Kibana sollte jetzt sowohl einen Error Log Entry sowie eine Accesslog Entry anzeigen + + + +## Beenden +Beenden der Demo + + docker stack rm NginxTesting + docker stack rm ElastikSearchStack