Installing the SQLstream AMI

The Guavus SQLstream Trial AMI is an Amazon Machine Image that contains an Ubuntu Server with Oracle JDK 1.8 and lsb-core installed, and SQLstream s-Server, and SQLstream StreamLab installed in the Ubuntu environment. In runs in the Amazon Compute Cloud, known in shorthand as EC2. Amazon Machine Images run as virtual machines in the cloud.

For more information, see http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIs.html.

Cost

The Trial AMI runs in your own AWS EC2 account. You pay the charges for the underlying EC2 VM, but you pay nothing to SQLstream. The AMI operates as a free trial, using a 60 day trial license assuming you register your installation.

When you are ready to use a SQLstream AMI in production, you may either purchase a suitable license directly from SQLstream support, and install it on this AMI, or you can start a "Pay as You Go" pre-licensed SQLstream AMI - its cost will include a proportion for the license. See Using the AWS Marketplace Guavus SQLstream AMI.

What You Need

To use the Guavus SQLstream Trial AMI, it is helpful, but not mandatory, to have experience with Amazon EC2. If you haven't worked with EC2 before, you will need to both create an Amazon Web Services account and generate a public/private keypair for EC2. These are explained below.

Amazon Web Services Account

To access the Guavus SQLstream Trial AMI you first need an Amazon Web Services account. Once you have your AWS account set up, contact SQLstream support and give us your AWS account number. SQLstream support will enable then access to the Guavus SQLstream AMI for your AWS account.

Note: The AMI default location is Northern California. If you need your AMI to be accessed from a different region, please let technical support know when you give them your account number.

EC2 Key Pair

Amazon EC2 uses public/private key crytography to secure login data. To log into an instance on EC2, you will need a public/private keypair. If you have used AWS in the past, you likely have one of these. They can also be created through the AWS site. See http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html for more details.

Launching Guavus SQLstream

For more information on launching images, see http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/launching-instance.html.

Contents of AMI

The Guavus SQLstream AMI is built on an Ubuntu Server with Oracle JDK 1.8.0_25 installed manually. Everything else (other than the SQLstream software) is installed from standard Ubuntu packages.

In order to accommodate s-Server's installation requirements, the following are preinstalled:

  • lsb-core
  • lighttpd
  • php5-cgi

The installers for Guavus SQLstream are also included:

  • SQLstream-sServer--x64.run
  • SQLstream-StreamLab-<%STREAMLAB_VERSION%>linux-x64.run

Both s-Server and StreamLab are installed as root with --mode unattended, so the following are all started as services on the AMI:

  • s-Server
  • WebAgent
  • s-Dashboard
  • StreamLab

Launching the AMI

The AMI runs as an EC2 virtual server. To launch an instance of the AMI:

  1. Open https://console.aws.amazon.com/ and log in with your Amazon Web Services user name and password. If you do not have an AWS account, you will need to register for one before launching the Guavus SQLstream AMI.
  2. Click EC2 under Amazon Web Services:
    The EC2 dashboard opens.
  3. On the bottom of the page, click the Launch Instance button.
    The AMI launch page opens.
  4. In the left column, click Community AMIs.
  5. Enter "SQLstream" in the search box and press Enter or Return.
    Guavus SQLstream should return as a search result.
  6. Click Select.
  7. Next, select an image type for the AMI. To run the Guavus SQLstream AMI, you should select an image type of at least m3.large. We recommend this minimal requirement for demonstration purposes. For production use, you should choose an image type of m3.xlarge or higher. The key here is the number of virtual CPUs available. m3.large provides two CPUs, which is minimal to run s-Server and a data generator in order to run the Mochi demo.
  8. Click Next: Configure Instance Details. The Configure Instance Details page opens.
  9. In the Configuring Instance Details page, leave settings at their default and click Next: Add Storage.
  10. For demo purposes, you do not need to add additional storage. Accept defaults here and click Next: Tag Instance. Tags help you manage your AWS resources. These are not mandatory. See https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html for more details. The Marketplace Guavus SQLstream AMI has configured a security to allow access to the ports listed below. With the exception of SSH (22) and HTTP(80), all other security groups should be set as a "Custom TCP Rule". Confirm that settings are as follows:

    • 22 (SSH) if you want to be able to get to the shell
    • 80 (HTTP) for the home page
    • 5570 (SDP2) for SQLline and s-Server access
    • 5580 (WebAgent)
    • 5590 (Streamlab)
    • 5591 (StreamLab web socket)
    • 5595 (s-Dashboard)

    Note: Port 22 may be listed by default. The instance will not launch if two security rules are the same.

    The next page asks you to review the instance details.

  11. Once you have reviewed the details, click Review and Launch. The next page presents asks you to select a public/private key pair as described above. If you are new to AWS, you need to generate a new key pair. If you have previously generated an AMI key pair, you can use that one. See http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html for more information on generating key pairs.

  12. Check the box next to I acknowledge that I have access and click Launch Instance.

    Note: In the screenshot above, a public/private key pair named Guavus SQLstream has been previously created.

Accessing the Cover Page

After you launch the instance, follow the steps below in order to access the Guavus SQLstream AMI cover page:

  • Return to the EC2 dashboard and choose Instances in the left column.
  • In the list of instances, find the instance of Guavus SQLstream.
  • To the right, you will see a column labeled Public DNS Address. This will be something similar to ec2-54-193-200-69.us-west-1.compute.amazonaws.com. Select and copy this address and paste it into a browser address bar.

Once you do so, you will see a web page with the SQLstream logo and a list of available options:

Using the SQLstream AMI Launch Page

From the SQLstream AMI launch page, you can do the following:

  • Run the Mochi demo
  • Use StreamLab, using a built-in stream of bus location data.
  • Download s-Studio for Windows to view the server and SQL.

Running the Mochi Demo

The Mochi demonstration application simulates clusters of failed logins at a bank, either by phone or web, as well as withdrawals or debits using the same customer id number. See the topic Running the Mochi Demo for more details. To run the Mochi demo, click the "Start Mochi Demo" link. Like the installation of s-Server, this process takes some time to initiate. We recommend waiting 5 minutes to allow the Mochi demo to start. Next, click the "View Mochi Demo" link. This will open a new tab or window in your browser pointing to the dashboard list. If it fails, it probably means you didn't wait long enough. Close the window, wait a little longer, and try again. When you're done with the demo, you can either use the "Stop Mochi Demo" link to shut it down cleanly, or just terminate the EC2 instance if you're done using it. If you are going to move on to use StreamLab, you need to stop the Mochi demo cleanly.

Running StreamLab

StreamLab is a web application development environment that automatically generates streaming SQL. StreamLab lets you set up projects where you can parse incoming streaming data, generate real time analytics for it, visualize it, so that you can take action on it. See the StreamLab guide for more details.

Viewing Tutorial

The Launch page links to a video tutorial that walks you through using Stream

Using Bus Data

SQLstream provides sample data to use with StreamLab. This is a continually-updating file in JSON format. For more information on using StreamLab with bus data, see the topic Using StreamLab to Build a Streaming Application in the Building Applications guide.

To run StreamLab, click the Try StreamLab link.

Using s-Studio

You can download and install SQLstream s-Studio. Once you do, you can configure s-Studio to connect with your AMI SQLstream instance by taking the following steps:

Copy the JDBC address from the top of the AMI launch page.

  • Launch s-Studio.
  • Right-click First SQLstream Server.

  • Paste the JDBC address into the URL field and click OK.

  • Right-click First SQLstream Server again and select Connect.
  • Studio should connect to s-Server and display a list of schemas, data sources, plugins, and so on.

Terminating the Instance

When you're done using the instance, you should stop it, either from the EC2 Management Console or from the command line

Registering with SQLstream

In order to use Guavus SQLstream, you will need to enter registration information. When you first install SQLstream s-Server, you register for a license, and will receive an email from our license server with a link. See SQLstream s-Server Licensing for more details.

Making Sure Server is Connected

There is an indicator on the AMI home page at the bottom of the Welcome! section right before the Demonstration section, that indicates the status of s-Server. Once s-Server is connected, it will say "Server is listening on port 5570". This indicator will not display a "listening" message until installation completes.