Commit ad92fb5a authored by Brian Long's avatar Brian Long
Browse files

added beedk-aps-ext-rad-tile

parent d80c6b94

beedk-aps-ext-rad-tile/.gitignore

0 → 100644
+9 −0
Original line number Diff line number Diff line 
# Eclipse

.project

.classpath

.settings



# Maven

pom.xml.versionsBackup

target

beedk-aps-ext-rad-tile/README.md

0 → 100644
+84 −0
Original line number Diff line number Diff line 
# BeeDK Abstract ACS Platform Maven Tile for RAD



This is a component within the proposed [BeeDK](/inteligr8/ootbee-beedk).  It is considered to be part of the **Public API** of the BeeDK.



## Purpose



This project creates a [Maven Tile](https://github.com/repaint-io/maven-tiles) that provides the basis for rapid application development of any APS extension.



## Usage



To use this plugin, just reference it with the Maven Tiles plugin as shown in the following snippet.  Do not forget the `extensions` element in the *plugin* configuration.



```xml

<project ...>

	...

	<build>

		...

		<plugins>

			<plugin>

				<groupId>io.repaint.maven</groupId>

				<artifactId>tiles-maven-plugin</artifactId>

				<version>[2.0,3.0)</version>

				<extensions>true</extensions>

				<configuration>

					<tiles>

						...

						<!-- Documentation: https://bitbucket.org/inteligr8/ootbee-beedk/src/stable/beedk-aps-ext-rad-tile -->

						<tile>com.inteligr8.ootbee:beedk-aps-ext-rad-tile:[1.0.0,2.0.0)</tile>

					</tiles>

				</configuration>

			</plugin>

			...

		</plugins>

		...

	</build>

	...

</project>

```



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.



### Public API



The following properties are intended to be exposed by inheriting Public API Maven Tiles.



| Maven Property             | Required | Default         | Description |

| -------------------------- |:--------:| --------------- | ----------- |

| `aps.war.groupId`          |          | `org.alfresco`  | |

| `aps.war.artifactId`       |          | `activiti-app`  | |

| `aps.war.version`          | **Yes**  |                 | |

| `aps.port`                 |          | 8080            | The port to expose on `localhost` for the developer; not for other applications or users. |

| `aps-postgres.port`        |          | 5432            | The port to expose on `localhost` for the developer; not for other applications or users. |

| `aps.debugger.port`        |          | 8000            | The port to expose on `localhost` for the developer; not for other applications or users. |

| `aps.tomcat.opts`          |          |                 | Additional `CATALINA_OPTS` to add to the Apache Tomcat startup.<br/>*May be overridden by any POM parent or Maven Tile.* |

| `aps.timeout`              |          | 120000          | 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). |

| `aps-postgres.version`     |          | *not important* | The version of PostgreSQL to use in the integration testing infrastructure. |



### Private API



The following properties are only intended to be defined by BeeDK components.



| Maven Property                       | Required | Default            | Description |

| ------------------------------------ |:--------:| ------------------ | ----------- |

| `beedk.deploy.aps.warFile`           | **Yes**  |                    | The WAR file to deploy in the Apache Tomcat instance. |

| `beedk.deploy.aps.classesDirectory`  |          |                    | An additional classpath directory to sideload into the web application. |

| `beedk.deploy.aps.testClassesDirectory` |       |                    | An additional test classpath directory to sideload into the web application. |

| `beedk.deploy.aps.extDirectory`      |          |                    | An additional directory of JARs to sideload into the web application. |

| `beedk.deploy.aps.warDirectory`      |  | `${project.build.warDirectory}` | A build directory for WAR files. |

| `beedk.deploy.aps.dataDirectory`     |  | `${project.build.directory}/alf_data`  | The temporary binary storage location for ACS. |



### Other APIs



Additional less important configurations are inherited from the following Maven Tiles.



*   [`beedk-run-tile`](/inteligr8/ootbee-beedk/src/stable/beedk-run-tile)



## Results



The ACS Platform, database, and MQ components will be started during the `process-classes` Maven phase.

beedk-aps-ext-rad-tile/pom.xml

0 → 100644
+48 −0
Original line number Diff line number Diff line 
<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0"

		xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

		xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

	

	<modelVersion>4.0.0</modelVersion>



	<groupId>com.inteligr8.ootbee</groupId>

	<artifactId>beedk-aps-ext-rad-tile</artifactId>

	<version>1.0-SNAPSHOT</version>

	<packaging>tile</packaging>



	<name>Order of the Bee Development Kit: RAD for APS Extensions</name>

	<scm>

		<url>https://bitbucket.org/inteligr8/ootbee-beedk</url>

	</scm>

	<organization>

		<name>Order of the Bee</name>

		<url>https://orderofthebee.net</url>

	</organization>

	<developers>

		<developer>

			<name>Brian Long</name>

			<email>brian@inteligr8.com</email>

			<organization>Inteligr8</organization>

			<organizationUrl>https://www.inteligr8.com</organizationUrl>

			<url>https://twitter.com/brianmlong</url>

		</developer>

	</developers>

	

	<build>

		<plugins>

			<plugin>

				<groupId>io.repaint.maven</groupId>

				<artifactId>tiles-maven-plugin</artifactId>

				<version>2.20</version>

				<extensions>true</extensions>

				<configuration>

					<filtering>true</filtering>

					<tiles>

						<tile>com.inteligr8:maven-public-deploy-tile:[1.0.0,2.0.0)</tile>

					</tiles>

				</configuration>

			</plugin>

		</plugins>

	</build>



</project>

beedk-aps-ext-rad-tile/tile.xml

0 → 100644
+171 −0
Original line number Diff line number Diff line 
<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://tiles.bluetrainsoftware.com/maven/tiles/1.1.0"

 		xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

 		xsi:schemaLocation="http://tiles.bluetrainsoftware.com/maven/tiles/1.1.0 https://bitbucket.org/inteligr8/maven-tiles/raw/xsd/src/main/resources/maven-tiles.xsd">



	<profiles>

		<profile>

			<id>rad-aps</id>

			<activation>

				<property>

					<name>rad</name>

				</property>

			</activation>

			<build>

				<plugins>

					<!-- This plugin downloads the parameterized WAR -->

					<plugin>

						<artifactId>maven-dependency-plugin</artifactId>

						<version>3.1.2</version>

						<executions>

							<!-- This execution downloads the parameterized WAR -->

							<execution>

								<id>download-webapp</id>

								<phase>process-classes</phase>

								<goals><goal>copy</goal></goals>

								<configuration>

									<artifactItems>

										<artifactItem>

											<groupId>${aps.war.groupId}</groupId>

											<artifactId>${aps.war.artifactId}</artifactId>

											<version>${aps.war.version}</version>

											<type>war</type>

										</artifactItem>

									</artifactItems>

									<outputDirectory>${project.build.warDirectory}</outputDirectory>

								</configuration>

							</execution>

						</executions>

					</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-aps</id>

								<phase>process-classes</phase>

								<goals><goal>start</goal></goals>

								<configuration>

									<images>

										<image>

											<name>postgres:${aps-postgres.version}</name>

											<alias>acs-db</alias>

											<run>

												<env>

													<POSTGRES_PASSWORD>activiti</POSTGRES_PASSWORD>

													<POSTGRES_USER>activiti</POSTGRES_USER>

													<POSTGRES_DB>activiti</POSTGRES_DB>

												</env>

												<ports>

													<port>${aps-postgres.port}:5432</port>

												</ports>

												<network>

													<mode>custom</mode>

													<name>${project.artifactId}</name>

												</network>

											</run>

										</image>

										<image>

											<name>docker.inteligr8.com/inteligr8/tomcat-rad:${tomcat-rad.version}</name>

											<alias>aps</alias>

											<run>

												<env>

													<JAVA_MEMORY_MAX>${aps.memory}</JAVA_MEMORY_MAX>

													<CATALINA_OPTS>-Ddir.root=/tmp/alf_data -Ddb.driver=org.postgresql.Driver -Ddb.url=jdbc:postgresql://${project.artifactId}-acs-db:5432/alfresco \

														-Dmessaging.broker.url=failover:\(tcp://${project.artifactId}-acs-mq:61616\)?timeout\=3000\&amp;jms.useCompression\=true \

														-Dtransform.service.enabled=${beedk.rad.ats.enabled} -Dtransform.service.url=http://${project.artifactId}-ats-atr:8095 -Dsfs.url=http://${project.artifactId}-ats-sfs:8099 \

														-Dlocal.transform.service.enabled=${beedk.rad.alts.enabled} \

														-DlocalTransform.core-aio.url=http://${project.artifactId}-ate-aio:8090 -DlocalTransform.ate.url=http://${project.artifactId}-ate:8090 \

														-Djodconverter.enabled=false -Dsystem.workflow.engine.activiti.enabled=true \

														-Dalfresco-pdf-renderer.url=http://${project.artifactId}-ate-aio:8090 -Djodconverter.url=http://${project.artifactId}-ate-aio:8090 -Dimg.url=http://${project.artifactId}-ate-aio:8090 -Dtika.url=http://${project.artifactId}-ate-aio:8090 -Dtransform.misc.url=http://${project.artifactId}-ate-aio:8090 \

														-Dindex.subsystem.name=${beedk.rad.platform.index} -Dsolr.host=${project.artifactId}-acs-search -Dsolr.secureComms=none \

														${aps.tomcat.opts}</CATALINA_OPTS>

												</env>

												<ports>

													<port>${aps.port}:8080</port>

													<port>${aps.debugger.port}:8000</port>

												</ports>

												<network>

													<mode>custom</mode>

													<name>${project.artifactId}</name>

												</network>

												<volumes>

													<bind>

														<volume>${beedk.deploy.aps.warFile}:/var/lib/tomcat/webapps/activiti-app.war:ro</volume>

														<volume>${beedk.deploy.aps.classesDirectory}:/var/lib/tomcat/dev/classes:ro</volume>

														<volume>${beedk.deploy.aps.testClassesDirectory}:/var/lib/tomcat/dev/classes-extra1:ro</volume>

														<volume>${beedk.deploy.aps.extDirectory}:/var/lib/tomcat/dev/lib:ro</volume>

													</bind>

												</volumes><!--

												<wait>

													<http>

														<url>http://localhost:${aps.port}/activiti-app/service/api/server</url>

														<method>GET</method>

														<status>200..399</status>

													</http>

													<time>${aps.timeout}</time>

												</wait>-->

											</run>

										</image>

									</images>

								</configuration>

							</execution>

						</executions>

					</plugin>

				</plugins>

			</build>

		</profile>

		<!-- allow downstream tiles to default this before this tile does -->

		<profile>

			<id>tomcat-opts-unspecified</id>

			<activation>

				<property>

					<name>!aps.tomcat.opts</name>

				</property>

			</activation>

			<properties>

				<aps.tomcat.opts></aps.tomcat.opts>

			</properties>

		</profile>

		<profile>

			<id>default-props</id>

			<activation>

				<property>

					<name>!some-prop-that-never-exists</name>

				</property>

			</activation>

			<properties>

				<!-- configurable -->

				<aps.war.groupId>org.alfresco</aps.war.groupId>

				<aps.war.artifactId>activiti-app</aps.war.artifactId>

				<project.build.warDirectory>${project.build.directory}/war</project.build.warDirectory>

				<beedk.deploy.aps.classesDirectory>${project.build.directory}/doesnotexist</beedk.deploy.aps.classesDirectory>

				<beedk.deploy.aps.testClassesDirectory>${project.build.directory}/doesnotexist</beedk.deploy.aps.testClassesDirectory>

				<beedk.deploy.aps.extDirectory>${project.build.directory}/doesnotexist</beedk.deploy.aps.extDirectory>

				<beedk.deploy.aps.warDirectory>${project.build.warDirectory}</beedk.deploy.aps.warDirectory>

				<aps.timeout>60000</aps.timeout>

				<aps.memory>512m</aps.memory>



				<!-- ports -->

				<aps-postgres.port>5432</aps-postgres.port>

				<aps.port>8080</aps.port>

				<aps.debugger.port>8000</aps.debugger.port>

				

				<!-- versions -->

				<aps.version>1.11.1.1</aps.version>

				<tomcat-rad.version>9-1.3</tomcat-rad.version>



				<!-- results -->

				<project.build.warFile>${project.build.warDirectory}/${aps.war.artifactId}-${aps.war.version}.war</project.build.warFile>

			</properties>

		</profile>

	</profiles>

	

	<tiles>

		<!-- Documentation: https://bitbucket.org/inteligr8/ootbee-beedk/src/stable/beedk-run-tile -->

		<tile>@project.groupId@:beedk-run-tile:@project.version@</tile>

	</tiles>



</project>

pom.xml

+1 −0
Original line number Diff line number Diff line
@@ -49,6 +49,7 @@ 
		<module>beedk-acs-share-self-rad-tile</module>

		<module>beedk-ate-self-rad-tile</module>

		<module>beedk-ate-sibling-rad-tile</module>

		<module>beedk-aps-ext-rad-tile</module>



		<module>beedk-acs-search-it-tile</module>

		<module>beedk-acs-lts-it-tile</module>