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
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,11 +10,11 @@ This documents describes how to update based on Docker Compose deployment. If yo
10
10
11
11
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.
12
12
13
-
###General overview
13
+
## General overview
14
14
15
15
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.
16
16
17
-
####Upgrade steps overview
17
+
### Upgrade approach
18
18
19
19
- load and unpack the current or desired release
20
20
- 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
25
25
- depending on which components have changed
26
26
- these containers must be stopped and then restarted based on the new release with `docker-compose up -d`
27
27
- 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.
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.
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.
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
@@ -116,9 +116,9 @@ Please follow the instructions to [import Kibana-Dashboards](README.md#kibana-da
116
116
117
117
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
118
119
-
###Elastic-Stack version
119
+
##Update Elastic-Stack version
120
120
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).
0 commit comments