Installing the SQLstream s-Server

<< Click to Display Table of Contents >>

Navigation:  Installing SQLstream Blaze >

Installing the SQLstream s-Server

Previous pageReturn to chapter overviewNext page

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. See Installing s-Server in this guide for more details.

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.

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.

Before continuing, check that all the preparation steps listed in Preparing to Install have been followed.

Proceed with the installation by performing the following steps:

1.Give the installation file permission to run by entering chmod +x sServer-5.1.0-x64.run.
2.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-5.1.0, 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.

3.Click Forward. The SQLstream license text appears in a new dialog box.

inst_installer_accept_license

 

4.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.

inst_installer_select_components

5.Click Forward.

The Registration Information Page opens. SQLstream requires you to enter a valid email address in order to verify your registration.

inst_installer_enter_email

6.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).

inst_installer_installation_directory

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.

8.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.

inst_installer_port_number

9.Click Forward.

The Java Development Kit (JDK) Home Directory page appears. JDK Home Directory should be filled in with your current JDK directory.

inst_installer_jdk_dir

10.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.

inst_installer_service_daemon

11.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.

inst_installer_web_agent_daemon

12.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 s-Dashboard Guide.

inst_installer_sdashboard_daemon

13.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.

inst_installer_server_user

14.Enter a user with such permissions and click forward.

The Microsoft SQL Server 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.

inst_installer_microsoft_jdbc

16.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.

inst_installer_oracle_jdbc

17.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.

inst_installer_teradata_jdbc

17.Select I accept the agreement and click Forward.

The Ready to Install page opens.

inst_installer_ready_to_install

18.Click Forward to begin the installation process, which then displays a progress bar to show you how far along installation has progressed.

inst_installer_installing

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

inst_installer_completed

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

You are now ready to use s-Serer. The What is Next? section will direct you to Getting Started with SQLstream.

Note: 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.

Install Log

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

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.