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
+14-18Lines changed: 14 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,7 +31,7 @@ The core component is the API Builder application which provides the information
31
31
32
32
## Release history - Changed components
33
33
34
-
This table should help you to understand which components have changed with which version. For example, it is not always or very rarely necessary to update Filebeat. If the Elastic version has changed between the some releases, you do not necessarily have to follow it. Of course it is recommended to be on a recent Elastic stack version, because only for this version bugfixes are released by Elastic. [Learn here](#updated-elastic-stack-version) how to update the Elastic stack.
34
+
This table should help you to understand which components have changed with which version. For example, it is not always or very rarely necessary to update Filebeat. If the Elastic version has changed between the some releases, you do not necessarily have to follow it. Of course it is recommended to be on a recent Elastic stack version, because only for this version bugfixes are released by Elastic. [Learn here](#update-elastic-stack-version) how to update the Elastic stack.
35
35
36
36
On the other hand, the API builder Docker image, as a central component of the solution, will most likely change with each release.
37
37
@@ -62,10 +62,6 @@ On the other hand, the API builder Docker image, as a central component of the s
If you are upgrading from Release 1.0.0 and encounter problems, please open an issue.
68
-
69
65
## Upgrade components
70
66
71
67
### Filebeat
@@ -116,6 +112,19 @@ Please follow the instructions to [import Kibana-Dashboards](README.md#kibana-da
116
112
117
113
Sometimes it may be necessary to include newly introduced parameters in your `.env` file or you may want to use optional parameters. To do this, use the supplied `env-sample` as a reference and copy the desired parameters. Please check the [changelog](CHANGELOG.md) which new parameters have been added.
118
114
115
+
### Elastic Config
116
+
117
+
Whether the Elastic configuration has changed is for information only and does not require any steps during the update.
118
+
The required Elasticsearch configuration is built into the API Builder application and Elasticsearch will be updated accordingly if necessary.
119
+
This includes the following components:
120
+
121
+
- Index configuration
122
+
- Index templates
123
+
- Index lifecycle policies
124
+
- Transform jobs
125
+
126
+
FYI. You can find the current configuration here: [elasticsearch_config](https://github.com/Axway-API-Management-Plus/apigateway-openlogging-elk/tree/develop/apibuilder4elastic/elasticsearch_config)
127
+
119
128
## Update Elastic-Stack version
120
129
121
130
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. Thus, it can be concluded that the update of the Elastic stack can be done independently of the releases. You can find the minimum required Elastic version [here](README.md#requirements).
@@ -197,19 +206,6 @@ docker stop filebeat
197
206
docker-compose -f filebeat/docker-compose.filebeat.yml up -d
198
207
```
199
208
200
-
### Elastic Config
201
-
202
-
Whether the Elastic configuration has changed is for information only and does not require any steps during the update.
203
-
The required Elasticsearch configuration is built into the API Builder application and Elasticsearch will be updated accordingly if necessary.
204
-
This includes the following components:
205
-
206
-
- Index configuration
207
-
- Index templates
208
-
- Index lifecycle policies
209
-
- Transform jobs
210
-
211
-
FYI. You can find the current configuration here: [elasticsearch_config](https://github.com/Axway-API-Management-Plus/apigateway-openlogging-elk/tree/develop/apibuilder4elastic/elasticsearch_config)
212
-
213
209
## Update FAQ
214
210
215
211
### Do I need to update the Elasticsearch version?
0 commit comments