Updating SEAL Elastic Stack¶

Overview¶

The update consists of a server and a client part which you have to update separately.

Server:

The server part includes Elasticsearch and Kibana. You have to update it on the management server.
Client:

The client part contains Filebeat. You have to update it on any client server, e. g. PLOSSYS Output Engine, PLOSSYS 4, SEAL Operator, ...

Hint - running Filebeat

Filebeat has to be running, when you start the update.

For a few seconds during the update, it may happen that log files are created, which are stored in Elasticsearch neither by the old nor by the new Filebeat service.

Caution - direct update

A direct update to version 8.x requires a version 7.17.x.

If you still work with a version 7.16.x or previous versions, you have to update to version 7.17.x first.

Preparing the Update¶

Start Elastic Upgrade Assistant.

Elastic Upgrade Assistant will check for indices of version 6.x which need to be re-indexed with version 7.x or deleted. Otherwise these indices will not work in version 8.x and later.

For details on re-indexing indices, see below.

You do not need this check, if you update from one version 8.x to another version 8.x.
Create a complete backup.

Hint - new server

Making a complete backup and using a new server for a new installation of version 8.x might keep you from installing an interim version.

You need a new server for this, but you can use the automatic configuration of the security.

Hint - automatic configuration

SEAL Elastic Stack 8.x provides an automatic configuration, see Automatic Configuration.

Reindexing Indices¶

In a PowerShell (Administrator), change to the following directory:

cd "C:\Program Files\SEAL Systems\seal-elasticstack-configuration"

Start the following script:

.\node\node.exe .\configuration\scripts\reindex_accounting_data.js -url <elasticUrl e.g. https://localhost:9200> -u <credentials e.g. elastic:password>

Notes on Activating the Security¶

Hint - Unconfigured security in the old system

If your previous installation did not include an active security configuration, the installation script explicitly deactivates the security settings. You will receive a corresponding notification during the installation.

In this case the script is unable to configure the security settings automatically. You can still configure it manually later.

Hint - Preconfigured security in the new system

If you configure the security settings in your system before you update SEAL Elastic Stack installation, the installation script will leave your settings untouched. This means that Elasticsearch will run without SSL.

Instructions¶

Follow the instructions below to install SEAL Elastic Stack.

Management Server¶

In a browser, log on to the SEAL Systems delivery platform with your logon data:

https://delivery.sealsystems.de

Hint - logon data

You receive the logon data from your Technical Project Manager at SEAL Systems.
Download the SEAL Elastic Stack - 8.19.11.462 - msi folder. It is saved as SEAL Elastic Stack - 8.19.11.462 - msi.zip.
Extract SEAL Elastic Stack - 8.19.11.462 - msi.zip.
In a PowerShell (Administrator), change to the SEAL Elastic Stack - 8.19.11.462 - msi\server directory and start installing the packages:
```
cd "SEAL Elastic Stack - 8.19.11.462 - msi\server"
```
```
Set-ExecutionPolicy Bypass -Scope Process -Force; .\install.ps1
```

Open the required firewall ports for necessesary services:

Set-ExecutionPolicy Bypass -Scope Process -Force; .\firewall.ps1

Change to the configuration directory of seal-elasticsearch:

cd "C:\ProgramData\SEAL Systems\config\seal-elasticsearch"

In an editor, compare the elasticsearch.yml configuration file to the old elasticsearch.yml.install-bak configuration file.

Add your customer-specific changes, e. g. network.host, path.repo or xpack.security.enabled.

For details on the general configuration, see Configuring Elasticsearch.
Change to the common configuration directory:
```
cd "C:\ProgramData\SEAL Systems\config"
```
In an editor, compare the kibana.yml configuration file to the old kibana.yml.install-bak configuration file.

Add your customer-specific changes, e. g. server.host, elasticsearch.username or elasticsearch.password.
Set path.data to the correct value, if necessary.
```
path.data: "${ProgramData}/SEAL Systems/data/seal-kibana"
```
Hint - path.data setting moved

In preparation for future versions, path.data is now set in the kibana.yml file instead of the service configuration.

For details on the general configuration, see Configuring Kibana.
Start Elasticsearch:
```
start-service seal-elasticsearch
```
Start Kibana:
```
start-service seal-kibana
```
Hint - long duration

If you start Kibana for the first time after the update, this may take very long. Do not stop the starting process, just wait until it is finished.

Hint - Kibana not starting

If Kibana does not start after having been updated, see Deprecated Configuration or Insufficient Hard Disk Space for a possible solution.
Update the necessary database configuration as described in Configuration via Script.
In Kibana, check whether the dashboards have been overwritten correctly. Delete old dashboards, if they are still existing.

PLOSSYS Output Engine Server¶

Hint - management server first

Make sure, you have updated the management server, i. d. Elasticsearch and Kibana.

In a browser, log on to the SEAL Systems delivery platform with your logon data:

https://delivery.sealsystems.de

Hint - logon data

You receive the logon data from your Technical Project Manager at SEAL Systems.
Download the SEAL Elastic Stack - 8.19.11.462 - msi folder. It is saved as SEAL Elastic Stack - 8.19.11.462 - msi.zip.
Extract SEAL Elastic Stack - 8.19.11.462 - msi.zip.
In a PowerShell (Administrator), change to the SEAL Elastic Stack - 8.19.11.462 - msi\client directory and start installing the packages:
```
cd "SEAL Elastic Stack - 8.19.11.462 - msi\client"
```
```
Set-ExecutionPolicy Bypass -Scope Process -Force; .\install.ps1
```

Change to the configuration directory:

cd "C:\ProgramData\SEAL Systems\config"

In an editor, compare the filebeat.yml configuration file to the old filebeat.yml.install-bak configuration file.

Add your customer-specific changes, e. g. output.elasticsearch.hosts and with activated security output.elasticsearch.username and output.elasticsearch.password.

For details on the general configuration, see Logging or Configuring Filebeat.
Start SEAL Filebeat:
```
start-service seal-filebeat
```

PLOSSYS 4 Server¶

Hint - management server first

Make sure, you have updated the management server, i. d. Elasticsearch and Kibana.

In a browser, log on to the SEAL Systems delivery platform with your logon data:

https://delivery.sealsystems.de

Hint - logon data

You receive the logon data from your Technical Project Manager at SEAL Systems.
Download the SEAL Elastic Stack - 8.19.11.462 - msi folder. It is saved as SEAL Elastic Stack - 8.19.11.462 - msi.zip.
Extract SEAL Elastic Stack - 8.19.11.462 - msi.zip.
In a PowerShell (Administrator), change to the SEAL Elastic Stack - 8.19.11.462 - msi\client-p4 directory and start installing the packages:
```
cd "SEAL Elastic Stack - 8.19.11.462 - msi\client-p4"
```
```
Set-ExecutionPolicy Bypass -Scope Process -Force; .\install.ps1
```

Change to the configuration directory:

cd "C:\ProgramData\SEAL Systems\config"

In an editor, compare the filebeat-p4-accounting.yml configuration file to the old filebeat-p4-accounting.yml.install-bak configuration file and.

Add your customer-specific changes, e. g. output.elasticsearch.hosts and with activated security output.elasticsearch.username and output.elasticsearch.password.

For details on the general configuration, see Logging or Configuring Filebeat.

Start SEAL Filebeat:

start-service seal-p4-accounting-filebeat

SEAL Operator Server¶

Hint - management server first

Make sure, you have updated the management server, i. d. Elasticsearch and Kibana.

In a browser, log on to the SEAL Systems delivery platform with your logon data:

https://delivery.sealsystems.de

Hint - logon data

You receive the logon data from your Technical Project Manager at SEAL Systems.
Download the SEAL Elastic Stack - 8.19.11.462 - msi folder. It is saved as SEAL Elastic Stack - 8.19.11.462 - msi.zip.
Extract SEAL Elastic Stack - 8.19.11.462 - msi.zip.
In a PowerShell (Administrator), change to the SEAL Elastic Stack - 8.19.11.462 - msi\client-operator directory and start installing the packages:
```
cd "SEAL Elastic Stack - 8.19.11.462 - msi\client-operator"
```
```
Set-ExecutionPolicy Bypass -Scope Process -Force; .\install.ps1
```

Change to the configuration directory:

cd "C:\ProgramData\SEAL Systems\config"

In an editor, compare the filebeat-operator.yml configuration file to the old filebeat-operator.yml.install-bak configuration file.

Add your customer-specific changes, e. g. output.elasticsearch.hosts and with activated security output.elasticsearch.username and output.elasticsearch.password.

For details on the general configuration, see Logging or Configuring Filebeat.
Start SEAL Filebeat:
```
start-service seal-operator-filebeat
```

PLOSSYS Distribution Engine/DPF Server¶

Hint - management server first

Make sure, you have updated the management server, i. d. Elasticsearch and Kibana.

Stop PLOSSYS Distribution Engine/DPF:
```
dpf service stop
```
As soon as Filebeat has sent the remaining log data to Elasticsearch, stop Filebeat:
```
start-service seal-dpf-filebeat
```
In a browser, log on to the SEAL Systems delivery platform with your logon data:

https://delivery.sealsystems.de

Hint - logon data

You receive the logon data from your Technical Project Manager at SEAL Systems.
Download the SEAL Elastic Stack - 8.19.11.462 - msi folder. It is saved as SEAL Elastic Stack - 8.19.11.462 - msi.zip.
Extract SEAL Elastic Stack - 8.19.11.462 - msi.zip.
In a PowerShell (Administrator), change to the SEAL Elastic Stack - 8.19.11.462 - msi\client-dpf directory and start installing the packages:
```
cd "SEAL Elastic Stack - 8.19.11.462 - msi\client-dpf"
```
```
Set-ExecutionPolicy Bypass -Scope Process -Force; .\install.ps1
```
Change to the configuration directory:
```
cd C:\ProgramData\SEAL Systems\config
```
In an editor, compare the filebeat-dpf.yml configuration file to the old filebeat-dpf.yml.install-bak configuration file.

Bring your customer-specific changes, e. g. output.elasticsearch.hosts and with activated security output.elasticsearch.username and output.elasticsearch.password to the new configuration file.

This prevents new settings from getting lost.

For details on the general configuration, see Logging or Configuring Filebeat.
If Elastic Stack still uses the old configuration, start the update_dpf_accounting script:
```
cd "C:\Program Files\SEAL Systems\seal-elasticstack-configuration” .\node\node.exe .\configuration\scripts\update\update_dpf_accounting.js
```
Hint - update_dpf_accounting script

The update_dpf_accounting script
- copies all data from the accounting index into a temporary index
- prepares the pipeline processing
- loads the new configuration onto the server
- re-indexes the data from the temporary index to the new accounting index.
After this the data have the new format. You will recognize this by the existing metadata.accounting item in the configuration.
Start SEAL Filebeat:
```
start-service seal-dpf-filebeat
```
Start PLOSSYS Distribution Engine/DPF:
```
dpf service start
```
Update the dashboards to enable new settings to be used.
```
cd "C:\Program Files\SEAL Systems\seal-elasticstack-configuration"
.\node\node.exe .\configuration\load-config.js -o
```
Hint - new settings

You have to run the script to make sure the identification of sub-jobs works after updating, The idenfication is done by the existence of a PARENTJOBIDinstead of the name of the workflow.