Prepare to release version 4.1.0

Author: Chris Wiechmann

CHANGELOG.md

@@ -4,12 +4,13 @@ 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] 
+## [4.1.0] 2022-01-21
 ### Changed
 - Updated default Elastic-Stack version from 7.16.2 to 7.16.3 which delivers log4j 2.17.1
 - No longer possible to start an Elasticsearch-Node that is not part of ELASTICSEARCH_NODES [#155](https://github.com/Axway-API-Management-Plus/apigateway-openlogging-elk/issues/155)
 - Helm chart deploys 2 Kibana replicas by default instead of 1
-- Updated API-Builder to version Caracas
+- Adjusted ILM-Policies to get more suiteable standard index lifecycle [#162](https://github.com/Axway-API-Management-Plus/apigateway-openlogging-elk/issues/162)
+- Updated API-Builder to version Exeter
 - Updated API-Builder custom flow node libraries
 
 ### Added

DEVELOPMENT.MD

@@ -1,17 +1,21 @@
 ## Create a release
 
-1. Merge develop into master
-- make sure no .only or debugger instruction is still in the code
+### 1. Merge develop into master
+  - make sure no .only or debugger instruction is still in the code
 
-2. Bump version number
+### 2. Update Helm dependencies
+- helm repo update 
+- helm dep update
 
+### 3. Bump version number
 - helm/values.yaml
-  - `"imageTag": "v3.0.0",`
+  - Set the `"imageTag": "v3.0.0",` for APIBuilder4Elastic
 - helm/Chart.yaml
-  - `"version": "v3.0.0",`
-  - `"appVersion": "v3.0.0",`
+  - Set the Helm-Chart `"version": "v3.0.0",`
+  - Set the App `"appVersion": "v3.0.0",` to the same version number
 - helm/README.md
-  - Check the versions
+  - Replace previous version with new version
+  - For example:
   - `helm install -n apim-e .... teway-openlogging-elk/releases/download/v3.0.0/helm-chart-apim4elastic-v3.0.0.tgz`
 - docker-compose.yml
   - `image: cwiechmann/apibuilder4elastic:v2.0.0`
@@ -23,14 +27,14 @@
 - README.md
   - `"version": "v2.0.0",`
 
-3. Modify the CHANGELOG.md
+### 4. Modify the CHANGELOG.md
 - Add/Verify recent changes
 - Set the release version and date
 
-4. Create the release
+### 5. Create the release
 - Create a new release on Github with the tag name: e.g. v2.0.2
 
-5. Merge back master to developer for next development iteration
+### 6. Merge back master to developer for next development iteration
 
 ## Run tests
 

UPDATE.md

@@ -37,7 +37,7 @@ On the other hand, the API builder Docker image, as a central component of the s
 
 | Ver   | API-Builder                        | Logstash                           | Memcached                          | Filebeat      | ANM-Config      | Dashboards      | Params          |Elastic-Config      | ELK-Ver.| Notes      |
 | :---  | :---:                              | :---:                              | :---:                              | :---:         | :---:           | :---:           | :---:           |:---:               | :---:   | :---       |
-| 4.1.0 | [X](#api-builderlogstashmemcached) | -                                  | -                                  | -             | -               | -               | [X](#parameters)|-                   | [7.16.3](#update-elastic-stack-version)  | Unreleased |
+| 4.1.0 | [X](#api-builderlogstashmemcached) | -                                  | -                                  | -             | -               | -               | [X](#parameters)|[X](#elastic-config)| [7.16.3](#update-elastic-stack-version)  |          |
 | 4.0.3 | -                                  | -                                  | -                                  | -             | -               | -               | -               |-                   | [7.16.2](#update-elastic-stack-version)  |            |
 | 4.0.2 | -                                  | -                                  | -                                  | -             | -               | -               | -               |-                   | [7.16.1](#update-elastic-stack-version)  | See #154   |
 | 4.0.1 | -                                  | -                                  | -                                  | -             | -               | -               | -               |-                   | [7.16.1](#update-elastic-stack-version)  |            |

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": "v4.0.3",
+	"version": "v4.1.0",
 	"author": "Chris Wiechmann",
 	"email": "cwiechmann@axway.com",
 	"url": "https://axway.com",

docker-compose.yml

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

helm/Chart.lock

@@ -1,18 +1,18 @@
 dependencies:
 - name: logstash
   repository: https://helm.elastic.co
-  version: 7.16.2
+  version: 7.16.3
 - name: filebeat
   repository: https://helm.elastic.co
-  version: 7.16.2
+  version: 7.16.3
 - name: elasticsearch
   repository: https://helm.elastic.co
-  version: 7.16.2
+  version: 7.16.3
 - name: kibana
   repository: https://helm.elastic.co
-  version: 7.16.2
+  version: 7.16.3
 - name: apm-server
   repository: https://helm.elastic.co
-  version: 7.16.2
-digest: sha256:19dd7196acdfecab08ba9fce400d23ff0422edaf28d354923677ee5c1b4ddcd0
-generated: "2022-01-14T09:14:46.2144341+01:00"
+  version: 7.16.3
+digest: sha256:8259e4669385b60f221b98f5b13780bc9cfffcff35d28f79988be68a49ba4cf5
+generated: "2022-01-21T08:07:22.0239306+01:00"

helm/Chart.yaml

@@ -4,28 +4,28 @@ description: A Helm chart for the Axway APIM Elasticsearch integration.
 
 type: application
 
-version: 4.0.3
+version: 4.1.0
 
-appVersion: "4.0.3"
+appVersion: "4.1.0"
 
 dependencies:
   - name: logstash
-    version: "7.16.2"
+    version: "7.x.x"
     repository: https://helm.elastic.co
     condition: logstash.enabled
   - name: filebeat
-    version: "7.16.2"
+    version: "7.x.x"
     repository: https://helm.elastic.co
     condition: filebeat.enabled
   - name: elasticsearch
-    version: "7.16.2"
+    version: "7.x.x"
     repository: https://helm.elastic.co
     condition: elasticsearch.enabled
   - name: kibana
-    version: "7.16.2"
+    version: "7.x.x"
     repository: https://helm.elastic.co
     condition: kibana.enabled
   - name: apm-server
-    version: "7.16.2"
+    version: "7.x.x"
     repository: https://helm.elastic.co
     condition: apm-server.enabled

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/v4.0.3/helm-chart-apim4elastic-v4.0.3.tgz
+helm install -n apim-elk -f myvalues.yaml axway-elk https://github.com/Axway-API-Management-Plus/apigateway-openlogging-elk/releases/download/v4.1.0/helm-chart-apim4elastic-v4.1.0.tgz
 ```
 👉 __Please note:__ The Helm Release-Name: __axway-elk__ is mandatory. Read [here](#why-helm-release-name-axway-elk) why.  
 
@@ -94,7 +94,7 @@ You may run the following commands to check the status of the deployment, pods,
 // Check the installed release
 helm list -n apim-elk
 NAME            NAMESPACE       REVISION        UPDATED                                 STATUS          CHART                           APP VERSION   
-axway-elk       apim-elk        1               2021-05-03 14:22:08.9325287 +0200 CEST  deployed        apim4elastic-4.0.3              4.0.3
+axway-elk       apim-elk        1               2021-05-03 14:22:08.9325287 +0200 CEST  deployed        apim4elastic-4.1.0              4.1.0
 
 // Check the pods, with Elasticsearch and Kibana enabled
 kubectl get pods -n apim-elk
@@ -542,7 +542,7 @@ Watch this video to see a demonstration how to update the Elastic-Stack on Kuber
 
 Example how to upgrade an existing release:  
 ```
-helm upgrade -n apim-elk -f myvalues.yaml axway-elk https://github.com/Axway-API-Management-Plus/apigateway-openlogging-elk/releases/download/v4.0.3/helm-chart-apim4elastic-v4.0.3.tgz
+helm upgrade -n apim-elk -f myvalues.yaml axway-elk https://github.com/Axway-API-Management-Plus/apigateway-openlogging-elk/releases/download/v4.1.0/helm-chart-apim4elastic-v4.1.0.tgz
 ```
 
 ## Required resources

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: "v4.0.3"
+  imageTag: "v4.1.0"
   imagePullPolicy: IfNotPresent
   nameOverride: "apibuilder4leastic"
   fullnameOverride: "Axway API-Builder4Elastic"
@@ -214,7 +214,7 @@ apibuilder4elastic:
 logstash:
   enabled: true
   # You may override the standard version
-  imageTag: "7.16.3"
+  # imageTag: "7.16.3"
   # The following secrets are used to generate the secret <releaseName>-apim4elastic-logstash-secret
   # If disabled the secret is not created and you have to provide them in your own secret and 
   # use the envFrom.secretRef below to make it available for Logstash. 
@@ -322,7 +322,7 @@ logstash:
 elasticsearch:
   enabled: true
   # You may override the standard version
-  imageTag: "7.16.3"
+  # imageTag: "7.16.3"
   fullnameOverride: "axway-elk-apim4elastic-elasticsearch"
   clusterName: "axway-apim"
   replicas: 3
@@ -435,7 +435,7 @@ elasticsearch:
 kibana:
   enabled: true
   # You may override the standard version
-  imageTag: "7.16.3"
+  # imageTag: "7.16.3"
   fullnameOverride: "axway-elk-apim4elastic"
   replicas: 2
   # Username and Password for Kibana to send monitoring events to Elasticsearch
@@ -524,7 +524,7 @@ filebeat:
   # Deploy Filebeat or not
   enabled: false
   # You may override the standard version
-  imageTag: "7.16.3"
+  # imageTag: "7.16.3"
   # Set this to true, to create the filebeat ConfigMaps & Secret including the filebeat.yaml 
   # This is useful, if you would like to run filebeat as a sidecar along with the API-Gateways and just 
   # reference these config maps
@@ -735,7 +735,7 @@ filebeat:
 apm-server:
   enabled: false
   # You may override the standard version
-  imageTag: "7.16.3"
+  # imageTag: "7.16.3"
   # Required for the internal stack monitoring to work with the APM-Server
   elasticsearchClusterUUID: ""