streamtool mvservice

Usage

mvservice [-d,--domain-id <did>] [-i,--instance-id <instance>] [--noprompt] -f,--from-resource <resourceId> -t,--to-resource <resourceId> [--pid <process-id>] [-U,--User <user>] [-h,--help] [--trace <level>] [-v,--verbose <level>] [--zkconnect {<host>:<port>},... | --embeddedzk] <service>

Use the streamtool mvservice command to manually move an instance-related service from one host to another compatible host.

Authority

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

Description

Use this command to rebalance services, for example, after a host has been shut down for maintenance. By default, all services of the requested type are moved. To move a specific service, use the --pid option.

Limitations:

  • You cannot move an application service from a resource unless it is the only service that is running on that resource.
  • If the resource is currently running management services, you cannot move an application service to it.
  • When you move a service from one resource to another, the destination resource must be compatible with the source resource. For example, a resource with the "management" tag can be moved only to a destination resource that also has the "management" tag.
  • The sam and srm services are moved as a pair. A message indicates that both services were moved if either of these services are specified.

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.

-f,--from-resource <resourceId>
Specifies a resource identifier, which can be the host name or IP address. The command moves the specified service on this resource to a compatible resource.
-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.

--noprompt
Specifies to suppress confirmation prompts.
--pid <process-id>
Specifies the process identifier of the service to be moved.
-t,--to-resource <resourceId>
Specifies a resource identifier, which can be the host name or IP address. The command moves the specified service from its current resource to this resource.
--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.
--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.

Arguments

service
Specifies the name of the instance service. The following service name values are valid: app; sam; srm; view. The command moves the instance service to the requested resource.