Skip to content

Installing Linux Origin Systems

Installing Streaming Integration Platform on Linux

Installing the Streaming Integration Platform on a Linux system involves downloading and running a product installation. The installation can be downloaded from \<to be determined>.

The name of the installation file will be as shown below, where n.n.n-n is the version number of the product you have downloaded:

sip-base-environment-n.n.n-n.el9.x86_64.rpm

The base environment includes the provision of two systemd services that, by default, will run under a user account and user group named sip-service, which will be created during the installation if they do not already exist. If you prefer to have the environment owned by and the services run under a different user account or group, you can do so by creating the configuration file /etc/sysconfig/sip.conf and defining the user account and group you want to use, like this:

SVC_USER=username
SVC_GROUP=groupname

The installation is started using the package manager and requires root privileges, like this:

sudo dnf install sip-base-environment-n.n.n-n.el9.x86\_64.rpm

Destination Directories

The installation creates and/or places files in the following locations:

Location Description
/usr/lib/synergex/sip/base-environment Main base environment executables and other files.
/etc/synergex/sip Configuration files.
/etc/iceoryx2 A configuration file used by one specific dependency library (iceoryx2.toml).
/etc/profile.d Login scripts for interactive processes (sip-profile.sh and sip-profile.csh).
/etc/systemd/system Service unit files (sip-message-broker.service and sip-snapshot-agent.service).
/var/log/synergex/sip Various log files.

Configurating the System

Managing Services

The Streaming Integration Platform includes two applications that run as standard Linux systemd services and can be controlled using the systemctl utility.

The names of the services are

Application Service Name
Snapshot Agent sip-snapshot-agent
Message Broker sip-message-broker

Some examples of common systemctl command are as follows:

To show the service's status:

sudo systemctl status \<service-name\>

To restart the service:

sudo systemctl restart \<service-name\>

To stop the service:

sudo systemctl stop \<service-name\>

To unregister the service:

sudo systemctl disable \<service-name\>

To reregister the service:

sudo systemctl enable \<service-name\>

Upgrading Streaming Integration Platform

IMPORTANT: It is CRITICAL that Streaming Integration Platform version upgrades are only ever performed at a time when the origin application is completely inactive. Failure to do this will result in all replicated data sets becoming out of sync with the system of truth, which will then require reloading those systems from a snapshot.

To upgrade the Streaming Integration Platform to a new version:

  • Review the release notes for the new version so you're aware of any prerequisite tasks or tasks that must be completed after the upgrade.
  • Download the installer for the new version and copy it to the target system.
  • Make sure you still have the installer for the version you are currently running, in case you need to revert to that version for any reason.
  • Perform any prerequisite tasks as defined in the release notes.
  • When you're ready to perform the upgrade, stop the services:

bash sudo systemctl stop sip-snapshot-agent sip-message broker

  • Verify that the services stopped:

bash sudo systemctl status sip-snapshot-agent sudo systemctl stop sip-message broker

  • Execute the installer for the new version. You don't need to remove the old version; the installer for the new version will perform an in-place upgrade:

bash sudo dnf install sip-base-environment-n.n.n-n.el10.x86\_64.rpm

  • Perform any post-upgrade tasks as defined in the release notes.
  • Restart the services:

bash sudo systemctl start sip-snapshot-agent sip-message-broker

Removing Streaming Integration Platform

To remove Streaming Integration Platform from a Linux origin system:

  • Stop the services:

bash sudo systemctl stop sip-snapshot-agent sip-message-broker

  • Verify that the services stopped:

bash sudo systemctl status sip-snapshot-agent sudo systemctl stop sip-message broker

  • Similar to when the product was installed, remove the product using the package manager:

bash sudo dnf remove sip-base-environment