Skip to content
This repository was archived by the owner on Dec 14, 2022. It is now read-only.

Commit 259a60d

Browse files
author
Chris Wiechmann
authored
Update UPDATE.md
1 parent e9d140f commit 259a60d

File tree

1 file changed

+23
-15
lines changed

1 file changed

+23
-15
lines changed

UPDATE.md

Lines changed: 23 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -65,22 +65,21 @@ On the other hand, the API builder Docker image, as a central component of the s
6565

6666
## Upgrade components
6767

68-
### Filebeat
69-
70-
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 application. If it does not match, Logstash will exit with an error message.
71-
Even if you run Filebeat as a native service, you have to copy the configuration (`filebeat/filebeat.yml`) from the release into your configuration.
68+
The following example shows how to load/unpack release 4.0.2 and apply your current configuration from, for example, version 3.2.0. Regardless of which components have changed, you should install the same release package and take over your configuration on all machines to avoid confusion.
7269

73-
The following steps illustrates an update to version 3.2.0 using the docker-compose approach:
7470
```
75-
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
76-
cd axway-apim-elk-v3.2.0
77-
cp ~/axway-apim-elk-v3.1.0/.env .
71+
# Perform these steps on all belonging machines
72+
# Get and extract the release package
73+
wget --no-check-certificate https://github.com/Axway-API-Management-Plus/apigateway-openlogging-elk/releases/download/v4.0.2/axway-apim-elk-v4.0.2.tar.gz -O - | tar -xvz
74+
# The following directory has been created
75+
cd axway-apim-elk-v4.0.2
76+
# Take over existing configuration from the previous version
77+
cp ~/axway-apim-elk-v3.2.0/.env .
78+
# Also copy existing certificates, scripts, extra config-files from the previous version
7879
cp ~/axway-apim-elk-v3.1.0/config/all-my-custom-certificates ./config
79-
docker-compose -f filebeat/docker-compose.filebeat.yml stop
80-
docker-compose -f filebeat/docker-compose.filebeat.yml up -d
8180
```
8281

83-
If you have deployed the solution on a Kubernetes-Cluster using Helm read [here](helm/README.md) for more information.
82+
You can then update each component as described below.
8483

8584
### API-Builder/Logstash/Memcached
8685

@@ -90,17 +89,26 @@ API Builder, Logstash and Memcache work as a tight unit and should be stopped, u
9089

9190
The following steps illustrates an update to version 3.2.0:
9291
```
93-
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
94-
cd axway-apim-elk-v3.2.0
95-
cp ~/axway-apim-elk-v3.1.0/.env .
96-
cp ~/axway-apim-elk-v3.1.0/config/all-my-custom-certificates ./config
9792
docker-compose stop
9893
docker-compose up -d
9994
```
10095
Repeat these steps on all machines running Logstash/API-Builder/Memcache.
10196

10297
If you have deployed the solution on a Kubernetes-Cluster using Helm read [here](helm/README.md) for more information.
10398

99+
### Filebeat
100+
101+
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 application. If it does not match, Logstash will exit with an error message.
102+
Even if you run Filebeat as a native service, you have to copy the configuration (`filebeat/filebeat.yml`) from the release into your configuration.
103+
104+
The following steps illustrates an update to version 3.2.0 using the docker-compose approach:
105+
```
106+
docker stop filebeat
107+
docker-compose -f filebeat/docker-compose.filebeat.yml up -d
108+
```
109+
110+
If you have deployed the solution on a Kubernetes-Cluster using Helm read [here](helm/README.md) for more information.
111+
104112
### ANM config
105113

106114
Please follow the instructions to [setup the Admin-Node-Manager](README.md#setup-admin-node-manager) based on the most recent Policy-Fragment shipped with the release. Please make sure that they take their own certificates with them.

0 commit comments

Comments
 (0)