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

Commit 312c483

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

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

UPDATE.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ This documents describes how to update based on Docker Compose deployment. If yo
1010

1111
With the following steps you can update the solution without downtime. Of course, this requires that all components (Logstash, API Builder, Memcached) are running at least 2x and configured accordingly. So all filebeats have to communicate with all logstash hosts.
1212

13-
### General overview
13+
## General overview
1414

1515
The core component is the API Builder application which provides the information about the necessary configuration. In principle, it contains the desired or necessary state suitable for the version, especially about the Elasticsearch configuration, such as index templates, ILM policies, etc. If the version is updated, the API builder checks the current configuration in Elasticsearch and adjusts it if necessary to fit the corresponding version. This includes necessary changes for bug fixes or enhancements.
1616

17-
#### Upgrade steps overview
17+
### Upgrade approach
1818

1919
- load and unpack the current or desired release
2020
- it is recommended to unpack it next to the existing release
@@ -25,13 +25,13 @@ The core component is the API Builder application which provides the information
2525
- depending on which components have changed
2626
- these containers must be stopped and then restarted based on the new release with `docker-compose up -d`
2727
- e.g. if no change is noted in logstash, then this component can continue to run
28-
- the API builder delivers the configuration for Elasticsearch as well
29-
- If the API builder is updated, then it checks on restart and periodically if the Elasticsearch configuration is correct.
30-
- In addition, the API builder checks whether the filebeat and logstash configuration corresponds to the expected version.
28+
- the API-Builder delivers the configuration for Elasticsearch as well
29+
- if the API-Builder is updated, then it checks on restart and periodically if the Elasticsearch configuration is correct.
30+
- in addition, the API builder checks whether the filebeat and logstash configuration corresponds to the expected version.
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.
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.
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

@@ -116,9 +116,9 @@ Please follow the instructions to [import Kibana-Dashboards](README.md#kibana-da
116116

117117
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.
118118

119-
### Elastic-Stack version
119+
## Update Elastic-Stack version
120120

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).
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. 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).
122122

123123
### 3 Elasticsearch nodes required
124124

0 commit comments

Comments
 (0)