IBM Streams QSE

What is IBM Streams Quick Start Edition?

IBM Streams Quick Start Edition is a free, non-production version of IBM Streams. With no data or time limits, You can experiment with stream computing in your own environment.

You can use the Quick Start Edition to develop and run applications that process information in data streams. You develop your stream processing applications in the IBM Streams Processing Language (SPL) or in other supported languages, such as Java™,Scala or Python. IBM Streams includes the Streams Studio integrated development environment (IDE) and toolkits that extend the functionality. IBM Streams also includes an integrated console that you can use to view the health of the instances and applications in your domain.

Restrictions

• Streams Quick Start Edition is licensed for development purposes only.
• Streams is an enterprise-level application that is developed for a multi-node environment. When you run Streams in a single-node Quick Start Edition Docker environment, large applications might perform poorly or crash due to lack of resources. If you are developing large applications and projects, consider using a licensed IBM Streams on-premises environment or IBM Cloud services.

Getting Started

Requirements

• Windows 10, MacOS El Capitan 10.11, or later; or Linux
• Docker community edition (Docker CE), available from Docker⁠

Docker configuration

• 4 CPUs minimum.
• 8 GB memory.
• 20 GB minimum disk space
• If you use mapped directories, configure Docker to allow mapped directories. Mapped directories save internal Docker storage and provide convenient upgrade management, backup, and file sharing.

Command for downloading and starting the container (Mac or Linux)

Note: in the following command replace <version> with one of the following:

• 4.3.1.4
• 4.3.1.1
• 4.3.1.0
• 4.3.0.0
• 4.2.4.0

Replace <user> with your user name

Container without mapped directories:

docker run --shm-size=4g --security-opt seccomp=unconfined  --privileged -d -v /sys/fs/cgroup:/sys/fs/cgroup:ro -p 8443:8443 -p 9975:9975 -p 8006-8016:8006-8016 -p 8444:8444 -p 8080:80 -p 5905:5901 -p 4022:22 --name streamsdocker<version> -h 'streamsqse.localdomain' ibmcom/streams-qse:<version> INSTALL

Container with mapped directories:

The command is based on using the following mapped directories:

/home//Documents/DockerMapped/workspace

/home//Documents/DockerMapped/hostdir

docker run --shm-size=4g --security-opt seccomp=unconfined  --privileged -d -v /sys/fs/cgroup:/sys/fs/cgroup:ro -v /home/<user>/Documents/DockerMapped/workspace:/home/streamsadmin/workspace -v /home/<user>/Documents/DockerMapped/hostdir:/home/streamsadmin/hostdir -p 8443:8443 -p 9975:9975 -p 8006-8016:8006-8016 -p 8444:8444 -p 8080:80 -p 5905:5901 -p 4022:22 --name streamsdocker<version> -h 'streamsqse.localdomain' ibmcom/streams-qse:<version> INSTALL

Command for downloading and starting the container (Windows)

Container without mapped directories

docker run --shm-size=4g --security-opt seccomp=unconfined  --privileged -d -v /sys/fs/cgroup:/sys/fs/cgroup:ro -p 8443:8443 -p 9975:9975 -p 8006-8016:8006-8016 -p 8444:8444 -p 8080:80 -p 5905:5901 -p 4022:22 --name streamsdocker<version> -h 'streamsqse.localdomain' ibmcom/streams-qse:<version> INSTALL

Container with mapped directories:

The command is based on using the following mapped directories:

C:<user>\Documents\DockerMapped\workspace
C:<user>\Documents\DockerMapped\hostdir

docker run --shm-size=4g --security-opt seccomp=unconfined  --privileged -d -v /sys/fs/cgroup:/sys/fs/cgroup:ro -v //c/<user>/Documents/DockerMapped/workspace:/home/streamsadmin/workspace -v //c/<user>/Documents/DockerMapped/hostdir:/home/streamsadmin/hostdir -p 8443:8443 -p 9975:9975 -p 8006-8016:8006-8016 -p 8444:8444 -p 8080:80 -p 5905:5901 -p 4022:22 --name streamsdocker<version> -h 'streamsqse.localdomain' ibmcom/streams-qse:<version> INSTALL

Ports

Streams internal fixed ports. These ports should not be changed without streams admin knowledge: -p 8443:8443 -p 9975:9975 -p 8006-8016:8006-8016 -p 8444:8444

VNC Server ports: -p 5905:5901. Port 5901 is the listen port for VNC Server inside the Docker container. Port 5905 is the port your host VNC Viewer connects to. For example, localhost:5905. You can change it if port 5905 is already in use.

SSH port: -p 4022:22. Port 22 is the SSH listen port inside of the Docker container. Port 4022 is the ssh port to connect via the ssh client. For example, ssh -p 4022 localhost.

If you need other ports, add them to the docker run command. For example: -p :

First steps

SSH: Use an ssh client to access localhost on port 4022. For example, ssh -p 4022 streamsadmin@localhost

VNC: Use a VNC viewer client to access port 5905.

When you access the Docker container with VNC, you are presented with a default desktop at a resolution that might not be optimal. To adjust the resolution:

1. From the Start Menu, go to Applications > System Tools -> Settings.
2. Select Devices, and then click the Displays icon.
3. Click Resolution.
4. Select a desired resolution and close the window.
5. Click Apply, and then Keep Settings.

On the desktop, the Streams tools and utilities are located on the Applications > Favorites menu, which you can access from the Start Menu

Passwords and security

By default, all passwords are passw0rd. You can change the passwords and change all ssh keys by opening a terminal and running the following commands:

• passwd: Follow the prompts to change streamsadmin system password.

• vncpasswd: Follow the prompts to change the streamsadmin VNC password.

• ssh-keygen -t rsa: Press the Enter key to accept the default to overwrite the rsa ssh keys.

• ssh-keygen -t dsa: Press the Enter key to accept the defaults to overwrite the dsa ssh keys.

• su - root: Change to root user, and run these commands:

  • paswd: Follow the prompts to change the root system password.

  • ssh-keygen -t rsa: Press the Enter key to accept the defaults to overwrite the rsa ssh keys.

Container management

The following commands are for managing the container:

• Pause the container: docker pause streamsdocker4314

• Resume the container: docker unpause streamsdocker4314

• Stop the container: docker stop streamsdocker4314

• Start the container: docker start streamsdocker4314

Important: When you start the container, the IBM Streams domain and instance are also started. This process might take several minutes. To prevent errors, wait until the domain and instance are started. On the VNC desktop, you can see the yellow desktop icon (Streams Domain Starting) while the domain is starting. The icon turns green (Streams Domain Started) when the domain is ready, and then eventually disappears.

If you need to re-create the container or the image (for example for a reinstallation), the following commands are useful:

• Stop the container: docker stop streamsdocker
• Remove the container: docker rm streamsdocker
• Remove the image: docker rmi streams-qse:

Next steps

After you are up and running with the Quick Start Edition, get started using Streams by following the Quick Start Guide⁠. This guide teaches basic Streams concepts as well as Streams Processing Language (SPL).

Development guides also exist for Java⁠ and Python⁠.

For technical issues, post your questions to the Streamsdev forum⁠.

For more articles, videos and tutorials, visit Streamsdev,⁠ the Streams developer community.

For alternative installation methods see Installing Streams Quick Start Edition with Docker⁠.

End User License

IBM Streams Quick Start Edition is licensed for development purposes only and it is not intended for production use. Go here to view and accept⁠ the End User License. Note: By downloading and running this instance, you are agreeing with all the terms and conditions of our license referenced above.

License The Dockerfile and associated scripts are licensed under the Apache License 2.0.⁠ IBM Streams Quick Start Edition is licensed under the IBM International License Agreement for Non-Warranted Programs. This license for IBM Streams Quick Start Edition can be found online⁠.