You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@apex.apache.org by da...@apache.org on 2016/03/04 20:49:05 UTC
[44/50] [abbrv] incubator-apex-core git commit: Updated app package
doc screenshots, removed references to DTGateway
Updated app package doc screenshots, removed references to DTGateway
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/f883c668
Tree: http://git-wip-us.apache.org/repos/asf/incubator-apex-core/tree/f883c668
Diff: http://git-wip-us.apache.org/repos/asf/incubator-apex-core/diff/f883c668
Branch: refs/heads/master
Commit: f883c668d96750a37a9229b4a07d1f91a32b251a
Parents: cfdacdf
Author: David Yan <da...@datatorrent.com>
Authored: Mon Feb 29 14:34:14 2016 -0800
Committer: Thomas Weise <th...@datatorrent.com>
Committed: Tue Mar 1 17:39:13 2016 -0800
----------------------------------------------------------------------
docs/application_packages.md | 163 ++++++--------------------------------
1 file changed, 23 insertions(+), 140 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-apex-core/blob/f883c668/docs/application_packages.md
----------------------------------------------------------------------
diff --git a/docs/application_packages.md b/docs/application_packages.md
index 06c2980..3a83d46 100644
--- a/docs/application_packages.md
+++ b/docs/application_packages.md
@@ -10,7 +10,7 @@ standard way for assembling and sharing an Apache Apex application.
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)
+2. Apache Apex 3.2.0 or later (for launching the App Package in your cluster)
# Creating Your First Apex App Package
@@ -80,29 +80,38 @@ Apex installation.
## Using IDE
-Alternatively, you can do the above steps all within your IDE. For
-example, in NetBeans, select File -\> New Project. Then choose “Maven”
-and “Project from Archetype” in the dialog box, as shown.
+Alternatively, you can do the above steps all within your IDE. For example, in IDEA IntelliJ, first make sure you have the "Maven Integration" plugin enabled (Use File -\> Settings \-> Plugins). Then select File -\> New -\> Project. Choose “Maven”, and check “Create from archetype” in the dialog box, as shown.
-Then fill the Group ID, Artifact ID, Version and Repository entries as shown below.
+Then go ahead and click on the "Add Archetype..." button.
-
+Then fill out the Group ID, Artifact ID, and Version entries, and leave the Repository entry blank, as shown below.
+
+
Group ID: org.apache.apex
Artifact ID: apex-app-archetype
Version: 3.2.0-incubating (or any later version)
-Press Next and fill out the rest of the required information. For
-example:
+Click OK. The archetype will appear in the list, selected. Note that this "Add Archetype..." step is only required the first time you use the archetype. You can select the archetype directly after it has been added the first time.
-
+Click Next, and fill out the rest of the required information. For example:
+
+
+
+Click Next, and verify the information shown on the next screen:
+
+
+
+Click Next, and fill out the project name and location:
+
+
Click Finish, and now you have created your own Apache Apex App Package
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.
+other IDEs, like Eclipse or NetBeans, is similar.
# Writing Your Own App Package
@@ -434,12 +443,11 @@ app package default configuration as META-INF/properties.xml, from app
package configuration in the conf directory, from launch time defines,
etc), the precedence of sources, from highest to lowest, is as follows:
-1. Launch time defines (using -D option in CLI, or the POST payload
- with the Gateway REST API’s launch call)
+1. Launch time defines (using -D option in CLI)
2. Launch time specified configuration file in file system (using -conf
option in CLI)
3. Launch time specified package configuration (using -apconf option in
- CLI or the conf={confname} with Gateway REST API’s launch call)
+ CLI)
4. Configuration from \$HOME/.dt/dt-site.xml
5. Application defaults within the package as
META-INF/properties-{appname}.xml
@@ -497,137 +505,12 @@ There are four top level directories in an Application Package:
2. "lib" contains all dependency jars
3. "conf" contains all the pre-set configuration XML files.
4. "META-INF" contains the MANIFEST.MF file and the properties.xml file.
-5. “resources” contains other files that are to be served by the Gateway on behalf of the app package.
-
-
-# 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.
-
-## Storing an Application Package
-
-You can store your Application Packages through DT Gateway using this
-REST call:
-
-```
- POST /ws/v2/appPackages
-```
-
-The payload is the raw content of your Application Package. For
-example, you can issue this request using curl on your Linux command
-line like this, assuming your DT Gateway is accepting requests at
-localhost:9090:
-
-```
-$ curl -XPOST -T <app-package-file> http://localhost:9090/ws/v2/appPackages
-```
-
-## Getting Meta Information on Application Packages
-
-
-You can get the meta information on Application Packages stored through
-DT Gateway using this call. The information includes the logical plan
-of each application within the Application Package.
-
-```
- GET /ws/v2/appPackages/{owner}/{pkgName}/{pkgVersion}
-```
-
-## Getting Available Operators In Application Package
-
-You can get the list of available operators in the Application Package
-using this call.
-
-```
-GET /ws/v2/appPackages/{owner}/{pkgName}/{pkgVersion}/operators?parent={parent}
-```
-
-The parent parameter is optional. If given, parent should be the fully
-qualified class name. It will only return operators that derive from
-that class or interface. For example, if parent is
-com.datatorrent.api.InputOperator, this call will only return input
-operators provided by the Application Package.
-
-## Getting Properties of Operators in Application Package
-
-You can get the list of properties of any operator in the Application
-Package using this call.
-
-```
-GET /ws/v2/appPackages/{owner}/{pkgName}/{pkgVersion}/operators/{className}
-```
-
-## Getting List of Pre-Set Configurations in Application Package
-
-You can get a list of pre-set configurations within the Application
-Package using this call.
-
-```
-GET /ws/v2/appPackages/{owner}/{pkgName}/{packageVersion}/configs
-```
-
-You can also get the content of a specific pre-set configuration within
-the Application Package.
-
-```
- GET /ws/v2/appPackages/{owner}/{pkgName}/{pkgVersion}/configs/{configName}
-```
-
-## Changing Pre-Set Configurations in Application Package
-
-You can create or replace pre-set configurations within the Application
-Package
-```
- PUT /ws/v2/appPackages/{owner}/{pkgName}/{pkgVersion}/configs/{configName}
-```
-The payload of this PUT call is the XML file that represents the pre-set configuration. The Content-Type of the payload is "application/xml" and you can delete a pre-set configuration within the Application Package.
-```
- DELETE /ws/v2/appPackages/{owner}/{pkgName}/{pkgVersion}/configs/{configName}
-```
-
-## Retrieving an Application Package
-
-You can download the Application Package file. This Application Package
-is not necessarily the same file as the one that was originally uploaded
-since the pre-set configurations may have been modified.
-
-```
- GET /ws/v2/appPackages/{owner}/{pkgName}/{pkgVersion}/download
-```
-
-## Launching an Application Package
-
-You can launch an application within an Application Package.
-```
-POST /ws/v2/appPackages/{owner}/{pkgName}/{pkgVersion}/applications/{appName}/launch?config={configName}
-```
-
-The config parameter is optional. If given, it must be one of the
-pre-set configuration within the given Application Package. The
-Content-Type of the payload of the POST request is "application/json"
-and should contain the properties to be launched with the application.
- It is of the form:
-
-```
- {"property-name":"property-value", ... }
-```
-
-Here is an example of launching an application through curl:
-
-```
- $ curl -XPOST -d'{"dt.operator.console.prop.stringFormat":"xyz %s"}'
- http://localhost:9090/ws/v2/appPackages/dtadmin/mydtapp/1.0-SNAPSHOT/app
- lications/MyFirstApplication/launch
-```
+5. “resources” contains any other files
-Please refer to the [Gateway API](http://docs.datatorrent.com/dtgateway_api/) for the complete specification of the REST API.
# 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 Command Line Interface (dtcli). Please refer to the [Gateway API](http://docs.datatorrent.com/dtgateway_api/)
-to see samples for these commands.
+If you are working with Application Packages in the local filesystem, you can use the Apex Command Line Interface (dtcli).
## Getting Application Package Meta Information