inteligr8/ootbee-beedk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactored acs-share RAD

Browse Source
This commit is contained in:
Brian Long
2021-06-28 21:26:48 -04:00
parent c6df90008f
commit 585b2cf745
12 changed files with 501 additions and 77 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
beedk-acs-share-self-rad-tile/README.md
View File

@@ -37,6 +37,19 @@ To use this plugin, just reference it with the Maven Tiles plugin as shown in th
</project>
```
There are 2 other alternative tiles that serve a similar purpose, but are for other use cases. Make sure you are using the right one. Follow the logic below.
Is your Maven project an ACS Share module or ACS Share web application?
: You will be declaring the `beedk-acs-share-module-tile` or `beedk-acs-share-webapp-tile` Maven Tile. You will need to explicitly declare and configure the `beedk-acs-share-self-rad-tile` Maven Tile.
Is your Maven project just one within a set of other Maven projects AND one of those other Maven projects is an ACS Share web application (not a module)?
: You will need to explicitly declare and configure the [`beedk-acs-share-sibling-rad-tile` Maven Tile](../beedk-acs-share-sibling-rad-tile).
Otherwise
: You will need to explicitly declare and configure the [`beedk-acs-share-artifact-rad-tile` Maven Tile](../beedk-acs-share-artifact-rad-tile).
See the [BeeDK documentation](/inteligr8/ootbee-beedk) on instructions for how to start and stop RAD capabilities.
## Configuration
In your Maven project, set the following properties to define the behavior of this Maven Tile. Unless otherwise stated, they can only be overridden in the project POM or other Maven Tiles loaded earlier than this Maven Tile.
@@ -51,14 +64,10 @@ The following properties are intended to be exposed by inheriting Public API Mav
| `alfresco.share.version` | *Maybe* | | The Alfresco Share version to use for RAD. See below for more details. |
| `alfresco.war.artifactId` | | `share` | The Maven `artifactId` of a Maven `war` Type Project defined in a Maven Repository.<br/>*Inherited from [`beedk-acs-webapp-artifact-tile`](/inteligr8/ootbee-beedk/src/stable/beedk-acs-webapp-artifact-tile)* |
| `alfresco.war.version` | *Maybe* | *See Below* | The Maven `version` of a Maven `war` Type Project defined in a Maven Repository.<br/>*Inherited from [`beedk-acs-webapp-artifact-tile`](/inteligr8/ootbee-beedk/src/stable/beedk-acs-webapp-artifact-tile)* |
| `project.build.shareExtDirectory` | | `${project.build.directory}/ext/share` | An additional directory of JARs to add to the ACS Share at runtime. |
| `acs-platform.url` | | *See Below* | The URL of the backend ACS Platform to be used. |
| `acs-share.hotswap.enabled` | | true | Enable the HotSwap Agent for live classpath reloading. |
| `acs-share.debugger.enabled` | | true | Enable the JDWP debugger. |
| `acs-share.port` | | 8180 | The port to expose on `localhost` for the developer; not for other applications or users. |
| `acs-share.debugger.port` | | 8100 | The port to expose on `localhost` for the developer; not for other applications or users. |
| `acs-share.timeout` | | 45000 | The time to wait for the startup to complete, in milliseconds. |
| `tomcat-rad.version` | | *not important* | The version of the [Apache Tomcat Rapid Application Development Docker container](/inteligr8/tomcat-rad-docker). |
| `acs-share.tomcat.opts` | | | Additional `CATALINA_OPTS` to add to the Apache Tomcat startup.<br/>*May be overridden by any POM parent or Maven Tile.*<br/>*Inherited from [`beedk-acs-share-rad-tile`](/inteligr8/ootbee-beedk/src/stable/beedk-acs-share-rad-tile)* |
* The `alfresco.share.version` is used to default the `alfresco.war.version`. It is expected to be used by other Maven Tiles, so it is here for convenience. You must specify either property for this tile to function.
* The `acs-platform.url` will default to the appropriate value when using the `beedk-acs-platform-*-rad-tile` tiles. This should be overridden if you are not using those tiles and are instead using some other ACS Platform instance.
@@ -67,7 +76,7 @@ The following properties are intended to be exposed by inheriting Public API Mav
Additional less important configurations are inherited from the following Maven Tiles.
* [`beedk-run-tile`](/inteligr8/ootbee-beedk/src/stable/beedk-run-tile)
* [`beedk-acs-share-rad-tile`](/inteligr8/ootbee-beedk/src/stable/beedk-acs-share-rad-tile)
* [`beedk-acs-webapp-artifact-rad-tile`](/inteligr8/ootbee-beedk/src/stable/beedk-acs-webapp-artifact-rad-tile)
## Results

79
beedk-acs-share-self-rad-tile/tile.xml
View File

@@ -26,7 +26,7 @@
<configuration>
<excludeScope>provided</excludeScope>
<includeTypes>jar</includeTypes>
<outputDirectory>${project.build.shareExtDirectory}</outputDirectory>
<outputDirectory>${beedk.deploy.share.extDirectory}</outputDirectory>
</configuration>
</execution>
</executions>
@@ -76,61 +76,6 @@
</replacements>
</configuration>
</plugin>
<!-- Using Docker to host the web application -->
<plugin>
<groupId>io.fabric8</groupId>
<artifactId>docker-maven-plugin</artifactId>
<version>${beedk.plugins.fabric8.docker.version}</version>
<executions>
<execution>
<id>run-acs-share</id>
<phase>process-classes</phase>
<goals><goal>start</goal></goals>
<configuration>
<tiles-keep-id>true</tiles-keep-id>
<images>
<image>
<name>docker.inteligr8.com/inteligr8/tomcat-rad:${tomcat-rad.version}</name>
<alias>acs-share</alias>
<run>
<env>
<ENABLE_JDWP>${acs-share.debugger.enabled}</ENABLE_JDWP>
<ENABLE_HOTSWAP>${acs-share.hotswap.enabled}</ENABLE_HOTSWAP>
</env>
<ports>
<port>${acs-share.port}:8080</port>
<port>${acs-share.debugger.port}:8000</port>
</ports>
<network>
<mode>custom</mode>
<name>${project.artifactId}</name>
</network>
<volumes>
<bind>
<volume>${project.build.warFile}:/var/lib/tomcat/webapps/share.war:ro</volume>
<volume>${project.build.outputDirectory}:/var/lib/tomcat/dev/classes:ro</volume>
<volume>${project.build.directory}/module-classes:/var/lib/tomcat/dev/classes-extra1:ro</volume>
<volume>${project.build.directory}/extension-classes:/var/lib/tomcat/dev/classes-extra2:ro</volume>
<volume>${project.build.testOutputDirectory}:/var/lib/tomcat/dev/classes-extra3:ro</volume>
<volume>${project.build.shareExtDirectory}:/var/lib/tomcat/dev/lib:ro</volume>
<volume>${project.build.directory}/web-resources:/var/lib/tomcat/dev/web:ro</volume>
</bind>
</volumes>
<wait>
<http>
<url>http://localhost:${acs-share.port}/share</url>
<method>GET</method>
<status>200..399</status>
</http>
<time>${acs-share.timeout}</time>
</wait>
</run>
</image>
</images>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</profile>
@@ -144,20 +89,16 @@
<properties>
<!-- configurable -->
<acs-platform.url>http://${project.artifactId}-acs-platform:8080</acs-platform.url>
<acs-share.hotswap.enabled>true</acs-share.hotswap.enabled>
<acs-share.debugger.enabled>true</acs-share.debugger.enabled>
<acs-share.debugger.port>8100</acs-share.debugger.port>
<acs-share.timeout>45000</acs-share.timeout>
<project.build.shareExtDirectory>${project.build.directory}/ext/share</project.build.shareExtDirectory>
<!-- ports -->
<acs-share.port>8180</acs-share.port>
<!-- versions -->
<tomcat-rad.version>9-1.4</tomcat-rad.version>
<beedk.deploy.share.warFile>${project.build.warFile}</beedk.deploy.share.warFile>
<beedk.deploy.share.classesDirectory>${project.build.outputDirectory}</beedk.deploy.share.classesDirectory>
<beedk.deploy.share.modClassesDirectory>${project.build.directory}/module-classes</beedk.deploy.share.modClassesDirectory>
<beedk.deploy.share.extClassesDirectory>${project.build.directory}/extension-classes</beedk.deploy.share.extClassesDirectory>
<beedk.deploy.share.testClassesDirectory>${project.build.testOutputDirectory}</beedk.deploy.share.testClassesDirectory>
<beedk.deploy.share.extDirectory>${project.build.directory}/ext/share</beedk.deploy.share.extDirectory>
<beedk.deploy.share.warDirectory>${project.build.directory}/war</beedk.deploy.share.warDirectory>
<beedk.deploy.share.webDirectory>${project.build.directory}/web-resources</beedk.deploy.share.webDirectory>
<!-- configuring beedk-acs-webapp-artifact-tile -->
<alfresco.war.artifactId>share</alfresco.war.artifactId>
<alfresco.war.version>${alfresco.share.version}</alfresco.war.version>
</properties>
</profile>
@@ -165,7 +106,7 @@
<tiles>
<!-- Documentation: https://bitbucket.org/inteligr8/ootbee-beedk/src/stable/beedk-run-tile -->
<tile>@project.groupId@:beedk-run-tile:@project.version@</tile>
<tile>@project.groupId@:beedk-acs-share-rad-tile:@project.version@</tile>
<!-- Documentation: https://bitbucket.org/inteligr8/ootbee-beedk/src/stable/beedk-acs-webapp-artifact-rad-tile -->
<tile>@project.groupId@:beedk-acs-webapp-artifact-rad-tile:@project.version@</tile>
</tiles>