Permalink
Browse files

Initial sync of EAP and WildFly quickstarts

- introduce common parent
- use failsafe for testing
- docs can now be generated without need of ruby
  • Loading branch information...
ctomc committed Feb 21, 2017
1 parent 218671f commit 8244f4fc23d09a54e837176bf17cdbb88395ce09
Showing 603 changed files with 52,371 additions and 34,381 deletions.
@@ -1,12 +1,12 @@
WildFly Quickstarts
${product.name.full} (${product.name}) Quickstarts
====================
Summary: The quickstarts demonstrate Java EE 7 and a few additional technologies from the JBoss stack. They provide small, specific, working examples that can be used as a reference for your own project.
Summary: The quickstarts demonstrate Java EE 7 and a few additional technologies from the JBoss stack. They provide small, specific, working examples that can be used as a reference for your own project.
Introduction
------------
These quickstarts run on JBoss WildFly. This version uses the correct dependencies and ensures you test and compile against your runtime environment.
These quickstarts run on ${product.name.full} ${product.version} or later. We recommend using the ${product.name} ZIP file. This version uses the correct dependencies and ensures you test and compile against your runtime environment.
Be sure to read this entire document before you attempt to work with the quickstarts. It contains the following information:
@@ -16,7 +16,7 @@ Be sure to read this entire document before you attempt to work with the quickst
* [System Requirements](#system-requirements): List of software required to run the quickstarts.
* [Configure Maven](https://github.com/jboss-developer/jboss-developer-shared-resources/blob/master/guides/CONFIGURE_MAVEN.md): How to configure the Maven repository for use by the quickstarts.
* [Configure Maven](https://github.com/jboss-developer/jboss-developer-shared-resources/blob/master/guides/CONFIGURE_MAVEN_JBOSS_EAP7.md#configure-maven-to-build-and-deploy-the-quickstarts): How to configure the Maven repository for use by the quickstarts.
* [Run the Quickstarts](#run-the-quickstarts): General instructions for building, deploying, and running the quickstarts.
@@ -26,18 +26,18 @@ Be sure to read this entire document before you attempt to work with the quickst
* [Contributing Guide](https://github.com/jboss-developer/jboss-developer-shared-resources/blob/master/guides/CONTRIBUTING.md#jboss-developer-contributing-guide): This document contains information targeted for developers who want to contribute to JBoss developer projects.
Use of WILDFLY_HOME and JBOSS_HOME Variables
Use of ${jboss.home.name} and JBOSS_HOME Variables
---------------------------------
The quickstart README files use the *replaceable* value `WILDFLY_HOME` to denote the path to the WildFly installation. When you encounter this value in a README file, be sure to replace it with the actual path to your WildFly installation. The installation path is described in detail here: [Use of WILDFLY_HOME and JBOSS_HOME Variables](https://github.com/jboss-developer/jboss-developer-shared-resources/blob/master/guides/USE_OF_EAP7_HOME.md#use-of-eap_home-and-jboss_home-variables).
The quickstart README files use the *replaceable* value `${jboss.home.name}` to denote the path to the ${product.name} installation. When you encounter this value in a README file, be sure to replace it with the actual path to your ${product.name} installation. The installation path is described in detail here: [Use of ${jboss.home.name} and JBOSS_HOME Variables](https://github.com/jboss-developer/jboss-developer-shared-resources/blob/master/guides/USE_OF_${jboss.home.name}.md#use-of-eap_home-and-jboss_home-variables).
Available Quickstarts
---------------------
All available quickstarts can be found here: <http://www.jboss.org/developer-materials/#!formats=jbossdeveloper_quickstart>. You can filter by the quickstart name, the product, and the technologies demonstrated by the quickstart. You can also limit the results based on skill level and date published. The resulting page provides a brief description of each matching quickstart, the skill level, and the technologies used. Click on the quickstart to see more detailed information about how to run it. Some quickstarts require deployment of other quickstarts. This information is noted in the `Prerequisites` section of the quickstart README file.
_Note_: Some of these quickstarts use the H2 database included with WildFly. It is a lightweight, relational example datasource that is used for examples only. It is not robust or scalable, is not supported, and should NOT be used in a production environment!
_Note_: Some of these quickstarts use the H2 database included with ${product.name}. It is a lightweight, relational example datasource that is used for examples only. It is not robust or scalable, is not supported, and should NOT be used in a production environment!
[TOC-quickstart]
@@ -56,11 +56,11 @@ We suggest you approach the quickstarts as follows:
System Requirements
-------------------
The applications these projects produce are designed to be run on Red Hat JBoss Enterprise Application Platform 7 or later.
The applications these projects produce are designed to be run on ${product.name.full} ${product.version} or later.
All you need to build these projects is Java 8.0 (Java SDK 1.8) or later and Maven 3.1.1 or later. See [Configure Maven for WildFly 10](https://github.com/jboss-developer/jboss-developer-shared-resources/blob/master/guides/CONFIGURE_MAVEN_JBOSS_EAP7.md#configure-maven-to-build-and-deploy-the-quickstarts) to make sure you are configured correctly for testing the quickstarts.
All you need to build these projects is ${build.requirements}. See [Configure Maven for ${product.name} ${product.version}](https://github.com/jboss-developer/jboss-developer-shared-resources/blob/master/guides/CONFIGURE_MAVEN_JBOSS_EAP7.md#configure-maven-to-build-and-deploy-the-quickstarts) to make sure you are configured correctly for testing the quickstarts.
To run these quickstarts with the provided build scripts, you need the the WildFly distribution ZIP. For information on how to install and run JBoss, see the [Red Hat JBoss Enterprise Application Platform Documentation](https://access.redhat.com/documentation/en-US/JBoss_Enterprise_Application_Platform/) _Getting Started Guide_ located on the Customer Portal.
To run these quickstarts with the provided build scripts, you need the ${product.name} distribution ZIP. For information on how to install and run JBoss, see the [${product.name.full} Documentation](https://access.redhat.com/documentation/en/red-hat-jboss-enterprise-application-platform/) _Getting Started Guide_ located on the Customer Portal.
You can also use [JBoss Developer Studio or Eclipse](#use-jboss-developer-studio-or-eclipse-to-run-the-quickstarts) to run the quickstarts.
@@ -70,10 +70,10 @@ Run the Quickstarts
The root folder of each individual quickstart contains a README file with specific details on how to build and run the example. In most cases you do the following:
* [Start the WildFly Server](https://github.com/jboss-developer/jboss-developer-shared-resources/blob/master/guides/START_JBOSS_EAP.md#start-the-jboss-eap-server)
* [Start the ${product.name} Server](https://github.com/jboss-developer/jboss-developer-shared-resources/blob/master/guides/START_JBOSS_EAP.md#start-the-jboss-eap-server)
* [Build and deploy the quickstarts](#build-and-deploy-the-quickstarts)
### Build and Deploy the Quickstarts
See the README file in each individual quickstart folder for specific details and information on how to run and access the example.
@@ -92,7 +92,7 @@ In most cases, you can use the following steps to build the application to test
In most cases, you can use the following steps to build and deploy the application. See the specific quickstart README file for complete details.
1. Make sure you start the WildFly server as described in the quickstart README file.
1. Make sure you start the ${product.name} server as described in the quickstart README file.
2. Open a command prompt and navigate to the root directory of the quickstart you want to run.
3. Use this command to build and deploy the archive:
@@ -108,21 +108,16 @@ The command to undeploy the quickstart is simply:
### Verify the Quickstarts Build with One Command
-------------------------------------------------
You can verify the quickstarts build using one command. However, quickstarts that have complex dependencies must be skipped. For example, the `resteasy-jaxrs-client` quickstart is a RESTEasy client that depends on the deployment of the _helloworld-rs_ quickstart. As noted above, the root `pom.xml` file defines a `complex-dependencies` profile to exclude these quickstarts from the root build process.
You can verify the quickstarts build using one command. However, quickstarts that have complex dependencies must be skipped. For example, the `resteasy-jaxrs-client` quickstart is a RESTEasy client that depends on the deployment of the `helloworld-rs` quickstart. As noted above, the root `pom.xml` file defines a `complex-dependencies` profile to exclude these quickstarts from the root build process.
To build the quickstarts:
1. Do not start the WildFly server.
1. Do not start the ${product.name} server.
2. Open a command prompt and navigate to the root directory of the quickstarts.
3. Use this command to build the quickstarts that do not have complex dependencies:
mvn clean install '-Pdefault,!complex-dependencies'
_Note_: If you see a `java.lang.OutOfMemoryError: PermGen space` error when you run this command, increase the memory by typing the following command for your operating system, then try the above command again.
For Linux: export MAVEN_OPTS="-Xmx512m -XX:MaxPermSize=128m"
For Windows: SET MAVEN_OPTS="-Xmx512m -XX:MaxPermSize=128m"
### Undeploy the Deployed Quickstarts with One Command
------------------------------------------------------
@@ -131,7 +126,7 @@ To undeploy the quickstarts from the root of the quickstart folder, you must pas
You can undeploy quickstarts using the following procedure:
1. Start the WildFly server.
1. Start the ${product.name} server.
2. Open a command prompt and navigate to the root directory of the quickstarts.
3. Use this command to undeploy any deployed quickstarts:
@@ -140,10 +135,10 @@ You can undeploy quickstarts using the following procedure:
To undeploy any quickstarts that fail due to complex dependencies, follow the undeploy procedure described in the quickstart's README file.
Use JBoss Developer Studio or Eclipse to Run the Quickstarts
Run the Quickstarts in Red Hat JBoss Developer Studio or Eclipse
------------------------------------------------------------
You can also deploy the quickstarts from Eclipse using JBoss tools. For more information on how to set up Maven and the JBoss tools, see the [Red Hat JBoss Enterprise Application Platform Documentation](https://access.redhat.com/documentation/en-US/JBoss_Enterprise_Application_Platform/) _Getting Started Guide_ and _Development Guide_ or [Get Started with JBoss Developer Studio](http://www.jboss.org/products/devstudio/get-started/ "Get Started with JBoss Developer Studio").
You can also start the server and deploy the quickstarts or run the Arquillian tests from Eclipse using JBoss tools. For general information about how to import a quickstart, add a ${product.name} server, and build and deploy a quickstart, see [Use JBoss Developer Studio or Eclipse to Run the Quickstarts](${use.eclipse.url}).
Optional Components
@@ -4,13 +4,13 @@ Quickstarts Release Procedure
Testing the quickstarts
-----------------------
Most of the quickstarts require JBoss WildFly only in standalone mode. Some require the "standalone-full" profile, some require XTS, some require Postgres and some require other quickstarts to be deployed. Profiles are used in the root POM to separate out these groups, allowing you to test the quickstarts easily. For example, to run those that require only standalone mode:
Most of the quickstarts require starting ${product.name.full} in standalone mode. Some require the "standalone-full" profile, some require XTS, some require Postgres and some require other quickstarts to be deployed. Profiles are used in the root POM to separate out these groups, allowing you to test the quickstarts easily. For example, to run those that require only standalone mode:
mvn clean install wildfly:deploy wildfly:undeploy -Parq-wildfly-remote -P-requires-postgres,-requires-full,-complex-dependencies,-requires-xts
mvn clean verify wildfly:deploy wildfly:undeploy -Parq-wildfly-remote -P-requires-postgres,-requires-full,-complex-dependencies,-requires-xts
Or, to run those only those quickstarts that require the full profile
mvn clean install wildfly:deploy wildfly:undeploy -Parq-wildfly-remote -P-requires-postgres,-default,-complex-dependencies,-requires-xts
mvn clean verify wildfly:deploy wildfly:undeploy -Parq-wildfly-remote -P-requires-postgres,-default,-complex-dependencies,-requires-xts
And so on.
Oops, something went wrong.

0 comments on commit 8244f4f

Please sign in to comment.