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

Commit 9a9406d

Browse files
author
Chris Wiechmann
authored
Update UPDATE.md
1 parent 312c483 commit 9a9406d

File tree

1 file changed

+14
-18
lines changed

1 file changed

+14
-18
lines changed

UPDATE.md

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The core component is the API Builder application which provides the information
3131

3232
## Release history - Changed components
3333

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.
3535

3636
On the other hand, the API builder Docker image, as a central component of the solution, will most likely change with each release.
3737

@@ -62,10 +62,6 @@ On the other hand, the API builder Docker image, as a central component of the s
6262
| 4.0.1 | - | - | - | - | - | [X](#dashboards)| - |- | 7.16.1 | |
6363
| 4.0.2 | - | - | - | - | - | [X](#dashboards)| - |- | 7.16.1 | See #154 |
6464

65-
### Update from Version 1.0.0
66-
67-
If you are upgrading from Release 1.0.0 and encounter problems, please open an issue.
68-
6965
## Upgrade components
7066

7167
### Filebeat
@@ -116,6 +112,19 @@ Please follow the instructions to [import Kibana-Dashboards](README.md#kibana-da
116112

117113
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.
118114

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+
119128
## Update Elastic-Stack version
120129

121130
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
197206
docker-compose -f filebeat/docker-compose.filebeat.yml up -d
198207
```
199208

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-
213209
## Update FAQ
214210

215211
### Do I need to update the Elasticsearch version?

0 commit comments

Comments
 (0)