You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Dec 14, 2022. It is now read-only.
Copy file name to clipboardExpand all lines: UPDATE.md
+35-28Lines changed: 35 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -120,73 +120,80 @@ Sometimes it may be necessary to include newly introduced parameters in your `.e
120
120
121
121
The solution ships the latest available Elastic version with new releases. However, this does not force you to update to the appropriate Elastic version with each update. So, for example, if version 3.4.0 ships with Elastic version 7.14.0, you can still stay on version 7.12.1. You can find the minimum required Elastic version [here](README.md#requirements).
122
122
123
-
Watch this video to see a demonstration how to update the Elastic-Stack:
:exclamation: Before proceeding, make sure that your Elasticsearch cluster consists of __at least 3 nodes__. For example 3 Elasticsearch nodes running on two machines is perfectly fine for this.
129
126
There are 3 Elasticsearch nodes required, as there must always be a master node in the cluster. If this master node is stopped, a quorum of remaining cluster nodes must still be running to elect a new master, otherwise an upgraded Elasticsearch node cannot join the cluster. [Learn more](https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-discovery-quorums.html)
130
127
131
128
[Read more](README.md##general-remarks) information about adding additional cluster nodes. After the upgrade, you can remove the third cluster node if necessary. Before proceeding, make sure that Elasticsearch is in the Green state.
132
129
130
+
Watch this video to see a demonstration how to update the Elastic-Stack:
Please follow these steps to update the Elastic version.
136
136
137
137
__1. Update .env file__
138
138
139
-
- Open your `.env` file and change the parameter: `ELASTIC_VERSION` to the necessary version as specified in the release or the version you would like to use
139
+
- Open your `.env` file and change the parameter: `ELASTIC_VERSION` to the version as specified in the release or the version you would like to use
140
140
- Make sure that the `.env` file contains the correct/same version on all machines
141
141
- To avoid any downtime, double check all Elasticsearch clients (API-Builder, Logstash, Filebeat) using the `ELASTICSEARCH_HOSTS` have multiple or all Elasticsearch nodes configured so that they can fail over
142
142
143
143
__2. Update Elasticsearch cluster__
144
144
145
-
Updating the Elasticsearch cluster happens one node after next. Before updating the next node it's strongly recommended that the cluster state is green and remaining nodes have enough disk space to take over the shards from the node to be upgraded.
145
+
Updating the Elasticsearch cluster happens one node after next. Make sure:
146
+
- You have three Elasticsearch-Node
147
+
- Before updating the next node it's strongly recommended to validate a new master has been elected
148
+
- and remaining nodes have enough disk space to take over the shards from the node to be upgraded
149
+
146
150
```
147
-
wget --no-check-certificate https://github.com/Axway-API-Management-Plus/apigateway-openlogging-elk/releases/download/v3.4.0/axway-apim-elk-v3.4.0.tar.gz -O - | tar -xvz
# On the Elasticsearch node you would like to update, navigate into your ELK-Solution directory
152
+
cd axway-apim-elk-v4.0.2
153
+
# Stop the existing Elasticsearch container you would like to update
154
+
docker stop elasticsearch1
155
+
# Start a new Elasticsearch node (in this case Elasticsearch-Node-1), which will
156
+
# create a new container based on the version you configured in your .env file
152
157
docker-compose -f elasticsearch/docker-compose.es01.yml up -d
153
158
```
154
-
Repeat these steps on the remaining Eleasticsearch nodes, but only after the Elasticsearch cluster has returned to Green status.
159
+
160
+
Repeat these steps on the remaining Eleasticsearch nodes, but make sure a new Elasticsearch-Master has been elected.
155
161
156
162
__3. Update Kibana__
157
163
158
-
It is recommended to run the entire Elastic stack with the same version, so Kibana should/must be updated as well. To update Kibana you need to perform the following steps after adjusting the `ELASTIC_VERSION` accordingly.
164
+
It is recommended to run the entire Elastic stack with the same version, so Kibana should/must be updated as well. To update Kibana you need to perform the following steps after adjusting the `ELASTIC_VERSION` accordingly. Kibana must be updated as it otherwise is no longer compatible with the Elasticsearch version.
159
165
160
166
```
161
-
wget --no-check-certificate https://github.com/Axway-API-Management-Plus/apigateway-openlogging-elk/releases/download/v3.4.0/axway-apim-elk-v3.4.0.tar.gz -O - | tar -xvz
# On the Kibana node you would like to update, navigate into your ELK-Solution directory
168
+
cd axway-apim-elk-v4.0.2
169
+
# Stop the existing Kibana container
170
+
docker stop kibana
171
+
# Start a new Kibana-Container with the configured ELASTIC_VERSION in your .env file
166
172
docker-compose -f kibana/docker-compose.kibana.yml up -d
167
173
```
168
174
169
175
__4. Update Logstash__
170
176
171
177
It is recommended to run the entire Elastic stack with the same version, so Logstash should/must be updated as well. Same procedure as for Kibana but repeat this on all Logstash nodes.
172
178
```
173
-
wget --no-check-certificate https://github.com/Axway-API-Management-Plus/apigateway-openlogging-elk/releases/download/v3.4.0/axway-apim-elk-v3.4.0.tar.gz -O - | tar -xvz
# On the Logstash node you would like to update, navigate into your ELK-Solution directory
180
+
cd axway-apim-elk-v4.0.2
181
+
# Stop the existing Logstash container
182
+
docker stop logstash
183
+
# Start a new Logstash with the configured ELASTIC_VERSION in your .env file
178
184
docker-compose up -d
179
185
```
180
186
181
187
__5. Update Filebeat__
182
188
183
-
It is recommended to run the entire Elastic stack with the same version, so Filebeat should/must be updated as well. Same procedure as for Kibana and Logstash but repeat this on all Filebeat nodes.
189
+
It is recommended to run the entire Elastic stack with the same version, so Filebeat should/must be updated as well. Same procedure as for Kibana and Logstash but repeat this on all Filebeat nodes. Of course, these steps are only valid if you run Filebeat as part of the Docker-Compose approach.
190
+
184
191
```
185
-
wget --no-check-certificate https://github.com/Axway-API-Management-Plus/apigateway-openlogging-elk/releases/download/v3.4.0/axway-apim-elk-v3.4.0.tar.gz -O - | tar -xvz
0 commit comments