streamtool startinstance

Usage

startinstance [-d,--domain-id <did>] [-i,--instance-id <instance>] [--version <version>] [-U,--User <user>] [-h,--help] [--trace <level>] [-v,--verbose <level>] [--zkconnect {<host>:<port>},... | --embeddedzk]

The streamtool startinstance command starts an Streams instance.

Authority

You must have write authority for the instance object. By default, the DomainAdministrator and InstanceAdministrator role has this authority. For more information about access control lists, see streamtool getacl.

Description

When you start an Streams instance, instance services start on the appropriate resources. You can manage which services run on specific resources by using tags. For example, you can apply the view tag to a resource so that it runs the view service. To change the tags that are associated with resources in an instance, use the streamtool chhost command.

If you configured Streams to use Secure Shell (SSH) and a shared file system, you must have SSH connectivity to all of the hosts. SSH must be set up so that password prompting does not occur.For more information about configuring an SSH environment for Streams, see the product documentation.

The started (remote) runtime services inherit the umask value of the process that is running the streamtool startinstance command.That umask value is recorded and then used by operations such as streamtool addhost while the instance is started.

The locale of an instance or domain is based on the LANG environment variable for the user that started the instance or domain. If the domain.localeOverride domain property is set, this property value is used for the locale of the domain and instances.

If the instance is started, the command fails.

Options

-d,--domain-id <did>
Specifies the domain identifier.

If you do not specify this option, Streams uses the domain name that is set in the STREAMS_DOMAIN_ID environment variable. By default, that domain name 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 streamtool domain command in the interactive interface.

--embeddedzk

Specifies to use the embedded copy of ZooKeeper. This option is not supported within the interactive streamtool interface.

If you are not using the interactive streamtool interface and you do not specify either this option or the --zkconnect option, Streams uses the ZooKeeper connection that is associated with the active domain or the domain that is specified in the --domain-id option. Streams determines which connection maps to the domain by using cached information about the domains. In this scenario, if the domain identifier is not unique in the Streams configuration cache, the command fails.

-h,--help
Specifies to show the command syntax.
-i,--instance-id <instance>
Specifies the instance identifier.

If you do not specify this option, Streams uses the instance identifier that is set in the STREAMS_INSTANCE_ID environment variable. By default, that instance identifier is StreamsInstance. If you are using the interactive streamtool interface, it tries to use an instance ID that you specified in a previous command. If no such value is found, the command uses the STREAMS_INSTANCE_ID environment variable. Alternatively, you can run the streamtool instance command in the interactive interface.

--trace <level>
Specifies the trace setting. The following valid levels are listed in order of increasing verbosity, which is to say that the first level in the list generates the least amount of information:
  • off
  • error
  • warn
  • info
  • debug
  • trace
The default value is off.
-U,--User <user>
Specifies an Streams user ID that has authority to run the command.
-v,--verbose <level>
Specifies to provide more detailed command output. The verbosity level can be 0-3, where 0 disables detailed reporting and each increment provides more detailed output.
--version <version>
Specifies an installation version for starting the instance.
--zkconnect <{<host>:<port>},...>

The name of one or more host and port pairs that specify the configured ZooKeeper servers. This option is not supported within the interactive streamtool interface.

If you are not using the interactive streamtool interface and you do not specify this option, Streams tries to use:

  1. The --embeddedzk option
  2. The value from the STREAMS_ZKCONNECT environment variable
  3. A ZooKeeper connection string that is derived from cached information about the current domain.