streamtool registerdomainhost

Usage

registerdomainhost [-d,--domain-id <did>] [--ipaddress <ipaddress>] [--tags <tag>,...] [--management] [--application] [--stopped] [--maximumJvmSize <size-in-megabytes>] [--initialJvmSize <size-in-megabytes>] [--restartcount <number>] [-h,--help] [--trace <level>] [-v,--verbose <level>] [--zkconnect {<host>:<port>},... | --embeddedzk]

The streamtool registerdomainhost command registers an Streams resource with a domain, and installs the domain controller service as a system service.

Authority

You must have root authority and must run this command on the host that you want to register.

Description

This command starts the domain controller service. If you specified a domain name that does not exist, the domain controller service is dormant until you create the domain.

If you run the startdomainhost command with the -unregistered option, then run registerdomainhost, the unregistered service is replaced by the registered system service and by default the service is started. If you specify --stopped on the registerdomainhost command, the service is not started and a warning is issued.

Options

--application
Specifies to make the host an application resource. This option is equivalent to specifying --tags application.
-d,--domain-id <did>
Specifies the domain name. If you specify a domain name that does not exist, the command still completes successfully; you can create the domain after you run this command.

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.

--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.
--initialJvmSize <size-in-megabytes>
Specifies the initial amount of memory, in megabytes, to allocate to the Java environment for the Domain Controller system service. By default, the service uses an initial size of 512.
--ipaddress <ipaddress>
Specifies the system service IP address.
--management
Specifies to make the host a management resource. This option is equivalent to specifying --tags management.
--maximumJvmSize <size-in-megabytes>
Specifies the maximum amount of memory, in megabytes, to allocate to the Java environment for the Domain Controller system service. By default, the service uses a maximum size of 1024.
--restartcount <number>
Specifies the maximum number of times to attempt to restart the Domain Controller. By default, the service uses a restart count of 3.
--stopped
Specifies to create the Streams domain controller but not to start it.
--tags <tag>
Specifies a comma-separated list of tags, which the command assigns to the host.
--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.
-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.
--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.

Examples

The following command registers the resource with the domain "StreamsDomain" and assigns the tag "authentication" to the resource:

[streamtool <root@StreamsDomain.StreamsInstance>] registerdomainhost --tags authentication