kite:run-tool
Full name:
org.kitesdk:kite-maven-plugin:0.17.0:run-tool
Description:
Run a Hadoop tool on the local machine.
Attributes:
- Requires a Maven project to be executed.
- Requires dependency resolution of artifacts in scope: runtime.
Required Parameters
Name | Type | Since | Description |
---|---|---|---|
toolClass | String | - | The tool class to run. The specified class must have a standard Java main method. User property is: kite.toolClass. |
Optional Parameters
Name | Type | Since | Description |
---|---|---|---|
addDependenciesToDistributedCache | boolean | - | Whether to add dependencies in the runtime classpath to Hadoop's distributed cache so that they are added to the classpath for MapReduce tasks (via -libjars). Default value is: true. User property is: kite.addDependenciesToDistributedCache. |
args | String[] | - | Arguments to pass to the tool, in addition to those generated by addDependenciesToDistributedCache and hadoopConfiguration. User property is: kite.args. |
hadoopConfiguration | Properties | - | Hadoop configuration properties. WARNING: This configuration setting is not compatible with the factory methods in DatasetRepositories because it does not alter the environment configuration. For example, if using this to modify the environment's "fs.defaultFS" property in the tool that is run by this Mojo, opening a repo by URI will continue to use the environment's default FS. Configuration properties set using this option will only affect the Configuration objects passed by ToolRunner or created by GenericOptionsParser. User property is: kite.hadoopConfiguration. |
Parameter Details
addDependenciesToDistributedCache:
Whether to add dependencies in the
runtime classpath to Hadoop's distributed cache so that they are added to the classpath for MapReduce tasks (via
-libjars).
- Type: boolean
- Required: No
- User Property: kite.addDependenciesToDistributedCache
- Default: true
args:
Arguments to pass to the tool, in addition to those generated by
addDependenciesToDistributedCache and
hadoopConfiguration.
- Type: java.lang.String[]
- Required: No
- User Property: kite.args
Hadoop configuration properties. WARNING: This configuration setting is not compatible with the factory methods in
DatasetRepositories because it does not alter the environment configuration. For example, if using this to modify the environment's "fs.defaultFS" property in the tool that is run by this Mojo, opening a repo by URI will continue to use the environment's default FS. Configuration properties set using this option will only affect the
Configuration objects passed by
ToolRunner or created by
GenericOptionsParser.
- Type: java.util.Properties
- Required: No
- User Property: kite.hadoopConfiguration
The tool class to run. The specified class must have a standard Java
main method.
- Type: java.lang.String
- Required: Yes
- User Property: kite.toolClass