Update ApexPackage.md
Project: http://git-wip-us.apache.org/repos/asf/incubator-apex-core/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-apex-core/commit/d7404aaa Tree: http://git-wip-us.apache.org/repos/asf/incubator-apex-core/tree/d7404aaa Diff: http://git-wip-us.apache.org/repos/asf/incubator-apex-core/diff/d7404aaa Branch: refs/heads/master Commit: d7404aaaf97d4ae8c01993750e24c68f12157443 Parents: 9bbecca Author: sandeshh <[email protected]> Authored: Wed Oct 28 13:46:12 2015 -0700 Committer: Thomas Weise <[email protected]> Committed: Sun Feb 28 22:46:33 2016 -0800 ---------------------------------------------------------------------- ApexPackage.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-apex-core/blob/d7404aaa/ApexPackage.md ---------------------------------------------------------------------- diff --git a/ApexPackage.md b/ApexPackage.md index 2f96825..309b7ba 100644 --- a/ApexPackage.md +++ b/ApexPackage.md @@ -1,19 +1,19 @@ #Apache Apex (incubating) Application Packages -# 1. Introduction +# Introduction An Apache Apex Application Package is a zip file that contains all the necessary files to launch an application in Apache Apex. It is the standard way for assembling and sharing an Apache Apex application. -# 2. Requirements +# Requirements You will need have the following installed: 1. Apache Maven 3.0 or later (for assembling the App Package) 2. Apache Apex 3.0.0 or later (for launching the App Package in your cluster) -#3. Creating Your First Apex App Package +# Creating Your First Apex App Package You can create an Apex Application Package using your Linux command line, or using your favorite IDE. @@ -113,7 +113,7 @@ project, with a default unit test. You can run the unit test, make code changes or make dependency changes within your IDE. The procedure for other IDEs, like Eclipse or IntelliJ, is similar. -# 4. Writing Your Own App Package +# Writing Your Own App Package Please refer to the [Application Developer Guide](https://www.datatorrent.com/docs/guides/ApplicationDeveloperGuide.html) on the basics on how to write a DataTorrent application. In your AppPackage project, you can add custom operators (refer to [Operator Developer Guide](https://www.datatorrent.com/docs/guides/OperatorDeveloperGuide.html)), project dependencies, default and required configuration properties, pre-set configurations and other metadata. @@ -497,7 +497,7 @@ Note that by default from project created from the maven archetype, there is already a log4j.properties file under src/test/resources and that file is only used for the unit test. -#5. Zip Structure of Application Package +# Zip Structure of Application Package DataTorrent Application Package files are zip files. You can examine the content of any Application Package by using unzip -t on your Linux command line. @@ -511,7 +511,7 @@ There are four top level directories in an Application Package: 5. âresourcesâ contains other files that are to be served by the Gateway on behalf of the app package. -#6. Managing Application Packages Through DT Gateway +# Managing Application Packages Through DT Gateway The DT Gateway provides storing and retrieving Application Packages to and from your distributed file system, e.g. HDFS. @@ -634,7 +634,7 @@ Here is an example of launching an application through curl: Please refer to the [Gateway API reference](https://www.google.com/url?q=https://www.datatorrent.com/docs/guides/DTGatewayAPISpecification.html&sa=D&usg=AFQjCNEWfN7-e7fd6MoWZjmJUE3GW7UwdQ) for the complete specification of the REST API. -# 7. Examining and Launching Application Packages Through Apex CLI +# Examining and Launching Application Packages Through Apex CLI If you are working with Application Packages in the local filesystem and do not want to deal with dtGateway, you can use the Apex @@ -678,7 +678,6 @@ dt> launch [-D property-name=property-value, ...] [-conf config-name] ``` Note that -conf expects a configuration file in the file system, while -apconf expects a configuration file within the app package. -© 2014-2015 DataTorrent Inc.
