ID-11: support gateway deployment

Author: mlookaxw

CHANGELOG.adoc

@@ -1,5 +1,38 @@
 = Changelog
 
+== Version 0.8.0
+[cols="1,2,<10a", options="header"]
+|===
+|ID|Type|Description
+|https://github.com/Axway-API-Management-Plus/apigw-maven-plugin/issues/11[#11]
+|Enhancement
+|Deployment to gateway via plugin.
+
+The plugin now supports to deploy a project directly via the plugin goal `apigw:deploy`. Only the standard deployment is supported. The deployment of static files and JARs are not supported.
+
+New properties:
+
+  * `axway.anm.host`: Host of the Admin Node Manager.
+  * `axway.anm.port`: Port of the Admin Node Manager (default: 8090).
+  * `axway.anm.user`: User to connect to the Admin Node Manager (default: admin).
+  * `axway.anm.password`: Password of the user.
+  * `axway.deploy.group`: Name of the group the project is deployed to.
+  * `axway.passphrase.pol`: Passphrase for `.pol` and `.env` packages.
+  * `axway.passphrase.fed`: Passphrase for `.fed` packages.
+  * `axway.passphrase.deploy`: Passphrase for deployment group.
+  * `axway.config.envs`: Path to environmentalized fields configuration file.
+  * `axway.config.certs`: Path to certificates configuration file.
+  * `axway.config.props`: Path to properties configuration file.
+
+Deleted properties:
+
+  * `axway.passphrase.in`: replaced by `axway.passphrase.pol`
+  * `axway.passphrase.out`: replaced by `axway.passphrase.out`
+  * `propertyFile`: replaced by `axway.config.props`
+  * `certsFile`: replaced by `axway.config.certs`
+
+|===
+
 == Version 0.7.0
 
 [cols="1,2,<10a", options="header"]

README.adoc

@@ -115,7 +115,6 @@ The plugin supports three kind of API Gateway projects:
 == Known Limitations
 
  * Documentation is not complete.
- * Deployment to API Gateway is currently not supported (on the road map).
  * Automatic adding of dependent JARs to PolicyStudio is currently not supported (on the road map).
  * Environmentalized fields containing references are not supported.
  * Unconfigured envSettings are not detected.

doc/getting-started/getting-started.adoc

@@ -5,7 +5,7 @@
 :sectnums:
 :source-highlighter: prettify
 
-:mvn-plugin-ver: 0.7.0
+:mvn-plugin-ver: 0.8.0-SNAPSHOT
 
 Here you get a simple introduction on how to use the _Maven Plugin for Axway API Gateway_.
 It assumes that you are familiar with https://maven.apache.org[Apache Maven] and that you are familiar with PolicyStudio and the API Gateway.
@@ -259,8 +259,17 @@ For building an environment specific API Gateway instance create a separate fold
 
   <name>Hello World (DEV)</name>
 
+  <properties>
+    <!--3-->
+    <!--
+    <axway.config.certs>${basedir}/src/main/axwgw/gateway-cert.json</axway.config.certs>
+    <axway.config.props>${basedir}/src/main/axwgw/gateway-prop.json</axway.config.props
+    -->
+  </properties>
+
+
   <dependencies>
-    <dependency> <!--3-->
+    <dependency> <!--4-->
       <groupId>com.example</groupId>
       <artifactId>hello-world-gw</artifactId>
       <version>0.1.0-SNAPSHOT</version>
@@ -270,36 +279,30 @@ For building an environment specific API Gateway instance create a separate fold
 
   <build>
     <plugins>
-      <plugin> <!--4-->
+      <plugin> <!--5-->
         <groupId>com.axway.maven.plugins</groupId>
         <artifactId>apigw-maven-plugin</artifactId>
         <version>{mvn-plugin-ver}</version>
         <extensions>true</extensions>
-        <configuration>
-          <!--5-->
-          <!--
-          <certsFile>${basedir}/src/main/axwgw/gateway-cert.json</certsFile>
-          <propertyFile>${basedir}/src/main/axwgw/gateway-prop.json</propertyFile>
-          -->
-        </configuration>
       </plugin>
     </plugins>
   </build>
  </project>
 ----
 <1> Environment specific artifact, so the name should include the target environment.
 <2> The packaging type `axway-deployment-archive` marks it as a deployment project.
-<3> Include the dependency of your previously created server archive.
-<4> Use _Maven Plugin for API Gateway_ for this project.
-<5> Optionally specify additional configuration files.
+<3> Optionally specify additional configuration files.
+<4> Include the dependency of your previously created server archive.
+<5> Use _Maven Plugin for API Gateway_ for this project.
+
 
 To initialize the project invoke the Maven goal `apigw:init`.
 
  $ mvn apigw:init
 
 This will create a source folder with an empty configuration file.
 
-.src/main/gateway.config.json
+.src/main/axwgw/gateway.config.json
 [source,json]
 ----
 {}
@@ -317,7 +320,7 @@ As we haven't configured our project yet, the build will fail.
 
 For convenience the plugin will automatically add new fields to the configuration file (see below).
 
-.src/main/gateway.config.json
+.src/main/axwgw/gateway.config.json
 [source,json]
 ----
 {
@@ -364,13 +367,22 @@ And build your project again.
 
  $ mvn clean package
 
-Now the build succeeds and a deployment archive `hello-world-dev-0.1.0-SNAPSHOT.axdar` containing the `.fed` file will be created.
+Now the build succeeds and a deployment archive `hello-world-dev-0.1.0-SNAPSHOT.axdar` containing the `.fed` file is created.
 
 For manual checks via ConfigurationStudio the content of the archive is located in the `target/axway-archive` folder.
 
 == Deployment
 
-Deployment of the gateway is currently not in scope of the plugin.
-But it should be very easy to incorporate the deployment archive in your deployment pipeline.
-Extract the content of the archive and use the `projdeploy` tool for deployment.
+The project can be deployed to a gateway via the plugin.
+
+Just invoke the `apigw:deploy` goal within the deployment project and specify the target domain and group.
+
+In the following example it is assumed that the Admin Node Manager is located at `localhost:8090`.
+The user `admin` is allowed to deploy projects and has the password `changeme`.
+The project shall be deployed to the group `test`. 
+
+  $ mvn -Daxway.anm.host=localhost -Daxway.anm.port=8090 \
+    -Daxway.anm.user=admin -Daxway.anm.password=changeme \
+    -Daxway.deploy.group=test \
+    clean apigw:deploy
 

doc/manual/_reference.adoc

@@ -173,7 +173,7 @@ This property has to be defined before using the plugin.
 Default: _none_
 
 |axway.home.apigw
-|Home directory of the installed AI Gateway.
+|Home directory of the installed API Gateway.
 
 Default: ${axway.home}/apigateway
 
@@ -226,6 +226,21 @@ Default: ${axway.home}/apigateway/system/conf/templates/BlankConfiguration-Vorde
 
 Default: ${axway.home}/apigateway/system/conf/templates/BlankNoSettingsConfiguration-VordelGateway.fed
 
+|axway.config.envs
+|Path to configuration file for environmentalized fields (required for deployment or deployment projects).
+
+Default: ${axway.dir.source}/gateway.config.json _(only for deployment projects)_
+
+|axway.config.certs
+|Path to configuration file for certificates (required for deployment or deployment projects).
+
+Default: _none_
+
+|axway.config.props
+|Path to configuration file for properties (required for deployment or deployment projects).
+
+Default: _none_
+
 |axway.tools.cfg.verbose
 |Set to _true_ to enable verbose mode for internal configuration tool.
 
@@ -247,18 +262,46 @@ This property can be used to enable the previous behavior.
 
 Default: false
 
-|axway.passphrase.in
-|Passphrase for reading input (`.pol`, `.env`) packages.
-Applicable to deployment projects only.
+|axway.passphrase.pol
+|Passphrase for reading or generating `.pol` and `.env` packages.
+
+Default: _no passphrase_
+
+|axway.passphrase.fed
+|Passphrase for reading or writing `.fed` packages.
 
 Default: _no passphrase_
 
-|axway.passphrase.out
-|Passphrase for writing output (`.pol`, `.env`, `.fed`) packages.
-Applicable to server and deployment projects.
+|axway.passphrase.deploy
+|Passphrase for gateway deployment.
 
 Default: _no passphrase_
 
+|axway.anm.host
+|Host of Admin Node Manager (required for deployment only)
+
+Default: _none_
+
+|axway.anm.port
+|Port of Admin Node Manager (required for deployment only)
+
+Default: 8090
+
+|axway.anm.user
+|Admin user for Admin Node Manager (required for deployment only)
+
+Default: admin
+
+|axway.anm.password
+|Password word Admin Node Manager (required for deployment only)
+
+Default: _none_
+
+|axway.deploy.group
+|Group the projects have to be deployed to (required for deployment only)
+
+Default: _none_
+
 |axway.skipPackaging
 |Set to _true_ to skip `package` goal in case of the target artifact already exists.
 

doc/manual/_usage.adoc

@@ -177,6 +177,98 @@ To deploy the generated project archive to the remote repository use the `deploy
 
   $ mvn clean deploy
 
+== Deploy Project to API Gateway
+
+To install the project to a gateway instance the goal `apigw:deploy` is used.
+It only supports a standard deployment.
+Deployment of static files or JARs are not supported.
+
+For deployment following properties are used:
+
+[cols="1,<5a,1", options="header"]
+|===
+|Property|Description|Mandatory
+
+|`axway.anm.host`
+|Host of the Admin Node Manager.
+|yes
+
+|`axway.anm.port`
+|Port of the Admin Node Manager (default: 8090).
+|no
+
+|`axway.anm.user`
+|User to connect to the Admin Node Manager (default: admin).
+|no
+
+|`axway.anm.password`
+|Password of the user.
+|yes
+
+|`axway.deploy.group`
+|Name of the group the project is deployed to.
+|yes
+
+|`axway.passphrase.pol`
+|Passphrase for `.pol` and `.env` packages.
+|no
+
+|`axway.passphrase.fed`
+|Passphrase for `.fed` packages.
+|no
+
+|`axway.passphrase.deploy`
+|Passphrase for deployment group.
+|no
+
+|`axway.config.envs`
+|Path to environmentalized fields configuration file.
+|yes
+
+|`axway.config.certs`
+|Path to certificates configuration file.
+|no
+
+|`axway.config.props`
+|Path to properties configuration file.
+|no
+|===
+
+Example:
+
+  $ mvn -Daxway.anm.host=localhost -Daxway.anm.password=changeme -Daxway.deploy.group=test -Daxway.config.envs=gateway.config.json clean apigw:deploy
+
+=== Policy Projects
+
+For policy projects the test server which is included in the project is deployed.
+
+Steps:
+
+  . Execute `package` lifecycle.
+  . Build `.pol` and `.env` packages.
+  . Build and configure `.fed` package.
+  . Deploy `.fed` package to gateway
+
+=== Server Projects
+
+For server projects the generated `.pol` and `.env` packages are deployed.
+
+Steps:
+
+  . Execute `package` lifecycle.
+  . Build and configure `.fed` package from `.pol` and `.env` packages.
+  . Deploy `.fed` package to gateway
+
+=== Deployment Projects
+
+For deployment projects the `.fed` package of the generated artifact is deployed.
+
+Steps:
+
+  . Execute `package` lifecycle.
+  . Deploy `.fed` package to gateway
+
+
 == Miscellaneous
 
 === Standalone Configuration Tools
@@ -221,4 +313,8 @@ This section provides a short overview of the goals supported by the Maven plugi
 |apigw:tools
 |Extract the scripts of the configuration tools to the target directory.
 |yes|yes|yes
+
+|apigw:deploy
+|Deploy project to a gateway.
+|yes|yes|yes
 |===

doc/manual/user-guide.adoc

@@ -18,7 +18,7 @@ ifdef::env-github[]
 :warning-caption: :warning:
 endif::[]
 
-:mvn-plugin-ver: 0.7.0
+:mvn-plugin-ver: 0.8.0-SNAPSHOT
 
 == About the Plugin
 

example/getting-started/pom.xml

@@ -7,7 +7,7 @@
   <packaging>pom</packaging>
 
   <properties>
-      <axway.maven.plugin.ver>0.7.0</axway.maven.plugin.ver>
+      <axway.maven.plugin.ver>0.8.0-SNAPSHOT</axway.maven.plugin.ver>
   </properties>
 
   <modules>