diff --git a/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/README.md b/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/README.md index 315d28f7..01c8a936 100644 --- a/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/README.md +++ b/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/README.md @@ -2,30 +2,43 @@ This is an All-In-One (AIO) project for Alfresco SDK 4.0. -Run with `mvn clean install -DskipTests=true alfresco:run` or `./run.sh` and verify that it +Run with `./run.sh build_start` or `./run.bat build_start` and verify that it - * Runs the embedded Tomcat + H2 DB - * Runs Alfresco Platform (Repository) - * Runs Alfresco Solr4 + * Runs Alfresco Content Service (ACS) * Runs Alfresco Share - * Packages both as JAR and AMP assembly for modules + * Runs Alfresco Search Service (ASS) + * Runs PostgreSQL database + * Deploys the JAR assembled modules + +All the services of the project are now run as docker containers. The run script offers the next tasks: + + * `build_start`. Build the whole project, recreate the ACS and Share docker images, start the dockerised environment composed by ACS, Share, ASS and + PostgreSQL and tail the logs of all the containers. + * `start`. Start the dockerised environment without building the project and tail the logs of all the containers. + * `stop`. Stop the dockerised environment. + * `purge`. Stop the dockerised container and delete all the persistent data (docker volumes). + * `tail`. Tail the logs of all the containers. + * `reload_share`. Build the Share module, recreate the Share docker image and restart the Share container. + * `reload_acs`. Build the ACS module, recreate the ACS docker image and restart the ACS container. + * `build_test`. Build the whole project, recreate the ACS and Share docker images, start the dockerised environment, execute the integration tests from the + `integration-tests` module and stop the environment. + * `test`. Execute the integration tests (the environment must be already started). # Few things to notice * No parent pom - * No WAR projects, all handled by the Alfresco Maven Plugin - * No runner project - it's all in the Alfresco Maven Plugin + * No WAR projects, the jars are included in the custom docker images + * No runner project - the Alfresco environment is now managed through [Docker](https://www.docker.com/) * Standard JAR packaging and layout * Works seamlessly with Eclipse and IntelliJ IDEA - * JRebel for hot reloading, JRebel maven plugin for generating rebel.xml, agent usage: `MAVEN_OPTS=-Xms256m -Xmx1G -agentpath:/home/martin/apps/jrebel/lib/libjrebel64.so` + * JRebel for hot reloading, JRebel maven plugin for generating rebel.xml [JRebel integration documentation] * AMP as an assembly - * [Configurable Run mojo](https://github.com/Alfresco/alfresco-sdk/blob/sdk-3.0/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/RunMojo.java) in the `alfresco-maven-plugin` - * No unit testing/functional tests just yet + * Persistent test data through restart thanks to the use of Docker volumes for ACS, ASS and database data + * Integration tests module to execute tests against the final environment (dockerised) * Resources loaded from META-INF * Web Fragment (this includes a sample servlet configured via web fragment) # TODO * Abstract assembly into a dependency so we don't have to ship the assembly in the archetype - * Purge * Functional/remote unit tests diff --git a/archetypes/alfresco-platform-jar-archetype/src/main/resources/archetype-resources/README.md b/archetypes/alfresco-platform-jar-archetype/src/main/resources/archetype-resources/README.md index 015550db..78a55f6e 100644 --- a/archetypes/alfresco-platform-jar-archetype/src/main/resources/archetype-resources/README.md +++ b/archetypes/alfresco-platform-jar-archetype/src/main/resources/archetype-resources/README.md @@ -1,34 +1,42 @@ -# Alfresco Platform JAR Module - SDK 3 +# Alfresco ACS JAR Module - SDK 4.0 -To run use `mvn clean install -DskipTests=true alfresco:run` or `./run.sh` and verify that it +This is an ACS project for Alfresco SDK 4.0. - * Runs the embedded Tomcat - * Runs Alfresco Platform (Repository) - * Packages both as JAR and AMP assembly - - Try cloning it, change the port and play with `enableShare` and `enablePlatform`. - - Protip: This module will work just fine as a Share module if the files are changed and - if the enablePlatform and enableSolr is disabled. +Run with `./run.sh build_start` or `./run.bat build_start` and verify that it + + * Runs Alfresco Content Service (ACS) + * (Optional) Runs Alfresco Share + * Runs Alfresco Search Service (ASS) + * Runs PostgreSQL database + * Deploys the JAR assembled module +All the services of the project are now run as docker containers. The run script offers the next tasks: + + * `build_start`. Build the whole project, recreate the ACS docker image, start the dockerised environment composed by ACS, Share (optional), ASS + and PostgreSQL and tail the logs of all the containers. + * `start`. Start the dockerised environment without building the project and tail the logs of all the containers. + * `stop`. Stop the dockerised environment. + * `purge`. Stop the dockerised container and delete all the persistent data (docker volumes). + * `tail`. Tail the logs of all the containers. + * `reload_acs`. Build the ACS module, recreate the ACS docker image and restart the ACS container. + * `build_test`. Build the whole project, recreate the ACS docker image, start the dockerised environment, execute the integration tests and stop + the environment. + * `test`. Execute the integration tests (the environment must be already started). + # Few things to notice * No parent pom - * WAR assembly is handled by the Alfresco Maven Plugin configuration + * No WAR projects, the jars are included in the custom docker images + * No runner project - the Alfresco environment is now managed through [Docker](https://www.docker.com/) * Standard JAR packaging and layout * Works seamlessly with Eclipse and IntelliJ IDEA - * JRebel for hot reloading, JRebel maven plugin for generating rebel.xml, agent usage: `MAVEN_OPTS=-Xms256m -Xmx1G -agentpath:/home/martin/apps/jrebel/lib/libjrebel64.so` + * JRebel for hot reloading, JRebel maven plugin for generating rebel.xml [JRebel integration documentation] * AMP as an assembly - * [Configurable Run mojo](https://github.com/Alfresco/alfresco-sdk/blob/sdk-3.0/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/RunMojo.java) in the `alfresco-maven-plugin` - * No unit testing/functional tests just yet + * Persistent test data through restart thanks to the use of Docker volumes for ACS, ASS and database data * Resources loaded from META-INF * Web Fragment (this includes a sample servlet configured via web fragment) - + # TODO - + * Abstract assembly into a dependency so we don't have to ship the assembly in the archetype - * Purge, * Functional/remote unit tests - - - diff --git a/archetypes/alfresco-share-jar-archetype/src/main/resources/archetype-resources/README.md b/archetypes/alfresco-share-jar-archetype/src/main/resources/archetype-resources/README.md index 87588fb8..9a83e9e2 100644 --- a/archetypes/alfresco-share-jar-archetype/src/main/resources/archetype-resources/README.md +++ b/archetypes/alfresco-share-jar-archetype/src/main/resources/archetype-resources/README.md @@ -1,29 +1,43 @@ # Alfresco Share JAR Module - SDK 4.0 -To run this module use `mvn clean install -DskipTests=true alfresco:run` or `./run.sh` and verify that it +This is a Share project for Alfresco SDK 4.0. - * Runs the embedded Tomcat + H2 DB +Run with `./run.sh build_start` or `./run.bat build_start` and verify that it + + * Runs Alfresco Content Service (ACS) * Runs Alfresco Share - * Packages both as JAR and AMP assembly + * Runs Alfresco Search Service (ASS) + * Runs PostgreSQL database + * Deploys the JAR assembled module + +All the services of the project are now run as docker containers. The run script offers the next tasks: -Note. You access Share as follows: http://localhost:8081/share - -Note. You need an Alfresco Platform instance running at http://localhost:8080/alfresco that Share can talk to. - Typically you will just kick off a platform-jar module for that. + * `build_start`. Build the whole project, recreate the Share docker image, start the dockerised environment composed by ACS, Share, ASS and + PostgreSQL and tail the logs of all the containers. + * `start`. Start the dockerised environment without building the project and tail the logs of all the containers. + * `stop`. Stop the dockerised environment. + * `purge`. Stop the dockerised container and delete all the persistent data (docker volumes). + * `tail`. Tail the logs of all the containers. + * `reload_share`. Build the Share module, recreate the Share docker image and restart the Share container. + * `reload_acs`. Build the ACS module, recreate the ACS docker image and restart the ACS container. + * `build_test`. Build the whole project, recreate the Share docker image, start the dockerised environment, execute the integration tests from the + `integration-tests` module and stop the environment. + * `test`. Execute the integration tests (the environment must be already started). # Few things to notice * No parent pom - * WAR assembly is handled by the Alfresco Maven Plugin configuration, if needed + * No WAR projects, the jars are included in the custom docker images + * No runner project - the Alfresco environment is now managed through [Docker](https://www.docker.com/) * Standard JAR packaging and layout * Works seamlessly with Eclipse and IntelliJ IDEA - * JRebel for hot reloading, JRebel maven plugin for generating rebel.xml, agent usage: `MAVEN_OPTS=-Xms256m -Xmx1G -agentpath:/home/martin/apps/jrebel/lib/libjrebel64.so` + * JRebel for hot reloading, JRebel maven plugin for generating rebel.xml [JRebel integration documentation] * AMP as an assembly - * [Configurable Run mojo](https://github.com/Alfresco/alfresco-sdk/blob/sdk-3.0/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/RunMojo.java) in the `alfresco-maven-plugin` - * No unit testing/functional tests just yet + * Persistent test data through restart thanks to the use of Docker volumes for ACS, ASS and database data * Resources loaded from META-INF * Web Fragment (this includes a sample servlet configured via web fragment) # TODO * Abstract assembly into a dependency so we don't have to ship the assembly in the archetype + * Functional/remote unit tests diff --git a/pom.xml b/pom.xml index 8606b3bc..18f7d170 100644 --- a/pom.xml +++ b/pom.xml @@ -103,6 +103,13 @@ -5 http://rgauss.com/ + + Jose Luis Osorno Gil + joseluis.osorno@ixxus.com + Ixxus + http://www.ixxus.com + +1 +