Installing the Base Environment on a Linux System of Record
Installing the Streaming Integration Platform on a Linux system of record involves downloading and running a base environment RPM installer. The installation can be downloaded from the Synergex Resource Center.
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
Preparing to Install
The base environment includes two applications, the message broker and snapshot agent, that run as systemd services. Default values are used for the user account name, user group and profile name to be used, but can be customized. For more information, refer to Preparing to Install on Linux.
Installation
The installation is started using the package manager and requires root (sudo) 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
Coming soon
Managing Services
The Streaming Integration Platform includes two applications that run as standard Linux systemd services and can be controlled using the systemctl utility:
| Application | Service Name |
|---|---|
| Snapshot Agent | sip-snapshot-agent |
| Message Broker | sip-message-broker |
Some examples of common systemctl command are as follows:
sudo systemctl status <service-name>
sudo systemctl restart <service-name>
sudo systemctl stop <service-name>
sudo systemctl disable <service-name>
sudo systemctl enable <service-name>
Upgrading the Base Environment
IMPORTANT: It is CRITICAL that Streaming Integration Platform version upgrades are only ever performed at a time when the system of record 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.
- Verify that the services stopped.
- 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:
- Perform any post-upgrade tasks as defined in the release notes.
- Restart the services and check the status of both:
sudo systemctl stop sip-snapshot-agent sip-message broker
sudo systemctl status sip-snapshot-agent
sudo systemctl status sip-message broker
sudo dnf install sip-base-environment-n.n.n-n.el10.x86_64.rpm
sudo systemctl start sip-snapshot-agent sip-message-broker
sudo systemctl status sip-snapshot-agent
sudo systemctl status sip-message broker
Removing the Base Environment
To remove Streaming Integration Platform Base Environment from a Linux system of record:
- Stop the services.
- Verify that the services stopped.
- Remove the product using the package manager:
sudo systemctl stop sip-snapshot-agent sip-message-broker
sudo systemctl status sip-snapshot-agent
sudo systemctl stop sip-message broker
sudo dnf remove sip-base-environment