Maven Goal: package-app
kite:package-app
Full name:
org.kitesdk:kite-maven-plugin:1.0.0:package-app
Description:
Package an application on the local filesystem.
Attributes:
- Requires a Maven project to be executed.
- Requires dependency resolution of artifacts in scope: runtime.
- Binds by default to the lifecycle phase: package.
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. |
applicationName | String | - | The name of the application. Default value is: ${project.build.finalName}-app. User property is: kite.applicationName. |
applicationType | String | - | The type of the application (workflow,
coordination, or bundle). Default value is: workflow. User property is: kite.applicationType. |
applicationsDirectory | String | - | The base directory in the Hadoop filesystem (typically HDFS) where
applications are stored. Default value is: /user/${user.name}/apps/. User property is: kite.applicationsDirectory. |
args | String[] | - | Arguments to pass to the tool, in addition to those generated by
addDependenciesToDistributedCache and
hadoopConfiguration. User property is: kite.args. |
coordinatorFile | File | - | The coordinator.xml file to use (only for applications of type
coordinator). Default value is: ${basedir}/src/main/oozie/coordinator.xml. User property is: kite.coordinatorFile. |
encoding | String | - | Character encoding for the auto-generated workflow file. Default value is: UTF-8. User property is: kite.workflowFileEncoding. |
generateWorkflowXml | boolean | - | Whether the workflow.xml should be generated or not. Default value is: true. User property is: kite.generateWorkflowXml. |
hadoopConfiguration | Properties | - | Hadoop configuration properties. User property is: kite.hadoopConfiguration. |
schemaVersion | String | - | The version of the Oozie workflow schema. Default value is: 0.4. User property is: kite.schemaVersion. |
workflowName | String | - | The name of the workflow. Default value is: ${project.build.finalName}. User property is: kite.workflowName. |
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
The name of the application.
- Type: java.lang.String
- Required: No
- User Property: kite.applicationName
- Default: ${project.build.finalName}-app
The type of the application (workflow,
coordination, or bundle).
- Type: java.lang.String
- Required: No
- User Property: kite.applicationType
- Default: workflow
The base directory in the Hadoop filesystem (typically HDFS) where
applications are stored.
- Type: java.lang.String
- Required: No
- User Property: kite.applicationsDirectory
- Default: /user/${user.name}/apps/
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
The coordinator.xml file to use (only for applications of type
coordinator).
- Type: java.io.File
- Required: No
- User Property: kite.coordinatorFile
- Default: ${basedir}/src/main/oozie/coordinator.xml
Character encoding for the auto-generated workflow file.
- Type: java.lang.String
- Required: No
- User Property: kite.workflowFileEncoding
- Default: UTF-8
Whether the workflow.xml should be generated or not.
- Type: boolean
- Required: No
- User Property: kite.generateWorkflowXml
- Default: true
Hadoop configuration properties.
- Type: java.util.Properties
- Required: No
- User Property: kite.hadoopConfiguration
The version of the Oozie workflow schema.
- Type: java.lang.String
- Required: No
- User Property: kite.schemaVersion
- Default: 0.4
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
The name of the workflow.
- Type: java.lang.String
- Required: No
- User Property: kite.workflowName
- Default: ${project.build.finalName}