Update¶

The update steps divided in the ones for the management server and the ones for the PLOSSYS 5 server.

Hint - no Internet access

If the server on which you want to update 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 update.

Notes Concerning the Update from 5.0.5 to 5.1.0¶

With PLOSSYS 5.1.0, the directory structure of the installation has been changed. Therefore, it is required to execute some manual steps before and after the update, refer to Manual Steps Before Updating the PLOSSYS 5 Server from 5.0.5 to 5.1.0 and Manual Steps After Updating the PLOSSYS 5 Server from 5.0.5 to 5.1.0.
When updating to PLOSSYS 5.1.0 and using easyPRIMA as of version 1.3.1, the 20181204_perl_soap-lite_1.27_part.zip package has to be installed with easyPRIMA. Otherwise, the export from easyPRIMA to PLOSSYS 5 does not work and the 500 SSL negotiation failed error message is output to the logfile of easyPRIMA (edc.log).

Hint - stop the system

Before installing the 20181204_perl_soap-lite_1.27_part.zip package, stop the system and all Perl processes completely (sysstop -full). Otherwise, the Perl environment will break.
Up to version 5.0.5, an error sheet was output in case of error. As of version 5.1.0, the error sheet is not output by default but can be activated by setting PRINT_ERROR_SHEET to Y. The PRINT_ERROR_SHEET environment variable is available as of version 5.1.0.

Notes Concerning the Update from 5.1.0 to 5.2.1¶

The Consul service has been replaced by a newer incompatible version. Therefore, the system configuration has to be exported before the update and imported again after the update, refer to Manual Steps Before Updating the PLOSSYS 5 Server from 5.1.0 to 5.2.1 and Manual Steps After Updating the PLOSSYS 5 Server from 5.1.0 to 5.2.1.

In MongoDB, a shared replica set has to be configured for the cluster mode and the database has to be initialized for the single server mode. For how to do this, refer to the SEAL-specific MongoDB documentation.

Some services have been replaced by other services or have become obsolete and have to be removed manually after updating, refer to Manual Steps After Updating the PLOSSYS 5 Server from 5.1.0 to 5.2.1.

Notes Concerning the Update to 5.3.5¶

With PLOSSYS 5.3.5, the v2 REST routes have been deactivated. Now, only v3 with authentication is supported. For this, easyPRIMA as of version 1.7.0 or version 1.4.0 (development release only) is required. For easyPRIMA 1.3.1, a patch concerning the version change of the REST routes is available.
With PLOSSYS 5.3.5, the JOBNAME and USERNAME parameters are stored in the job as jobName and userName. A compatibility layer is active in the current version, but in a future PLOSSYS 5 version, it will be deactivated. In order that the job and user names are displayed correctly at the printer, which is important especially when using 3rd-party pickup printing systems or secure printing with a PIN, make sure you will soon update to printer templates from March 2022 or later.

Update the Management Server¶

Caution - SEAL Elastic Stack incompatible to seal-elk

SEAL Elastic Stack contains the new version of Elasticsearch and Kibana and replaces seal-elk. Before installing SEAL Elastic Stack, you have to uninstall seal-elk:

RHEL:
```
sudo yum --assumeyes remove seal-elk
```

SLES:

sudo zypper --non-interactive remove seal-elk

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 - 7.16.1.85 - rpm folder. It is saved as SEAL Elastic Stack 7.16.1.85 - rpm.zip.

Extract SEAL Elastic Stack - 7.16.1.85 - rpm.zip:

unzip "SEAL Elastic Stack - 7.16.1.85 - rpm.zip"

Change into the SEAL Elastic Stack - 7.16.1.85 - rpm/server directory and install the server-related packages contained there:
```
cd "SEAL Elastic Stack - 7.16.1.85 - rpm/server"
```
```
sudo sh install.sh
```

Start the following services:

sudo systemctl start elasticsearch
sudo systemctl start seal-kibana

Download seal-bos2gyros-1.0.49-107.x86_64.rpm.

Install seal-boy2gyros:

RHEL:

sudo yum --assumeyes install seal-bos2gyros-1.0.49-107.x86_64.rpm

SLES:

sudo zypper --non-interactive install seal-bos2gyros-1.0.49-107.x86_64.rpm

Manual Steps Before Updating the PLOSSYS 5 Server from 5.0.5 to 5.1.0¶

With PLOSSYS 5.1.0, the directory structure of the installation has been changed. Therefore, it is required to execute some manual steps before and after the update.

Stop the PLOSSYS 5 system completely:
```
plossys service stop
```

Create the new directories and copy the old contents to the new locations:

sudo mkdir -p /opt/seal/etc

sudo cp -a /opt/seal/plossys/etc/* /opt/seal/etc

sudo mkdir -p /opt/seal/data

sudo cp -a /opt/seal/plossys/data/* /opt/seal/data

sudo find /opt/seal/etc -type f -exec sed -i "s|/opt/seal/plossys/|/opt/seal/|g" "{}" \;

sudo ln -fs /opt/seal/etc/mongod.conf /etc/mongod.conf

Uninstall seal-filebeat:

RHEL:

sudo yum --assumeyes remove seal-filebeat

SLES:

sudo zypper --non-interactive remove seal-filebeat

When using MongoDB in a cluster, you have to update MongoDB as described in the SEAL-specific MongoDB documentation.

Manual Steps Before Updating the PLOSSYS 5 Server from 5.1.0 to 5.2.1¶

With PLOSSYS 5.1.0, the Consul service has been replaced by a newer incompatible version. Therefore, the system configuration has to be exported before the update and imported again after the update.

Save the system configuration:

plossys config export <config_save_filename>

Remove the Consul data directory:
```
/opt/seal/data/seal-consul
```

Manual Steps Before Updating the PLOSSYS 5 Server to 5.3.2¶

With PLOSSYS 5.3.2, the MongoDB service has been replaced by a newer incompatible version. Therefore, the data stored in MongoDB has to be exported before the update and imported again after the update. For how to do this, refer to the SEAL-specific MongoDB documentation.

Update the PLOSSYS 5 Server¶

In the cluster mode, each PLOSSYS 5 server has to be shutdowned gracefully before being updated.
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 PLOSSYS 5 - 5.3.5.899 - rpm folder. It is saved as PLOSSYS 5 - 5.3.5.899 - rpm.zip.

Extract PLOSSYS 5 - 5.3.5.899 - rpm.zip:

unzip "PLOSSYS 5 - 5.3.5.899 - rpm.zip"

Change to the PLOSSYS 5 - 5.3.5.899 - rpm directory and start the installation of the packages contained there:
```
cd "PLOSSYS 5 - 5.3.5.899 - rpm"
```
```
sudo sh install.sh
```
Start the PLOSSYS 5 system:
```
plossys service start
```
Download the SEAL Elastic Stack - 7.16.1.85 - rpm folder. It is saved as SEAL Elastic Stack - 7.16.1.85 - rpm.zip.

Extract SEAL Elastic Stack - 7.16.1.85 - rpm.zip:

unzip "SEAL Elastic Stack - 7.16.1.85 - rpm.zip"

Change into the SEAL Elastic Stack - 7.16.1.85 - rpm/client directory and install the client-related packages contained there:
```
cd "SEAL Elastic Stack - 7.16.1.85 - rpm/client"
```
```
sudo sh install.sh
```
Restart the following service:
```
plossys service start seal-filebeat
```

Manual Steps After Updating the PLOSSYS 5 Server from 5.0.5 to 5.1.0¶

With PLOSSYS 5.1.0, the directory structure of the installation has been changed. Therefore, it is required to execute some manual steps before and after the update.

Stop the PLOSSYS 5 system completely:
```
plossys service stop
```
Adjust the configuration files in the /opt/seal/etc directory according to the settings in the old configuration files and delete the *.rpmnew files afterwards:
```
sudo rm /opt/seal/etc/*.rpmnew
```
Remove the previous installation directory:
```
sudo rm -rf /opt/seal/plossys
```
Start the PLOSSYS 5 system:
```
plossys service start
```

Manual Steps After Updating the PLOSSYS 5 Server from 5.1.0 to 5.2.1¶

With PLOSSYS 5.2.1, the Consul service has been replaced by a newer incompatible version. The system configuration exported before updating has to be re-imported.

Import the exported system configuration:

plossys config import <config_save_filename>

With PLOSSYS 5.2.1, the following services have been replaced by other services or have become obsolete and have to be removed manually after updating:

seal-pdf2ps
seal-pdfstamp
seal-ps2pdf
seal-router
seal-sapgof

Open a shell and execute the following call for each service:

sudo rpm -e <service_name>

Manual Steps After Updating the PLOSSYS 5 Server from 5.2.1 to 5.3.0¶

With PLOSSYS 5.3.0, the seal-controller service has been introduced which will replace the seal-dispatcher service in the next version. By default, the seal-dispatcher service is still used but you can already activate the seal-controller service by setting JOB_DISPATCHING to next.

When using the seal-controller service and if you have customized the service keys for seal-dispatcher in your PLOSSYS 5 installation before, you have to repeat the customization for seal-controller after the update:

If you have customized JOB_MAX_POSTPONED_COUNT for seal-dispatcher, set the same value with JOB_MAX_POSTPONED_COUNT for seal-controller.
If you have customized LOUNGE_TTL for seal-dispatcher, set the same value with JOB_RETRY_DELAY for seal-controller.

Caution - known bug

With version 5.3.0, PRINT_ERROR_SHEET does not work.

Manual Steps After Updating the PLOSSYS 5 Server from Prior than 5.3.0 to 5.3.2¶

With PLOSSYS 5.3.2, the service evaluating PRINT_ERROR_SHEET changed from the seal-dispatcher to the seal-convert-dispatcher service.

If you have customized PRINT_ERROR_SHEET for the seal-dispatcher service, customize it for the seal-convert-dispatcher service (or for any service).

Manual Steps After Updating the PLOSSYS 5 Server from 5.3.0 to 5.3.2¶

In PLOSSYS 5.3.0 and with using the seal-dispatcher service, CONVERT_ON_PRINTER_START was evaluated by the seal-rest service, with the version 5.3.2, it is evaluated by the seal-controller service.

If you have customized CONVERT_ON_PRINTER_START for the seal-rest service, customize it for the seal-controller service.

Manual Steps After Updating the PLOSSYS 5 Server to 5.3.2¶

Obsolete Services¶

With PLOSSYS 5.3.2, the seal-dispatcher service has been replaced by other services and has to be removed manually after updating:

Open a shell and execute the following call:

sudo rpm -e seal-dispatcher

New Version of MongoDB¶

With PLOSSYS 5.3.2, the MongoDB service has been replaced by a newer incompatible version. Therefore, the MongoDB data exported before updating has to be re-imported. For how to do this, refer to the SEAL-specific MongoDB documentation.

Ensure that all keys required for the cooperation with MongoDB have been specified correctly. For more information, refer to Configure the MongoDB Keys in PLOSSYS 5

PLOSSYS Administrator¶

With PLOSSYS 5.3.2, the dashboard of PLOSSYS Administrator has been secured. In order that the user can see the dashboard, the dashbord area has to be specified in the ALLOWED_OIDC_CLIENTS key. For more information, refer to ALLOWED_OIDC_CLIENTS.

Example - configuration with all views and all permissions

{
  "seal-plossysadmin": {
    "roles": {
      "superadmin": {
        "areas": {
            "jobs": {},
            "printers": {},
            "dashboard": {}
        },
        "set-all": {
            "views": ["ALL"],
            "permissions": ["ALL"]
        }
      }
    }
  }

Manual Steps After Updating the PLOSSYS 5 Server to 5.3.3¶

With PLOSSYS 5.3.3, audit data has been introduced. For this, the filebeat.yml configuration file has been changed. When updating to PLOSSYS 5.3.3, these changes have to be done manually.

Open the Filebeat configuration file on the PLOSSYS 5 server:
```
/opt/seal/etc/filebeat.yml
```

Add the following entry below the processors section:

- add_fields:
    when:
      has_fields:
        - metadata.audit
    target: ""
    fields:
      indextype: audit
- rename:
    when:
      has_fields:
        - metadata.audit
    fields:
      - from: metadata.audit
        to: audit
      - from: application
        to: audit.application
    ignore_missing: true
- copy_fields:
    when:
      has_fields:
        - audit
    fields:
      - from: timestamp
        to: audit.timestamp
    ignore_missing: true
- drop_fields:
    when:
      has_fields:
        - audit
    fields: ["sourcefile", "hostname", "message", "application", "module", "level", "metadata", "agent", "host", "ecs", "processId"]
    ignore_missing: true

Manual Steps After Updating the PLOSSYS 5 Server to 5.3.4¶

With PLOSSYS 5.3.4, the logs permission for viewing the log data of jobs and printers has been introduced in the roles configuration in ALLOWED_OIDC_CLIENTS. If you have solely ALL permissions configured ("permissions": ["ALL"]) nothing has to be done, but if you have explicit permissions configured, you have to add the logs permission in order to allow the users to still view job and printer logs.

Example - configuration with logs permission for jobs and printers

{
  "seal-plossysadmin": {
    "roles": {
      "superadmin": {
        "areas": {
          "jobs": {
            "set-xyz": {
              "views": ["ALL"],
              "permissions": ["tempfiles", "move", "pause", "cancel", "repeat", "resume", "delete", "collect", "logs"]
            }
          },
          "printers": {
            "set-xyz": {
              "views": ["ALL"],
              "permissions": ["add", "update", "pause", "redirect", "resume", "createTestJob", "checkPhysical", "logs"]
            }
          },
          "dashboard": {}
        }
      }
    }
  }