Installation¶
The installation steps are divided in the ones for the management server and the ones for the Output Engine server.
Hint - no Internet access
If the server on which you want to install the components does not have Internet access, use another server with Internet access for logging on to the SEAL Systems delivery platform and downloading the folder and packages. Then, copy the downloaded files to the server on which you want to install.
Install the Management Server¶
-
Check if all requirements for the management server have been fulfilled.
-
Install the server part of SEAL Elastic Stack, refer to the SEAL Elastic Stack documentation.
Caution - minimal security and credentials
As of SEAL Elastic Stack 8.0.0, the installation of Elastic Stack includes the Elastic Stack auto configuration. Thus, minimal security is automatically activated and a random password created for the
elasticuser. Take note of it during the Elastic Stack installation.
You can reset the automatically generated password once, refer to Resetting Passwords.
Hint - Elastic configuration files
As of PLOSSYS Output Engine 7.4.0, the Elastic configuration files are delivered with the Output Engine installation. Thus the
load-configscript and the Filebeat are now located on the Output Engine server. The respective instructions are included in Install the Output Engine Server below. -
Download seal-bos2gyros-1.12.2.862.msi.
Hint - logon data
You receive the logon data for the SEAL Systems delivery platform from your Technical Project Manager at SEAL Systems.
-
Install
seal-bos2gyros-1.12.2.862.msi.Hint -
sitwelcomeIf you install bos2gyros after easyPRIMA, follow these steps for easyPRIMA to recognize it:
- Open a SEAL Shell and call
sitwelcome. - Restart the server.
- Open a SEAL Shell and call
-
Install easyPRIMA 1.3.0 or higher. The installation package is provided by your Technical Project Manager at SEAL Systems. For how to install and configure easyPRIMA, refer to the easyPRIMA documentation.
Install the Output Engine Server¶
-
Check if all requirements for the Output Engine server have been fulfilled.
-
Download the PLOSSYS Output Engine - 7.4.0.2281 - msi folder. It is saved as
PLOSSYS Output Engine - 7.4.0.2281 - msi.zip.Hint - logon data
You receive the logon data for the SEAL Systems delivery platform from your Technical Project Manager at SEAL Systems.
-
Extract
PLOSSYS Output Engine - 7.4.0.2281 - msi.zip. -
Open a PowerShell (Administrator), change to the
PLOSSYS Output Engine - 7.4.0.2281 - msidirectory and start the installation of the packages:cd "PLOSSYS Output Engine - 7.4.0.2281 - msi"Set-ExecutionPolicy Bypass -Scope Process -Force; .\install.ps1Hint - fewer ports for single server installation
In case of a single server installation fewer open ports are needed, refer to portlist for single server installation.
-
Open the firewall ports:
Set-ExecutionPolicy Bypass -Scope Process -Force; .\firewall.ps1 -
Close the PowerShell and start a new one (not as Administrator) for the further configuration. Otherwise, the paths are not set correctly.
-
Start Consul:
plossys service start seal-consul-agent -
In case of a cluster installation, it is best to configure the Consul cluster now. For how to configure and secure a cluster installation, refer to Cluster Configuration.
-
Import the Output Engine configuration:
plossys config update "C:\ProgramData\SEAL Systems\config\plossys.yml" --token INSECURE_ACL_MASTER_TOKEN --insecureHint - client part of SEAL Elastic Stack
As of PLOSSYS Output Engine 7.4.0, Elastic's Filebeat is included in the delivery of PLOSSYS Output Engine and automatically installed.
-
In a PowerShell (Administrator), open the following directory:
"C:\Program Files\SEAL Systems\seal-out-ngn-elasticstack-configuration" -
Start the
load-configscript for PLOSSYS Output Engine. Specify the URLs for Kibana and Elasticseach:.\node.exe .\configuration\load-config.js -k kibana_url -l elasticsearch_url-
kibana_url: Kibana URL, default:http://localhost:5601 -
elasticsearch_url: Elasticsearch URL, default:http://localhost:9200
Literature - load-config.js
For more information about the
load-configscript, refer to Configure SEAL Elastic Stack and Elastic Stack Configuration Files.Hint - overwriting
By default, the
load-configscript works in non-overwrite mode. It whether the specific index exists and adds only settings that are missing.With option
-othe script overwrites already existing workspaces and indices.Independent of the operation mode, the
load-configscript always overwrites-
dashboard configurations to protect the consistency of the consecutive configurations
-
index templates
-
any non-customer-specific pipelines
For details on pipelines, see Configuring pipelines.
The script never overwrites
-
index lifecycle policies
-
any customer-specific pipelines.
Their names must contain the string
custom. They are only created, if not yet existing.If you wish to have them updated, you have to delete them manually in the Kibana user interface before you start the version update.
For details on pipelines, see Configuring pipelines.
Hint - several products reporting to one Elasticsearch server
If you wish to have several products writing to the same Elasticsearch server, you can manually create a common index pattern for the audit indices as described in Creating an Index Pattern for the Audit Indices.
-
-
Open the Filebeat configuration file in an editor.
C:\ProgramData\SEAL Systems\config\filebeat-out-ngn.yml -
In the
output.elasticsearchsection, adjust and activate the following values as needed:-
hosts: change it to the FQDN if SSL will be used or the Elasticsearch installation is on another server, aka management server -
usernameandpassword: as of Elastic Stack 7.17.3, minimal security is activated automatically; thus credentials have to be specified
Hint - Elasticsearch credentials
When installing Elastic Stack, minimal security is automatically activated and a random password created for the
elasticuser. Take note of it during the Elastic Stack installation.
You can reset the automatically generated password once, refer to Resetting Passwords.
Hint - default configuration
With each installation or update, a file named
filebeat-out-ngn.yml.<version>.deliverycontaining the default configuration is stored in the configuration directoryC:\ProgramData\SEAL Systems\config\. That way, customer specific changes can easily be identified. -
-
Start the Output Engine system:
plossys service start
Caution - Logrotate no longer included
As of version 6.0.0, Logrotate to cleanup outdated log files is no longer included in the PLOSSYS Output Engine bundle. You can run the Output Engine without Logrotate, but we strongly recommend to install it, refer to SEAL Logrotate documentation.
Next Step¶
Continue with: Mandatory Configuration Overview