streamtool mktag
Usage
mktag >>-+---------------------------------+--------------------------> +- --deffile--definition-file-----+ | .-----------------------------. | | V | | '---+-------------------------+-+-' '- --property--name=value-' >--+-----------------------------+--+-----------------------+---> '- --description--description-' '-+- -d----------+--did-' '- --domain-id-' >--+---------+--+-----------------+--+---------------------+----> +- -h-----+ '- --trace--level-' '-+- -U-----+--userid-' '- --help-' '- --User-' >--+-----------------------+------------------------------------> '-+- -v--------+--level-' '- --verbose-' >--| Non-interactive tool options |--tag----------------------->< Non-interactive tool options (1) |--------+-----------------------------+------------------------| +- --embeddedzk---------------+ | .-,---------. | | V | | '- --zkconnect----host:port-+-'
- The non-interactive tool options are not supported in the interactive streamtool interface.
Authority
You must have read and write authority for the config domain object. By default, the DomainAdministrator role has this authority. For more information about access control lists, see streamtool getdomainacl.
Description
Tags are a mechanism for differentiating and identifying resources that have different physical characteristics or logical uses. Resources can have any number of tags. Tags are case-sensitive strings with a letter optionally followed by alphanumeric or underscore characters.
- application
- Specifies that the resource can run InfoSphere Streams applications.
- audit
- Specifies that the resource can run the logging service.
- authentication
- Specifies that the resource can run the authentication and authorization service.
- jmx
- Specifies that the resource can run the management API service.
- management
- Specifies that the resource can run any of the InfoSphere Streams domain and instance management services.
- sws
- Specifies that the resource can run the web management service.
- view
- Specifies that the resource can run the view service.
If you use an external resource manager, you might need to declare system-related attributes such as memory and processor cores. These attributes make up a resource definition. You can associate a resource definition with a tag by using either the --property or --deffile options.
Tags can affect dynamic resource selection at instance creation time and when resources are added to an instance.
The InfoSphere Streams scheduler uses tags when it matches resources to the resource pool requirements that are expressed in streams processing applications.
The domain maintains a registry of the tags that are defined in the domain.
Options and arguments
- --deffile definition-file
Specifies a file from which to import the resource definition.The contents and format of the file are specific to the resource manager. InfoSphere Streams passes this information to the resource manager when it requests resources.
- --description description
Specifies a description for the tag. The description can be 1024 characters in length. If the description contains blank characters, it must be enclosed in single or double quotation marks. Quotation marks within the description must be preceded by a backslash (\).
- -d, --domain-id did
Specifies the domain identifier.
If you do not specify this option, InfoSphere 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, InfoSphere Streams uses the ZooKeeper connection that is associated with the active domain or the domain that is specified in the --domain-id option. InfoSphere 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 InfoSphere Streams configuration cache, the command fails.
- -h, --help
Specifies to show the command syntax.
- --property name=value
Specifies a property name and value pair to add to the resource definition. This option can be specified multiple times and has an additive effect.
- tag
Specifies the name of the tag.
Tags are strings such as 'ingest', 'fpga', or 'infiniband'. Tags must be strings with a letter optionally followed by alphanumeric or underscore characters. Tags are case-sensitive.
- --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
- -U, --User userid
Specifies an InfoSphere Streams user ID that has authority to run the command.
- -v,--verbose level
Specifies to provide more detailed command output. The vebosity level can be from 0 to 3 where 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, InfoSphere Streams tries to use:- The --embeddedzk option
- The value from the STREAMS_ZKCONNECT environment variable
- A ZooKeeper connection string that is derived from cached information about the current domain.
Examples
[streamtool <bsmith@StreamsDomain.StreamsInstance>] mktag --description 'Hosts for ingesting from external internet environment' ingest
CDISC0102I The ingest host tag was defined for the StreamsDomain domain.