streamtool mkhostpkg

Usage

mkhostpkg [-d,--domain-id <did>] [--install-dir <installation-directory>] [--pkg-dir <pkg-dir>] [--install-mode <installation-mode>] [--owner <owner>] [--group <group>] [--unregistered] [-h,--help] [--trace <level>] [-v,--verbose <level>] [--zkconnect {<host>:<port>},... | --embeddedzk]

The streamtool mkhostpkg command generates a domain host installation package that you can use to add Streams resources to the domain.

If you are using an external resource manager, use the streamtool mkresourcepkg command instead. It generates a resource installation package that you can use to add externally managed resources.

If you installed the main installation package on a shared file system that is accessible by all resources in the domain, you do not need to create and deploy a domain host installation package. However, you must still run the registerdomainhost command or the startdomainhost command with the --unregistered option on each resource.

Authority

You do not need any authority to run this command.

Description

The command generates a domain host installation package, which contains an streamsdomainhostsetup.sh script and a response file. The response file contains the installation information that you specified in the streamtool mkhostpkg command and helps to simplify the installation process. The script installs the Streams product on the host, registers the host as a resource in the domain, and configures the domain controller service as a system service.

The domain host installation package is generated in the current directory or the directory that you specify in the pkg-dir option. If strong encryption policy files exist in the installation directory, they are included in the package. You must copy this package to all of the hosts that you want to add to the domain.

After you copy the domain host installation package to a host, extract the package. For example, run 
tar xvf
tarfile.tar
. For information about the next steps, see the readme file in the package.

If you specify a path where the product is already installed and you are not installing a new version, fix pack, or interim fix, by default the streamsdomainhostsetup.sh script uninstalls the existing product installation and installs the new package. If you want to cancel the installation in this scenario, add the following property to your response file before you run the script:

VERSION_EXIST_ACTION=0

Options

-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.

--group <group>
Specifies the group identifier that owns the files that are installed by the Streams product. If you do not specify this option, the command uses the installation owner's group.
-h,--help
Specifies to show the command syntax.
--install-dir <installation-directory>
Specifies the path where you want to install the product. The default location is /opt/teracloud/streams. The path does not need to exist before you run the streamsdomainhostsetup.sh script.
--install-mode <installation-mode>
Specifies the mode that you want to use to install the product. The mode must be one of the following values:
  • console
  • GUI
  • silent
The default mode is silent.If you want to install the product by using the console or the graphical user interface, you must have an XWindow system that is installed on the host. All modes require you to supply information during the installation except for the silent mode.
--owner <owner>
Specifies the user ID that owns the files that are installed by the Streams product. If you do not specify this option, the command uses the installation owner's user ID.
--pkg-dir <pkg-dir>
Specifies the path where you want to store the installation package. The default location is the current directory.
--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.
--unregistered
Specifies to start the domain controller service as an unregistered service. The domain must exist and be started if you run the command as a non-root user.
-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 creates the installation package for the domain "StreamsDomain":

$ streamtool mkhostpkg --domain-id StreamsDomain --zkconnect host1:2181,host2:2181