Home
Administering
Administer the product by using the Teracloud® Streams graphical user interface, APIs, or the streamtool command-line interface.
Instances
To create and manage instances, you can use the Streams Console or the streamtool command-line interface.
Creating instances
Use the Streams Console or the streamtool mkinstance command to create a Teracloud® Streams instance. When you create an instance you specify the instance name and properties and the resources that run the instance.
Resource specification options
The Streams Console and the streamtool mkinstance command provide several options for specifying the static resources in a Teracloud® Streams instance.

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.
- Domains
  After you create a Teracloud® Streams domain, you can administer it by using the Streams Console graphical user interface and the streamtool command-line interface.
- Resources
  After you add resources to domains and instances, you can administer them by using the Streams Console or the streamtool command-line interface.
- Instances
  To create and manage instances, you can use the Streams Console or the streamtool command-line interface.
  - Instance identifiers
    An instance name or identifier is the name that you specify when you create an instance.
  - Creating instances
    Use the Streams Console or the streamtool mkinstance command to create a Teracloud® Streams instance. When you create an instance you specify the instance name and properties and the resources that run the instance.
    - Resource specification options
      The Streams Console and the streamtool mkinstance command provide several options for specifying the static resources in a Teracloud® Streams instance.
    - Creating a host specification file from compiled applications
      You can use the streamtool mkhostfile command to generate a host file that is based on the host and host pool specifications in a stream application.
  - Starting and stopping instances
    To run Teracloud® Streams, you must start a Teracloud Streams instance.
  - Monitoring instances
    You can monitor the status and health of your Teracloud® Streams environment and capture the information for offline viewing and analysis.
  - Updating instance properties
    After you create a Teracloud® Streams instance, you can configure it by updating its properties.
  - Removing instances
    When you remove a Teracloud® Streams instance, the instance record in the configuration repository is removed along with all persistent instance state information.
- Domain and instance services
  Before you can perform Teracloud® Streams tasks, Teracloud Streams domain and instance services need to be running on resources in the domain. Domain services are started by starting the domain and instance services are started by starting the instance.
- Jobs
  You can start and administer jobs by using Streams Console or the streamtool command-line interface.
- Recovery
  You can back up your Teracloud® Streams system files and directories and then restore them later if necessary. In general, you can recover from application and runtime failures without restoring Teracloud Streams from a backup.
- Streams Console
  You can use the Streams Console to monitor and manage the Teracloud® Streams instances and applications in your domain from any computer that has HTTP connectivity to the server that is running the web management service.
- Logs and traces
  Teracloud® Streams provides options that enable administrators, instance owners, and application developers to manage log and trace data.
- Managing and monitoring Teracloud® Streams using management APIs
  Teracloud® Streams provides two API sets to manage and monitor Streams services and jobs.
Developing
Develop stream applications with the Streams Processing Language (SPL), Java, and Python.
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.
Glossary
Use this glossary to find terms and definitions for Teracloud® Streams.

Resource specification options

The Streams Console and the streamtool mkinstance command provide several options for specifying the static resources in a Teracloud® Streams instance.

To specify the static resources in a Teracloud® Streams instance, you can use one of the following streamtool mkinstance command options:

--host: Specifies one or more host identifiers. A host identifier can be a host name or IP address.
--numresources: Specifies to get the designated number of available resources from the domain. You can also specify optional resource selection criteria.
--hfile: Specifies the path to a file, which can contain host identifiers and --numresources specifications.

If you do not specify static resources when you create the instance and if dynamic resource allocation is not enabled, the following resource specification is created when the instance starts: --numresources 1.

When you use the --numresources option, you can specify optional resource selection criteria. For example, you can specify tags, which provide you with more explicit control over resource selection. You can use tags to customize how Teracloud® Streams distributes instance and application services on your resources. You can also specify the resource sharing mode: shared or exclusive. Resources are shared by default. If you use the exclusive sharing mode, the instance obtains resources that are not used by any other instance in the domain.

Attention: The preferred configuration for optimal performance is to reserve some resources exclusively for Teracloud® Streams management services and some resources exclusively for running applications by tagging them appropriately. Sharing resources across multiple instances can also affect performance.

By default, Teracloud® Streams assigns the required instance services to the resources you configure for your instance. For most configurations, this distribution is sufficient.