teracloudaps/streams-qse repository overview

⁠Teracloud® Streams Quick Start Edition (QSE)

Teracloud Streams is an enterprise-grade data stream processing platform that enables organizations to handle real-time data.

Teracloud Streams QSE is a free, non-production version of Teracloud Streams.

The QSE provides a Streams installation and a running Streams domain and instance when started. This means with the QSE, you can:

• Develop streaming data applications using Streams Processing Language (SPL) or in other supported languages, such as Java™ or Python.
• Run applications in stand-alone mode or submit applications to a Streams instance.
• Get familiar with the streamtool command-line interface.
• Monitor the health of submitted applications and services using the Web Console.
• Explore and use the management REST API.

⁠Requirements

• x86_64 architecture
• A container runtime
  • For desktops, it is recommended to use one of the Docker, Podman, or Rancher Desktop applications which are available for Windows, Mac, and Linux operating systems.

⁠Restrictions

Macs with Apple silicon may experience issues with the QSE.

The QSE is a single-node Streams instance, so running large or many applications might perform poorly or crash due to lack of resources. For a distributed, multi-node environment, consider using a licensed Teracloud Streams installation. For more information, contact the Streams team⁠.

⁠Getting Started

⁠Running the container

In a command prompt, run:

docker run -d -p 8443:8443 -p 9714:9714 --name streamsqse --hostname localhost docker.io/teracloudaps/streams-qse:latest

The command forwards ports 8443 and 9714 for Console and REST API access.

Users may want to mount a volume or local directory to the container to persist applications and compiled output across the container lifecycle. To do this, include the -v option with the source directory and destination on the container. For example, to mount a local directory called applications to /apps inside of the container, run:

docker run -d -p 8443:8443 -p 9714:9714  -v ./applications:/apps  --name streamsqse --hostname localhost docker.io/teracloudaps/streams-qse:latest

⁠Monitoring domain and instance bring up

Once you start the container, it begins to create a domain and instance. This can take several seconds, so you may wish to monitor the container logs to see the status:

docker logs -f streamsqse

⁠Accessing the Streams console

Go to https://localhost:8443/streams/domain/console⁠

The user is streamsadmin and the default password is streams1

⁠Accessing the container to run streamtool

To run streamtool commands inside the container, run:

docker exec -it streamsqse /bin/bash

⁠Installing additional software in the container

In cases where the QSE does not provide software required for your Streams app, you can install additional software by running:

sudo dnf install <package>

⁠Attaching VS Code to the QSE

You can attach a VS Code window to a running QSE and leverage the development tools provided by the Teracloud Streams VS Code Extension⁠ to help you develop, build, and test applications.

Follow the instructions here⁠ to get a VS Code window attached to your QSE.

⁠Additional resources

• Teracloud Streams website⁠
• Teracloud Streams documentation⁠
• Teracloud Streams developer tools website⁠