Skip to content

Installation


The installation steps are divided in the ones for the management server and the ones for the Output Engine server.


Hint - replace malloc library

When using PLOSSYS Output Engine on a Linux system we strongly advice replacing the malloc library with the jemalloc library to prevent memory leaks.


Install the Management Server

  1. Check if all requirements for the management server have been fulfilled.

  2. Download seal-bos2gyros-1.12.2-862.x86_64.rpm.

    Hint - logon data

    You receive the logon data for the SEAL Systems delivery platform from your Technical Project Manager at SEAL Systems.

  3. Install seal-bos2gyros:

    • RHEL:

      sudo yum --assumeyes --nogpgcheck install seal-bos2gyros-1.12.2-862.x86_64.rpm
      
    • SLES:

      sudo zypper --non-interactive --no-gpg-checks install seal-bos2gyros-1.12.2-862.x86_64.rpm
      
  4. Install the unpacking program unzip:

    • RHEL:

      sudo yum --assumeyes install unzip
      
    • SLES:

      sudo zypper --non-interactive install unzip
      
  5. 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 elastic user. Take note of it during the Elasticstack installation.

    Excerpt of an Elasticstack installation showing the newly created password for the elastic user

    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-config script and the Filebeat are now located on the Output Engine server. The respective instructions are included in Install the Output Engine Server below.


Install the Output Engine Server

  1. Check if all requirements for the Output Engine server have been fulfilled.

  2. Install the unpacking program unzip:

    • RHEL:

      sudo yum --assumeyes install unzip
      
    • SLES:

      sudo zypper --non-interactive install unzip
      
  3. For x86 architecture download the PLOSSYS Output Engine - 7.4.0.2281 - rpm folder. It is saved as PLOSSYS Output Engine - 7.4.0.2281 - rpm.zip. For s390x architecture download the PLOSSYS Output Engine - 7.4.0.2281 - rpm_s390x folder. It is saved as PLOSSYS Output Engine - 7.4.0.2281 - rpm_s390x.zip.

    Hint - logon data

    You receive the logon data for the SEAL Systems delivery platform from your Technical Project Manager at SEAL Systems.

  4. Extract PLOSSYS Output Engine - 7.4.0.2281 - rpm.zip:

    unzip "PLOSSYS Output Engine - 7.4.0.2281 - rpm.zip"
    
  5. Change to the PLOSSYS Output Engine - 7.4.0.2281 - rpm directory and start the installation of the packages contained there:

    cd "PLOSSYS Output Engine - 7.4.0.2281 - rpm"
    
    sudo sh install.sh
    
  6. Open the firewall ports:

    sudo sh firewall.sh
    

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

  7. Start Consul:

    plossys service start seal-consul-agent
    
  8. 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.

  9. Import the Output Engine configuration:

    plossys config update /opt/seal/etc/plossys.yml --token INSECURE_ACL_MASTER_TOKEN --insecure
    

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

  10. In a shell, open the following directory:

    "/opt/seal/seal-out-ngn-elasticstack-configuration/"
    
  11. Start the load-config script for PLOSSYS Output Engine. Specify the URLs for Kibana and Elasticseach:

    sudo ./node 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-config script, refer to Configure SEAL Elastic Stack and Elastic Stack Configuration Files.

    Hint - overwriting

    By default, the load-config script works in non-overwrite mode. It whether the specific index exists and adds only settings that are missing.

    With option -o the script overwrites already existing workspaces and indices.

    Independent of the operation mode, the load-config script 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.

  12. Open the Filebeat configuration file in an editor.

    /opt/seal/etc/filebeat-out-ngn.yml
    
  13. In the output.elasticsearch section, 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

    • username and password: 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 elastic user. Take note of it during the Elastic Stack installation.

    Excerpt of an Elastic Stack installation showing the newly created password for the elastic user

    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>.delivery containing the default configuration is stored in the configuration directory /opt/seal/etc/. That way, customer specific changes can easily be identified.

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


Back to top