Added more documentation and removed the Logstash sockets

option.

Author: Chris Wiechmann

.github/workflows/logstash.yml

@@ -36,10 +36,10 @@ jobs:
       run: |
         echo Using API_BUILDER_URL: $API_BUILDER_URL
         echo Using MEMCACHED: $MEMCACHED
-        ./logstash-filter-verifier --diff-command="diff -y" --sockets --sockets-timeout=240s --keep-env=API_BUILDER_URL --keep-env=MEMCACHED ./logstash/test/http/test-tracemessages.json ./logstash/pipelines/TraceMessagesPipeline.conf
-        ./logstash-filter-verifier --diff-command="diff -y" --sockets --sockets-timeout=240s --keep-env=API_BUILDER_URL --keep-env=MEMCACHED ./logstash/test/http/test-events.json ./logstash/pipelines/EventsPipeline.conf
-        ./logstash-filter-verifier --diff-command="diff -y" --sockets --sockets-timeout=240s --keep-env=API_BUILDER_URL --keep-env=MEMCACHED ./logstash/test/http/test-opentrafficlog.json ./logstash/pipelines/OpenTrafficPipeline.conf
-        ./logstash-filter-verifier --diff-command="diff -y" --sockets --sockets-timeout=240s --keep-env=API_BUILDER_URL --keep-env=MEMCACHED ./logstash/test/filetransfer/test-opentrafficlog-filetransfer.json ./logstash/pipelines/OpenTrafficPipeline.conf
+        ./logstash-filter-verifier --diff-command="diff -y" --keep-env=API_BUILDER_URL --keep-env=MEMCACHED ./logstash/test/http/test-tracemessages.json ./logstash/pipelines/TraceMessagesPipeline.conf
+        ./logstash-filter-verifier --diff-command="diff -y" --keep-env=API_BUILDER_URL --keep-env=MEMCACHED ./logstash/test/http/test-events.json ./logstash/pipelines/EventsPipeline.conf
+        ./logstash-filter-verifier --diff-command="diff -y" --keep-env=API_BUILDER_URL --keep-env=MEMCACHED ./logstash/test/http/test-opentrafficlog.json ./logstash/pipelines/OpenTrafficPipeline.conf
+        ./logstash-filter-verifier --diff-command="diff -y" --keep-env=API_BUILDER_URL --keep-env=MEMCACHED ./logstash/test/filetransfer/test-opentrafficlog-filetransfer.json ./logstash/pipelines/OpenTrafficPipeline.conf
       env:
         API_BUILDER_URL: 'http://localhost:8080'
         MEMCACHED: 'localhost:11211'

certificates/README.md

@@ -0,0 +1,4 @@
+Certificates in this folder will be made available to the Docker-Containers by a mount 
+and configured in the .env file.  
+If you would to use your own certificates and keys, place them in this directory and 
+adjust the .env file accordingly.

elasticsearch/config/elasticsearch.yml

@@ -13,6 +13,7 @@ bootstrap.memory_lock: true
 # Enable security in general
 xpack.security.enabled: true
 
+# Initially provide anonymous access, which can be changed to user based AuthN.
 xpack.security.authc.anonymous.roles: kibana_admin,  superuser, beats_system, logstash_system
 xpack.security.authc.anonymous.username: anonymous
 

filebeat/filebeat.yml

@@ -1,3 +1,8 @@
+# Please don't change this file as it is supposed to be overwritten as 
+# part of fixes or enhancements.
+#
+# If you are missing a certain feature or discover a bug, please raise an issue instead:
+# https://github.com/Axway-API-Management-Plus/apigateway-openlogging-elk/issues
 name: Filebeat ${GATEWAY_NAME:"API-Gateway"}
 filebeat.inputs:
 - type: log

logstash/config/pipelines.yml

@@ -1,3 +1,8 @@
+# Please don't change this file as it is supposed to be overwritten as 
+# part of fixes or enhancements.
+#
+# If you are missing a certain feature or discover a bug, please raise an issue instead:
+# https://github.com/Axway-API-Management-Plus/apigateway-openlogging-elk/issues
 - pipeline.id: BeatsInput
   path.config: "pipelines/BeatsInputPipeline.conf"
   pipeline.workers: 4

logstash/index_templates/DO-NOT-CHANGE-THESE-FILES.txt

@@ -0,0 +1,5 @@
+In order to support and upgrade the project, please don't change files in this directory as they 
+are supposed to be improved/enhanced as part of overall project improvement!
+
+If you are missing a certain feature or discover a bug, please raise an issue instead:
+https://github.com/Axway-API-Management-Plus/apigateway-openlogging-elk/issues

logstash/pipelines/DO-NOT-CHANGE-THESE-FILES.txt

@@ -0,0 +1,5 @@
+In order to support and upgrade the project, please don't change files in this directory as they 
+are supposed to be improved/enhanced as part of overall project improvement!
+
+If you are missing a certain feature or discover a bug, please raise an issue instead:
+https://github.com/Axway-API-Management-Plus/apigateway-openlogging-elk/issues