Home
Reference
Find details on the SPL language, toolkits, APIs, commands, and more.
Toolkits
A toolkit is a set of SPL artifacts, which are organized into a package. Toolkits make SPL or native functions and primitive or composite operators reusable across different applications.
Toolkits
Toolkit com.teracloud.streams.network 5.1.1
Running applications with operators requiring Linux capabilities

Welcome
Learn about the core capabilities of Teracloud® Streams, its architecture, and key concepts.
Installing
Use this information to install, upgrade, and uninstall the Teracloud® Streams product.
Configuring
Create a basic or an enterprise domain which is a single point for configuring and managing common resources, security, and instances.
Administering
Administer the product by using the Teracloud® Streams graphical user interface, APIs, or the streamtool command-line interface.
Developing
Learn about different Teracloud Streams tools and features to write, compile, run, and test streams applications.
Troubleshooting
Resolve problems with Teracloud® Streams using the troubleshooting tools provided with the product as well as the resources offered by Teracloud Support.
Reference
Find details on the SPL language, toolkits, APIs, commands, and more.
- APIs
  Application programming interfaces (APIs) provide functions that simplify applications development.
- Job configuration overlays
  You can specify or change configuration parameters when you use the submitjob or updateoperators operations. The settings control submission constraints, host constraints and locations, and operator status. Parameters are captured and updated in the configuration JSON file. When you change the values in the job configuration overlay file, the changes override any previously set values.
- Commands
  Teracloud® Streams provides a number of commands you use to perform tasks.
- Metrics
  Teracloud® Streams provides metrics to help evaluate the health of Teracloud Streams services, to aid in diagnosing performance issues, and to analyze throughput of requests. You can use the streamtool checkinstancemetrics, streamtool checkdomainmetrics, streamtool getdomainmetrics, and streamtool checkresourcemetrics commands to view the metrics data.
- Operator model
  An operator model is an XML document that describes the basic properties of a primitive operator.
- Streams Processing Language (SPL)
  Streams Processing Language (SPL) is a distributed data flow composition language that is used in Teracloud® Streams. SPL has primitive types, program structures, and definitions that are tailored for streaming data.
- SPL Compiler
  The SPL compiler is an incremental compiler that generates artifacts needed to run your stream application. These artifacts include, for example, C++ code for several entities in your SPL program and an application bundle file.
- Toolkits
  A toolkit is a set of SPL artifacts, which are organized into a package. Toolkits make SPL or native functions and primitive or composite operators reusable across different applications.
  - Specialized toolkit requirements and restrictions
    Several of the specialized toolkits require RPMs that are not required by the Teracloud® Streams product. There are also toolkit restrictions on some platforms.
  - Toolkits
- SPLDOC markup
  You can use SPLDOC markup in the descriptions associated with the SPL artifacts in a toolkit. The spl-make-doc command generates HTML documentation from the marked up artifacts.
Glossary
Use this glossary to find terms and definitions for Teracloud® Streams.

Running applications with operators requiring Linux capabilities

The following operators require special privileges (Linux capabilities) to interact with raw network packets and kernel drivers:

There are different steps to enable Linux capabilities for Streams applications based on how they are run.

Distributed

For distributed Streams applications, the Streams runtime must grant capabilities to the program before executing it. This requires 'root' privileges. To do this:

The Streams domain must be registered as a Linux system service
The Streams instance must have the property instance.canSetPeOSCapabilities set to 'true'
The Streams instance must have the property instance.runAsUser set to the desired username (generally $USER)
The Streams instance must have the property instance.applicationBundlesPath set to a directory under /tmp

The Streams runtime will automatically identify which capabilities are needed for the application when launching the PE.

Standalone

For standalone Streams applications, Linux capabilities can be granted to programs if the Linux kernel and file system where the application is located support extended file attributes.

To grant Linux capabilities to the application:

Root privileges are required
The SAB must be unpacked with the spl-app-info command into a directory on an extended file attribute-supported file system (e.g., on a local disk volume such as /tmp)
Use setcap as root or with sudo to grant the necessary capabilities. For example, sudo setcap 'CAP_NET_RAW+eip CAP_NET_ADMIN+eip' .../bin/standalone.exe

The set of capabilities depends on what operators are used. See the Properties section of the individual operators for the full list of required capabilities.

On systems that do not support extended file attributes, standalone applications can be run as root


sudo STREAMS_INSTALL=$STREAMS_INSTALL .../bin/standalone.exe