Prepare to release v3.2.0

Author: Chris Wiechmann

CHANGELOG.md

@@ -4,10 +4,16 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
-## [Unreleased]
+## [3.2.0] 2021-06-22
 ### Fixed
 - Trace message in Traffic-Monitor is truncated [#112](https://github.com/Axway-API-Management-Plus/apigateway-openlogging-elk/issues/112)
 - API-Manager User looked up at API-Manager even if external HTTP-Based AuthZ is configured [#111](https://github.com/Axway-API-Management-Plus/apigateway-openlogging-elk/issues/111)
+- Custom-Properties in Traffic-Details Index are not indexed as they are missing in the Index-Template [#115](https://github.com/Axway-API-Management-Plus/apigateway-openlogging-elk/issues/115)
+- EMT-Mode - API-Gateway-Traffic-Monitor don't show traffic when Pod is recreated [#114](https://github.com/Axway-API-Management-Plus/apigateway-openlogging-elk/issues/114)
+- External-HTTP Authorization - Traffic-Details in Traffic-Monitor not working [#113](https://github.com/Axway-API-Management-Plus/apigateway-openlogging-elk/issues/113)
+
+### Changed
+- Custom-Properties type custom now additionally indexed with type keyword [#116](https://github.com/Axway-API-Management-Plus/apigateway-openlogging-elk/issues/116)
 
 ## [3.1.0] 2021-05-13
 ### Changed

README.md

@@ -151,7 +151,7 @@ After this configuration has been done, Open-Traffic log-files will be created b
 
 Please download and extract the release package from the GitHub project onto your machine(s):  
 ```
-wget --no-check-certificate https://github.com/Axway-API-Management-Plus/apigateway-openlogging-elk/releases/download/v3.1.0/axway-apim-elk-v3.1.0.tar.gz -O - | tar -xvz
+wget --no-check-certificate https://github.com/Axway-API-Management-Plus/apigateway-openlogging-elk/releases/download/v3.2.0/axway-apim-elk-v3.2.0.tar.gz -O - | tar -xvz
 ```
 To simplify updates it is recommended to create a Symlink-Folder and finally rename the provided file `env-sample` to `.env`.  
 ```

UPDATE.md

@@ -51,6 +51,7 @@ On the other hand, the API builder Docker image, as a central component of the s
 | 2.4.2 | [X](#api-builderlogstashmemcached) | -                                  | -                                  | -             | -               | -               | -               |[X](#elastic-config)| 7.10.0  |            |
 | 3.0.0 | [X](#api-builderlogstashmemcached) | -                                  | -                                  | -             | -               | -               | [X](#parameters)|-                   | 7.12.1  |            |
 | 3.1.0 | [X](#api-builderlogstashmemcached) | -                                  | -                                  | -             | -               | -               | -               |-                   | 7.12.1  |            |
+| 3.2.0 | [X](#api-builderlogstashmemcached) | -                                  | -                                  | -             | -               | -               | -               |[X](#elastic-config)| 7.12.1  |            |
 
 ### Update from Version 1.0.0
 
@@ -63,32 +64,36 @@ If you are upgrading from Release 1.0.0 and encounter problems, please open an i
 If Filebeat changes with a version, you must update the corresponding configuration on all your API Gateway instances. It is recommended to update Filebeat as the first component, because the Filebeat configuration version is checked by the API builder process. If it does not match, Logstash will exit with an error message.
 Even if you run Filebeat as a native service, you have to copy the configuration (`filebeat/filebeat.yml`) from the release into your configuration.
 
-The following steps illustrates an update to version 2.0.2:
+The following steps illustrates an update to version 3.2.0 using the docker-compose approach:  
 ```
-wget --no-check-certificate https://github.com/Axway-API-Management-Plus/apigateway-openlogging-elk/releases/download/v2.0.2/axway-apim-elk-v2.0.2.tar.gz -O - | tar -xvz
-cd axway-apim-elk-v2.0.2
-cp ~/axway-apim-elk-v2.0.0/.env .
-cp ~/axway-apim-elk-v2.0.0/config/all-my-custom-certificates ./config
+wget --no-check-certificate https://github.com/Axway-API-Management-Plus/apigateway-openlogging-elk/releases/download/v3.2.0/axway-apim-elk-v3.2.0.tar.gz -O - | tar -xvz
+cd axway-apim-elk-v3.2.0
+cp ~/axway-apim-elk-v3.1.0/.env .
+cp ~/axway-apim-elk-v3.1.0/config/all-my-custom-certificates ./config
 docker-compose -f filebeat/docker-compose.filebeat.yml stop
 docker-compose -f filebeat/docker-compose.filebeat.yml up -d
 ```
 
+If you have deployed the solution on a Kubernetes-Cluster using Helm read [here](helm/README.md) for more information.
+
 ### API-Builder/Logstash/Memcached
 
 If Filebeat should be updated with one of the releases that are between the current one and the new one, then please [update Filebeat](#filebeat) in advance.
 
 API Builder, Logstash and Memcache work as a tight unit and should be stopped, updated together if possible. Please note, that changes to Logstash do not mean that the Logstash version has changed, but that the Logstash pipeline configuration has changed. To activate these changes the new release must be used to start Logstash.  
 
-The following steps illustrates an update to version 2.0.2:
+The following steps illustrates an update to version 3.2.0:
 ```
-wget --no-check-certificate https://github.com/Axway-API-Management-Plus/apigateway-openlogging-elk/releases/download/v2.0.2/axway-apim-elk-v2.0.2.tar.gz -O - | tar -xvz
-cd axway-apim-elk-v2.0.2
-cp ~/axway-apim-elk-v2.0.0/.env .
-cp ~/axway-apim-elk-v2.0.0/config/all-my-custom-certificates ./config
+wget --no-check-certificate https://github.com/Axway-API-Management-Plus/apigateway-openlogging-elk/releases/download/v3.2.0/axway-apim-elk-v3.2.0.tar.gz -O - | tar -xvz
+cd axway-apim-elk-v3.2.0
+cp ~/axway-apim-elk-v3.1.0/.env .
+cp ~/axway-apim-elk-v3.1.0/config/all-my-custom-certificates ./config
 docker-compose stop
 docker-compose up -d
 ```
-Repeat these steps on all machines running Logstash/API-Builder/Memcache.
+Repeat these steps on all machines running Logstash/API-Builder/Memcache.  
+
+If you have deployed the solution on a Kubernetes-Cluster using Helm read [here](helm/README.md) for more information.
 
 ### ANM config
 

apibuilder4elastic/package.json

@@ -2,7 +2,7 @@
 	"name": "apibuilder4elastic",
 	"description": "This API-Builder project provides an ELK-Based Traffic-Monitor API.",
 	"main": "app.js",
-	"version": "v3.1.0",
+	"version": "v3.2.0",
 	"author": "Chris Wiechmann",
 	"email": "cwiechmann@axway.com",
 	"url": "https://axway.com",

docker-compose.yml

@@ -56,7 +56,7 @@ services:
 
   # This is the API-Builder project exposing the API-Gateway Manager REST-API
   apibuilder4elastic:
-    image: cwiechmann/apibuilder4elastic:v3.1.0
+    image: cwiechmann/apibuilder4elastic:v3.2.0
     restart: on-failure:10
     container_name: apibuilder4elastic
     environment:

helm/Chart.yaml

@@ -4,9 +4,9 @@ description: A Helm chart for the Axway APIM Elasticsearch integration.
 
 type: application
 
-version: 3.1.0
+version: 3.2.0
 
-appVersion: "3.1.0"
+appVersion: "3.2.0"
 
 dependencies:
   - name: logstash

helm/README.md

@@ -85,7 +85,7 @@ kubectl apply -n apim-elk -f https://raw.githubusercontent.com/Axway-API-Managem
 
 With Elasticsearch volumes and your `myvalues.yaml` file in place, you can start the installation:  
 ```
-helm install -n apim-elk -f myvalues.yaml axway-elk https://github.com/Axway-API-Management-Plus/apigateway-openlogging-elk/releases/download/v3.1.0/helm-chart-apim4elastic-v3.1.0.tgz
+helm install -n apim-elk -f myvalues.yaml axway-elk https://github.com/Axway-API-Management-Plus/apigateway-openlogging-elk/releases/download/v3.2.0/helm-chart-apim4elastic-v3.2.0.tgz
 ```
 👉 __Please note:__ The Helm Release-Name: __axway-elk__ is mandatory. Read [here](#why-helm-release-name-axway-elk) why.  
 

helm/values.yaml

@@ -25,7 +25,7 @@ apibuilder4elastic:
   # Enables the APIBuilder4Elastic, which is required for the solution to work. So very unlikely to disable
   enabled: true
   image: "cwiechmann/apibuilder4elastic"
-  imageTag: "v3.1.0"
+  imageTag: "v3.2.0"
   imagePullPolicy: IfNotPresent
   nameOverride: "apibuilder4leastic"
   fullnameOverride: "Axway API-Builder4Elastic"