Installing the Base Environment
The Base Environment comprises a collection of server and utility applications that are deployed on your *system of record (the system that hosts your DBL applications and data).
Normally you would download the Base Environment installer from the Synergex Resource Center but to simplify the workshop a copy of the installer is already present on your Linux server:
~/installers/sip-base-environment-1.0.0-1.el9.x86_64.rpm
Now it is time to install the Streaming Integration Platform Base Environment:
Install the ISAM Agent
sudo dnf install -y ~/installers/sip-base-environment-1.0.0-1.el9.x86_64.rpm
sip install base
As the installation proceeds you will see messages like this:
===============================================================================
Streaming Integration Platform: BASE ENVIRONMENT
===============================================================================
By installing this product you accept the terms of the Synergex Product License
agreement (PLA) which can be viewed at:
https://www.synergex.com/wp-content/uploads/2022/08/SDE_PLA_CURRENT-1.pdf
Using configuration data from /etc/sysconfig/sip.conf
- Service names : sip-message-broker
: sip-snapshot-agent
- User account : sip-service
- User group : sip-service
- Dflt profile : default
Installing : sip-base-environment-1.0.0-1.el9.x86_64 1/1
Running scriptlet: sip-base-environment-1.0.0-1.el9.x86_64 1/1
The installation is complete and has deployed these directories and files:
Main application files:
/usr/lib/synergex/sip/base-environment/*
Configuration files:
/etc/synergex/sip/*
/etc/iceoryx2/iceoryx2.toml
/etc/profile.d/sip-profile.sh
/etc/profile.d/sip-profile.csh
Systemd service files:
/etc/systemd/system/sip-message-broker.service.d/override.conf
/etc/systemd/system/sip-snapshot-agent.service.d/override.conf
/usr/lib/systemd/system/sip-message-broker.service
/usr/lib/systemd/system/sip-snapshot-agent.service
Log files will be created in /var/log/synergex/sip
If you are using Configuration Server and configured the environment before
starting this installation, and provided information about the environment
by using /etc/sysconfig/sip.conf then the Message Broker and Snapshot Agent
services should already be up and running.
If you are not using Configuration Server you will need to manually ensure
that the necessary configuration files are in place. Refer to the platform
documentation for more details. Once the necessary configuration files are
in place you will need to restart the two services:
sudo systemctl restart sip-message-broker
sudo systemctl restart sip-snapshot-agent
You can check the status of these services with:
sudo systemctl status sip-message-broker
sudo systemctl status sip-snapshot-agent
And you can view the service logs like this:
sudo journalctl -u sip-message-broker
sudo journalctl -u sip-snapshot-agent
Before running any utility applications provided by this package, please log
out and back in to ensure that necessary environment variables are set, or
execute run one of the these commands, depending on your shell:
source /etc/profile.d/sip-profile.csh (for C-shell)
source /etc/profile.d/sip-profile.sh (for other shells)
===============================================================================
Verifying : sip-base-environment-1.0.0-1.el9.x86_64 1/1
Installed:
sip-base-environment-1.0.0-1.el9.x86_64
Complete!
Because you are using Configuration Server and pre-configured the environment, the Message Broker and Snapshot Agent should both have successfully started.
!!note "Verify Services are Running" On the workshop system you can quickly confirm that the services are running using the provides check script: ```text $ check ```` Look for OK next to the SIP Snapshot Agent and SIP Message Broker items.
You should see something like this:
Internet access: OK
Cockpit: OK https://192.168.200.20:9090
Redpanda Console: OK https://192.168.200.20:8080
RustFS: OK https://192.168.200.20:9001
Smtp4dev: OK https://192.168.200.20:5125
DbGate: OK https://192.168.200.20:3001
Web Services: OK https://192.168.200.20:8086
Web Application: OK https://192.168.200.20:5001
SQL Server: OK
SIP Config Server: OK https://192.168.200.20:5121
SIP Snapshot Agent: OK
SIP Message Broker: OK
SIP ISAM Agent: NOT INSTALLED!
SIP SQL Agent: NOT INSTALLED!
SIP JSON Agent: NOT INSTALLED!
Another useful way to check the status of these services is to view their logs:
View the Message Broker log
sudo journalctl -u sip-message-broker
sip log broker
Either way you should see something like this, look for READY at the end:
Oct 09 17:02:13 sipws systemd[1]: Started Streaming Integration Platform Message Broker.
Oct 09 17:02:13 sipws bash[7189]: ===============================================================================
Oct 09 17:02:13 sipws bash[7189]: Streaming Integration Platform: Message Broker
Oct 09 17:02:13 sipws bash[7189]: Version 0.1.0
Oct 09 17:02:13 sipws bash[7189]: ===============================================================================
Oct 09 17:02:13 sipws bash[7189]: Profile : default
Oct 09 17:02:13 sipws bash[7189]: ConfigServer URL : https://sipws:5121
Oct 09 17:02:13 sipws bash[7189]: MasterConfig source : ConfigServer (/etc/synergex/sip/default/MasterConfig.json)
Oct 09 17:02:13 sipws bash[7189]: Log file : /sip/log/message-broker-20261009-170213.log
Oct 09 17:02:13 sipws bash[7189]: Kafka broker(s) : sipws:9092
Oct 09 17:02:13 sipws bash[7189]: CDC topic : DEFAULT_CDC
Oct 09 17:02:13 sipws bash[7189]: Snapshot request topic : DEFAULT_SNAPSHOT_REQUEST
Oct 09 17:02:13 sipws bash[7189]: Snapshot response topic : DEFAULT_SNAPSHOT_RESPONSE
Oct 09 17:02:13 sipws bash[7189]: Kafka retry seconds : 30
Oct 09 17:02:13 sipws bash[7189]: S3 endpoint : https://sipws:9000
Oct 09 17:02:13 sipws bash[7189]: S3 region : us-west-2
Oct 09 17:02:13 sipws bash[7189]: S3 access key : sipagent
Oct 09 17:02:13 sipws bash[7189]: S3 bucket : default
Oct 09 17:02:13 sipws bash[7189]: Verbose logging : false
Oct 09 17:02:13 sipws bash[7189]: READY
View the Snapshot Agent log
sudo journalctl -u sip-snapshot-agent
sip log snapshot
Either way you should see something like this, again look for READY at the end:
Oct 09 17:02:13 sipws systemd[1]: Started Streaming Integration Platform Snapshot Agent.
Oct 09 17:02:13 sipws bash[7237]: ===============================================================================
Oct 09 17:02:13 sipws bash[7237]: Streaming Integration Platform: Snapshot Agent
Oct 09 17:02:13 sipws bash[7237]: Version 1.0.0
Oct 09 17:02:13 sipws bash[7237]: ===============================================================================
Oct 09 17:02:13 sipws bash[7237]: Config profile : default
Oct 09 17:02:13 sipws bash[7237]: MasterConfig source : ConfigServer (/etc/synergex/sip/default/MasterConfig.json)
Oct 09 17:02:13 sipws bash[7237]: Log file : /sip/log/snapshot-agent-20261009-170213.log
Oct 09 17:02:13 sipws bash[7237]: Config Server URL : https://sipws:5121
Oct 09 17:02:13 sipws bash[7237]: Kafka servers : sipws:9092
Oct 09 17:02:13 sipws bash[7237]: CDC topic : DEFAULT_CDC
Oct 09 17:02:13 sipws bash[7237]: Snapshot topic : DEFAULT_SNAPSHOT_REQUEST
Oct 09 17:02:13 sipws bash[7237]: Snapshot response topic : DEFAULT_SNAPSHOT_RESPONSE
Oct 09 17:02:13 sipws bash[7237]: Kafka retry seconds : 30
Oct 09 17:02:13 sipws bash[7237]: Kafka max poll minutes : 1440
Oct 09 17:02:13 sipws bash[7237]: Parquet S3 endpoint : https://sipws:9000
Oct 09 17:02:13 sipws bash[7237]: Parquet S3 region : us-west-2
Oct 09 17:02:13 sipws bash[7237]: Parquet S3 access key : sipagent
Oct 09 17:02:13 sipws bash[7237]: Parquet S3 bucket : default
Oct 09 17:02:13 sipws bash[7237]: Parquet S3 path :
Oct 09 17:02:13 sipws bash[7237]: Counted S3 provider : RemoteS3
Oct 09 17:02:13 sipws bash[7237]: Counted S3 endpoint : https://sipws:9000
Oct 09 17:02:13 sipws bash[7237]: Counted S3 bucket : default
Oct 09 17:02:13 sipws bash[7237]: Counted S3 path :
Oct 09 17:02:13 sipws bash[7237]: Verbose logging : false
Oct 09 17:02:13 sipws bash[7237]: Output directory : /sip/snapshot
Oct 09 17:02:13 sipws bash[7237]: Table definitions : 9
Oct 09 17:02:13 sipws bash[7237]: READY
Problems?
- If either service is not running, seek assistance from a workshop facilitator.