SPOI-6700 SPOI-6701 SPOI-6704 SPOI-6705 #resolve Adding application creation summary page; Adding GA codes; Updating launching demos with Apex references; Fixing sandbox guide
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/7d6c677c Tree: http://git-wip-us.apache.org/repos/asf/incubator-apex-core/tree/7d6c677c Diff: http://git-wip-us.apache.org/repos/asf/incubator-apex-core/diff/7d6c677c Branch: refs/heads/APEXCORE-293 Commit: 7d6c677c20a09b4c31e3fb0b576ac67b3d20e622 Parents: 1177eb7 Author: sashadt <[email protected]> Authored: Wed Nov 4 18:37:37 2015 -0800 Committer: Thomas Weise <[email protected]> Committed: Sun Feb 28 22:46:35 2016 -0800 ---------------------------------------------------------------------- application_packages.md | 2 +- configuration_packages.md | 33 ++++++++++++++++++++++++--------- 2 files changed, 25 insertions(+), 10 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-apex-core/blob/7d6c677c/application_packages.md ---------------------------------------------------------------------- diff --git a/application_packages.md b/application_packages.md index b125551..521779a 100644 --- a/application_packages.md +++ b/application_packages.md @@ -665,5 +665,5 @@ You can launch an application within an Application Package. dt> launch [-D property-name=property-value, ...] [-conf config-name] [-apconf config-file-within-app-package] <app-package-file> [matching-app-name] - ``` +``` Note that -conf expects a configuration file in the file system, while -apconf expects a configuration file within the app package. http://git-wip-us.apache.org/repos/asf/incubator-apex-core/blob/7d6c677c/configuration_packages.md ---------------------------------------------------------------------- diff --git a/configuration_packages.md b/configuration_packages.md index 331abd1..30f1717 100644 --- a/configuration_packages.md +++ b/configuration_packages.md @@ -105,9 +105,20 @@ Example: </properties> ``` -In pom.xml, you can change the values of ```<groupId>, <version>, <artifactId>, <name> ```and ```<description>``` to your desired values. +In pom.xml, you can change the following keys to your desired values + +* ```<groupId>``` +* ```<version>``` +* ```<artifactId>``` +* ```<name> ``` +* ```<description>``` + +You can also change the values of + +* ```<datatorrent.apppackage.name>``` +* ```<datatorrent.apppackage.minversion>``` +* ```<datatorrent.apppackage.maxversion>``` -You can also change the values of ```<datatorrent.apppackage.name>, <datatorrent.apppackage.minversion> <datatorrent.apppackage.maxversion>``` to reflect what app packages should be used with this configuration package. Apex will use this information to check whether a configuration package is compatible with the application package when you issue a launch command. @@ -169,6 +180,8 @@ files {files} ``` + + #Launching with CLI `-conf` option of the launch command in CLI supports specifying configuration package in the local filesystem. Example: @@ -177,9 +190,11 @@ files This command expects both the application package and the configuration package to be in the local file system. -#Related REST API -##POST /ws/v2/configPackages + +# Related REST API + +### POST /ws/v2/configPackages Payload: Raw content of configuration package zip @@ -189,23 +204,23 @@ Curl example: $ curl -XPOST -T DTConfig-{name}.jar http://{yourhost:port}/ws/v2/configPackages -## GET /ws/v2/configPackages?appPackageName=...&appPackageVersion=... +### GET /ws/v2/configPackages?appPackageName=...&appPackageVersion=... All query parameters are optional Function: Returns the configuration packages that the user is authorized to use and that are compatible with the specified appPackageName, appPackageVersion and appName. -## GET /ws/v2/configPackages/``<user>``?appPackageName=...&appPackageVersion=... +### GET /ws/v2/configPackages/``<user>``?appPackageName=...&appPackageVersion=... All query parameters are optional Function: Returns the configuration packages under the specified user and that are compatible with the specified appPackageName, appPackageVersion and appName. -## GET /ws/v2/configPackages/```<user>```/```<name>``` +### GET /ws/v2/configPackages/```<user>```/```<name>``` Function: Returns the information of the specified configuration package -## GET /ws/v2/configPackages/```<user>```/```<name>```/download +### GET /ws/v2/configPackages/```<user>```/```<name>```/download Function: Returns the raw config package file @@ -216,7 +231,7 @@ $ curl http://{yourhost:port}/ws/v2/configPackages/{user}/{name}/download \> DTC $ unzip -t DTConfig-xyz.jar ``` -## POST /ws/v2/appPackages/```<user>```/```<app-pkg-name>```/```<app-pkg-version>```/applications/{app-name}/launch?configPackage=```<user>```/```<confpkgname>``` +### POST /ws/v2/appPackages/```<user>```/```<app-pkg-name>```/```<app-pkg-version>```/applications/{app-name}/launch?configPackage=```<user>```/```<confpkgname>``` Function: Launches the app package with the specified configuration package stored in HDFS.
