Home
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.
Domain identifiers
A domain name or identifier is the name that you specify when you create a domain.

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.
  - Domain identifiers
    A domain name or identifier is the name that you specify when you create a domain.
  - Creating domains
    Before you use Teracloud® Streams, you must create at least one domain.
  - Adding hosts to a domain
  - Monitoring domains
    Use the streamtool getdomainstate command to view the status of a Teracloud® Streams domain, its resources, and services.
  - Updating domain properties
    After you create a Teracloud® Streams domain, you can configure it by updating its properties.
  - Removing domains
    When you remove a domain, all of the instances and jobs in that domain are removed too.
- 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.
- 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.

Domain identifiers

A domain name or identifier is the name that you specify when you create a domain.

Requirements for domain identifiers

When you create a domain, you must specify an identifier that satisfies the following requirements:

The name must contain alphanumeric characters. You cannot use the following alphanumeric characters: ^!#$%&'*+,/;<>=?@[]`{|}~(). You also cannot use the following Unicode and hexadecimal characters: u0000; u0001-u001F; u007F-u009F; ud800-uF8FF; uFFF0-uFFFF; x{10000}-x{10FFFF}.
The name cannot be zookeeper.
The maximum length of the name is 255 bytes.
The name must be unique among the domains that are defined by you, the domain owner, within ZooKeeper.
Note: If a resource is allocated to two or more domains that have the same name, this situation causes problems with the log files. The problem occurs irrespective of whether the domains are in the same ZooKeeper ensemble. Use unique domain names or ensure that the domainLog.path domain property value is unique for domains that have the same name.

Teracloud® Streams default domain identifier

If you do not specify a domain identifier when you run streamtool commands, Teracloud® Streams uses the value that is set in the STREAMS_DOMAIN_ID environment variable. By default, that domain identifier is StreamsDomain. If you are using the interactive streamtool interface, it uses the name of the active domain for the current streamtool session or else it prompts you for the domain name. The active domain for the current streamtool session is set every time that you successfully run a streamtool command with a -d or --domain-id option. Alternatively, you can run the steamtool domain command.

By default, the default domain ID is set when you run the streamsprofile.sh script after you install Teracloud® Streams. To set or change the value of the default domain ID, specify -d domain-id on the source streamsprofile.sh command, for example:

  source streamsprofile.sh -d MyDomain

To reset the default domain ID to StreamsDomain, enter the following command:

  source streamsprofile.sh -r