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.
Monitoring instances
You can monitor the status and health of your Teracloud® Streams environment and capture the information for offline viewing and analysis.
Instance status values
Instances have state values that provide information about their status.

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.
  - 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.
    - Instance status values
      Instances have state values that provide information about their status.
    - Status, performance, and connection output data
      The output from the streamtool capturestate command is XML information about the status of the resources and jobs in a Teracloud® Streams instance. The output also contains metrics for the resources and jobs.
  - 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.

Instance status values

Instances have state values that provide information about their status.

Table 1. Instance states
Instance state	Description
FAILED	All resources in the instance failed.
PARTIALLY_FAILED	Some resources failed or partially failed, or all resources partially failed.
PARTIALLY_RUNNING	Some resources in the instance do not report as running, but no resource in the instance reports as failed or partially failed. The non-running resources might be partially running, quiesced, or in a transition state such as starting or stopping.
RUNNING	All resources in the instance are running.
STARTING	The resources in the instance are being started.
STOPPED	The instance is not started.
STOPPING	All resources in the instance are being stopped.