Installing s-Server on Linux

This page contains the following topics:

Installation Overview

s-Server needs to be installed on a Linux machine. See requirements for details on the specifications for this machine. The s-Server installation package includes s-Studio, s-Dashboard, client tools, and webAgent.

Both s-Studio and client tools can be installed separately using their own installers. See Installing SQLstream s-Studio as a Standalone Package and Installing SQLstream Client Tools as a Standalone Package in this guide for more details.

StreamLab must be installed separately. See Installing SQLstream StreamLab in this guide for more details. In a development environment, you may wish to install s-Server, s-Dashboard, webAgent, and s-Studio on this same Linux machine. However, in production environments, you will often want to distribute these components.

Linux Installation Requirements

SQLstream s-Studio and s-Server requirements (hardware and software components) are as follows:

Component Specifics (size, version)
s-Studio 1GB of RAM plus 100MB of hard disk space, plus some additional space for the s-Studio log file. The size of this file is can be adjusted by the user or admin.

A Sun Java runtime environment (JRE) of either Java 6 or Java 7 available at both install time and run time; and a network connection to the SQLstream s-Server.

Linux: Must run 2.6.x or later kernel. Versions known to work include Red Hat Enterprise Linux version 5 or later, Fedora Core 10 or later, Ubuntu 8.04 or later, Mandriva 2006 or later, CentOS 5 or later. 32-bit version works on all supported platforms. 64-bit version tested on Ubuntu, CentOS 5, and RHEL 5.x.
CPU For s-Server, we recommend running an 2GHz Intel Core2 Duo or equivalent. A server class processor such as an Intel Xeon is preferred. While a single core is sufficient, 2+ cores are ideal. Since SQLstream s-Server includes a multithreaded scheduler, multiple cores can improve data processing performance.

Larger caches, faster CPUs, and faster memory interconnect all improve data processing performance.
Disk space Installed software requires 1GB. Log files, repository, and so on require an additional 1 GB.

The amount actually used will depend on how you configure logging, how many objects you create, and so on.

2GB is probably a safe minimum for an initial install.

See SQLstream s-Server Installation Directories for more information on installation directories.
Memory Requirements for:

32-bit system: Minimum 750MB, Production 1GB, Production with more streams or longer data windows 2GB.

64-bit system: Minimum 1.5G, Production 2GB, Production with more streams or longer data windows 4GB.

Memory requirements will be application dependent: more streams or streams that hold longer data windows will require more RAM.
Java The installer will check for an appropriate version of an installed JDK. If it finds an installed JDK, it asks you to confirm its location. If it does not find an appropriate version, it will try to use the native package installer (apt-get on Debian/Ubuntu and yum on Redhat/CentOS) to download and install OpenJDK 8.

Preparing to Install s-Server on Linux

To prepare for installation, follow these steps: - Uninstall any previous version of SQLstream s-Server (see Uninstalling SQLstream ).

Note: In some cases, you may have modified aspen.custom.properties in your old installation of s-Server. You will need to move this file from the old installation directory to the new installation directory before you uninstall the old version. Some users may have also modified bin/defineAspenRuntime.sh and need to move this file as well.

  • Identify the directories where s-Server will be installed. By default, if you are installing as sudo (see below) s-Server installs into the /opt/ directory. Most users can accept the default options. See the topic Appendix: SQLstream s-Server Installation Directories in this guide for more detail.

Installing as Sudo/Root vs. Installing as a Regular User

For most production environments, you will want to install s-Server as sudo, as doing so lets you run s-Server run as a service called s-serverd. With this option, the system logs will also be written under /var/log.

In some cases, you might wish to install as a regular user, particularly if

  • You are a developer, and you know that only you are going to use the server. Usually, you would do so as a trial. In this case, you would install s-Server in your own user directory and have access to all the files yourself.
  • You need to install multiple servers on the same computer and you want to manage them under separate users. (This is not a common use case, and it would be best to consult SQLstream technical support if you are doing so.)

Installing and Running Client Tools and s-Studio

You can install and run client tools and s-Studio as a regular user. These connect to s-Server through JDBC.

Using a Linux Server with a Windows Machine

s-Server requires Linux to run. s-Studio can be located on either a Windows or Linux machine as long as it can connect to s-Server via JDBC.

StreamLab and s-Dashboard are client-side technologies which communicate with s-Server via webAgent. StreamLab and s-Dashboard can all be run on the same machine as your Web Server. webAgent streams data from s-Server to s-Dashboard or other browser-based clients. Because webAgent consumes resources, you may want to install it on one or more separate servers for load balancing. Because it communicates with s-Server via JDBC and s-Dashboard via HTTP, you can locate webAgent anywhere as long as it can connect to s-Server via JDBC. When installing as sudo, you can install and run webAgent as a service, webAgentd. When installed as sudo, webAgentd runs as the sqlstream user, but you can run webAgent as a regular user.

StreamLab lets you view and manipulate streams through a browser.

Launching the Installer

The easiest way to launch the installer is by initiating the installation file from the command line. You can also install in text mode if you do not have or do not wish to use X-windows.

Proceed with the installation by performing the following steps: - Give the installation file permission to run by entering chmod +x sServer-<%VERSION%>-x64.run. - From a terminal prompt enter sudo ./SQLstream-sServer-X.Y.Z-x64.run, where X.Y.Z represent the release and version numbers, as in SQLstream-, and x64 or x32 represents a 64-bit or 32-bit operating system.

Note: You can run the installer as a normal user on most Linux systems for demonstration purposes, but if you are running a production environment, you will likely want to install as sudo. Installing as sudo lets you run the sserver.d service and install into the recommended /opt location. See - Managing s-Server as a Service for more details.

If the installer does not launch, see the topic - Troubleshooting Installation for suggestions. A Welcome page appears, introducing the Setup Wizard.

  1. Click Forward. The SQLstream license text appears in a new dialog box.
  2. Click the radio button next to I Accept the Agreement and then click Forward. The Select Components page appears. By default, all SQLstream components are selected for installation. If desired, deselect any components that you do not wish to install.
  3. Click Forward. The Registration Information Page opens. SQLstream requires you to enter a valid email address in order to verify your registration.
  4. Enter a valid email address and click Forward. The Installation Directories page appears. This page lets you select directories for the installation itself, the s-Server object database, and the s-Server’s trace log files. Note: the installation user must have permission for these directories.To change directories, click the browse button to the right of the directory field. The installer defaults to /opt/ (pictured below) if you are installing as root (RedHat/CentOS) or using sudo (Ubuntu/Debian). Note: If the installation directory contains a previous installation of s-Server, the installer will ask you if you want to overwrite the directory. If you choose to do so, all customizations and catalog object definitions for the previous installation will be lost.
  5. Click Forward. The Server Port Number page appears. By default, port is set to 5570. We recommend leaving it set to this port unless you have a reason to not do so.
  6. Click Forward. The Java Development Kit (JDK) Home Directory page appears. JDK Home Directory should be filled in with your current JDK directory.
  7. Click Forward. If you are installing as root or using sudo, the Service/Daemon page appears. This page lets you specify whether s-Server should start when this computer starts. Choose Yes to have the installer create a service so that s-Server starts automatically when the system boots. This service can automatically start when the installer finishes.
  8. Deselect as desired, and click Forward. The webAgent Service/Daemon page appears. The SQLstream webAgent allows s-Server to communicate with a browser. If you are going to run any browser-based applications such as s-Dashboard, StreamLab, or the Mochi demonstration application, you need to run webAgent.
  9. Change options if desired and click Forward. The Create Dashboard Service page opens. The Dashboard service lets you create and view visualizations with s-Dashboard. For more information, see The s-Dashboard Guide.
  10. Change options if desired and click Forward. The Server User page appears. This page requires that you specify a user for the installation. This user must have permissions for the installation directories specified earlier.
  11. Enter a user with such permissions and click forward.
  12. Select I accept the agreement and click Forward. The Oracle JDBC Driver License page opens. Here, you need to accept the license for this driver. Installation will not proceed if you do not accept this license.
  13. Select I accept the agreement and click Forward. The Teradata JDBC Driver License page opens. Here, you need to accept the license for this driver. Installation will not proceed if you do not accept this license.
  14. Select I accept the agreement and click Forward. The Ready to Install page opens.
    1. Click Forward to begin the installation process, which then displays a progress bar to show you how far along installation has progressed.

Installation is complete when the progress bar reaches 100%. You will see a confirmation dialog box.

Click Finish to exit the installer and/or view the Readme file.

The first time you run the server, it creates a checkpoint. Before you run the server for the first time, you cannot restore the catalog because no checkpoint exists.

s-Server and JDBC Drivers

The SQL/MED plugin lets SQLstream s-Server interface with third-party databases such as Oracle, Microsoft SQL Server, PostgreSQL, MySQL, and Teradata. The s-Server installer includes JDBC drivers for Oracle, Microsoft SQL Server, Teradata, and PostgreSQL SQL. Those drivers require no additional steps to use. In order to use other JDBC drivers with SQLstream s-Server, you need to copy all required jar files to the $SQLSTREAM_HOME/corelib directory and restart s-Server.

Installing the MySQL JDBC Driver

To use the MySQL JDBC driver, download the driver package from http://dev.mysql.com/downloads/connector/j/ Next, copy the file *mysql-connector-java.jar *to $SQLSTREAM_HOME/corelib and restart s-Server.

Note: s-Server is currently defined to use mysql-connector-java-3.1.14-bin.jar. If you are using a version of mysql-connector other than this one, you will need to edit a script in $SQLSTREAM_HOME/bin/ called defineAspenRuntime.sh. To do so, open this script in a text editor and search for “mysql”. The line you need to change is as follows:

MYSQL_DRIVER=$EIGEN_HOME/thirdparty/mysql-connector/mysql-connector-java-3.1.14-bin.jar

Note: Some Linux distributions include the MySQL JDBC driver as part of their installation package. If this is the case for your Linux distribution, then copy the file /usr/share/java/mysql-connector-java.jar to $SQLSTREAM_HOME/corelib and restart s-Server.##

Confirm s-Server Is Running

To confirm that SQLstream s-Server is running, do one of the following:

  • Check if s-Server appears in SQLstream s-Studio.
  • Use jps -l to confirm that “AspenVJdbcServer” is running. (This is the actual name of s-Server.)

Start SQLstream s-Studio

Once the SQLstream s-Server is started, you can open SQLstream s-Studio by double-clicking its desktop icon or by running the SQLstream script from any directory. When you launch s-Studio, you will need to enter connection information for your installation of s-Server. If the server is running, s-Studio should connect to it and its icon will appear in the left pane of s-Studio:

Use jps -l

SQLstream s-Server runs as a Java Virtual Machine called  AspenVJdbcServer*. To confirm that SQLstream s-Server is running, you can use the Java jps -l command. (See https://docs.oracle.com/javase/8/docs/technotes/tools/unix/jps.html for more detail on this command.) Since s-Server runs as the sqlstream user, you will need to run jps-l it as sudo in order to see s-Server running. This command will produce something like the following if s-Server is running:

6301 sun.tools.jps.Jps
2560 com.sqlstream.aspen.server.AspenVJdbcServer

Installation Logs

While install is running, the install log is in tmp/bitrock_installer.log. After install completes, the install log is in the installation directory as install.log.

System Logs

Provided the server being installed on uses rsyslog (most Linux installations do) and if the server provides a directory for add-on syslog configurations the installer will place a sqlstream.conf file in /etc/rsyslog.d, and reload the rsyslog service as part of the install.

This will produce a timestamped console.log in /var/log/sqlstream/console.log in addition to the normal syslog entries in the messages file and any daemon trace logs defined on the system. You can edit /etc/rsyslog.d/sqlstream.conf to point the console output to a different file if desired.

Uninstalling SQLstream s-Server on Linux

When to Uninstall

You should always uninstall SQLstream before installing a newer version or patch.

How to Uninstall s-Server

To uninstall s-Server, either log in as root (CentOS/Redhat) or use sudo (Debian/Ubuntu), navigate to the directory in which you installed s-Server and enter the following command:  ./SQLSTREAM_HOME/uninstall where “SQLSTREAM_HOME” is the name of the installation directory, such as opt/sqlstream/.XXX.

Note: You can also uninstall in text mode by appending –mode text to the above command. s-Server asks for your verification.

When you click Yes, all s-Server components are uninstalled.

It is then possible to install your new or upgraded version of SQLstream.

The processes for uninstalling s-Studio or client tools in a standalone installation are different. See the topics Uninstalling s-Studio in a standalone installation and Uninstalling clienttools in a standalone installation in this guide for more details.