Author: YOUR_NAME and optional CONTACT_INFO Level: [one of the following: Beginner, Intermediate, or Advanced] Technologies: (list technologies used here) Summary: (a brief description of the demo to appear in the table ) Prerequisites: (list any demo that must be deployed prior to running this one) Target Product: (EAP, WFK, JDG, etc) Product Versions: (EAP 6.1, EAP 6.2, etc) Source: (The URL for the repository that is the source of record for this demo)
This file is meant to serve as a template or guideline for your own demo README.md file. Be sure to replace DEMO_NAME and YOUR_NAME, with the appropriate values.
Contributor instructions are prefixed with 'Contributor: '
Contributor: This is where you provide an overview of what the demo demonstrates. For example:
- What are the technologies demonstrated by the demo?
- What does it do when you run it?
You should include any information that would help the user understand the demo.
If possible, give an overview, including any code they should look at to understand how it works..
Contributor: For example:
The application this project produces is designed to be run on Red Hat JBoss Enterprise Application Platform 6.1 or later.
All you need to build this project is Java 6.0 (Java SDK 1.6) or later, Maven 3.0 or later.
Contributor: You can copy the Maven configuration information in https://github.com/jboss-developer/jboss-developer-shared-resources/blob/master/guides/CONFIGURE_MAVEN.md. For example:
If you have not yet done so, you must Configure Maven before testing the demo.
Contributor: If your demo requires any additional components, decribe how to set them up here. If your demo requires a secured user, PostgreSQL, or Byteman, you can link to the instructions in the README file located in https://github.com/jboss-developer/jboss-developer-shared-resources/tree/master/guides. Here are some examples:
-
This demo uses a secured management interface and requires that you create a management (or application) user to access the running application. Instructions to set up a Management (or Application) user can be found here:
-
This demo requires the PostgreSQL database. Instructions to install an configure PostgreSQL can be found here: Install and Configure the PostgreSQL Database
-
This demo uses Byteman to help demonstrate crash recovery. Instructions to install and configure Byteman can be found here: Install and Configure Byteman
Contributor: Does this demo require one or more running servers? If so, you must show how to start the server. If you start the server in one of the following 3 ways, you can simply copy the instructions in the README file located in the root folder of the demo directory:
-
Start the JBoss Server
-
Start the JBoss Server with the Full Profile
-
Start the JBoss Server with Custom Options. You will need to provide the argument string to pass on the command line, for example:
--server-config=../../docs/examples/configs/standalone-xts.xml
Contributor: If the server is started in a different manner than above, give the specific instructions.
Contributor: If the demo is built and deployed using the standard Maven commands, "mvn install package" and "mvn jboss-as:deploy", copy the following:
NOTE: The following build command assumes you have configured your Maven user settings. If you have not, you must include Maven setting arguments on the command line. See Configure Maven to Build and Deploy the Quickstarts for complete instructions and additional options.
-
Make sure you have started the JBoss Server as described above.
-
Open a command line and navigate to the root directory of this demo.
-
Type this command to build and deploy the archive:
mvn clean install jboss-as:deploy -
This will deploy
target/jboss-DEMO_NAME.war(ortarget/jboss-DEMO_NAME.ear) to the running instance of the server.
Contributor: Be sure to replace the DEMO_NAME. If this demo requires different or additional instructions, be sure to modify or add those instructions here.
Contributor: Provide the URL to access the running application. Be sure to make the URL a hyperlink as below, substituting the your demo name for the DEMO_NAME.
Access the running application in a browser at the following URL: <http://localhost:8080/jboss-DEMO_NAME>
Contributor: Briefly describe what you will see when you access the application. For example:
You will be presented with a simple form for adding key/value pairs and a checkbox to indicate whether the updates should be executed using an unmanaged component.
If the box is checked, the updates will be executed within a session bean method.
If the box is not checked, the transactions and JPA updates will run in a servlet instead of session beans.
To list all existing key/value pairs, leave the key input box empty.
To add or update the value of a key, enter a key and value input boxe and click the submit button to see the results.
Contributor: Add any information that will help them run and understand your demo.
Contributor: For example:
-
Make sure you have started the JBoss Server as described above.
-
Open a command line and navigate to the root directory of this demo.
-
When you are finished testing, type this command to undeploy the archive:
mvn jboss-as:undeploy
Contributor: For example:
This demo provides Arquillian tests. By default, these tests are configured to be skipped as Arquillian tests require the use of a container.
NOTE: The following commands assume you have configured your Maven user settings. If you have not, you must include Maven setting arguments on the command line. See Run the Arquillian Tests for complete instructions and additional options.
-
Make sure you have started the JBoss Server as described above.
-
Open a command line and navigate to the root directory of this demo.
-
Type the following command to run the test goal with the following profile activated:
mvn clean test -Parq-jbossas-remote
Contributor: The demo README should show what to expect from the the tests
-
Copy and paste output from the JUnit tests to show what to expect in the console from the tests.
-
Copy and paste log messages output by the application to show what to expect in the server log when running the tests.
Contributor: For example:
You can also start the server and deploy the demo from Eclipse using JBoss tools. For more information, see Use JBoss Developer Studio or Eclipse to Run the Quickstarts
Contributor: For example:
If you want to debug the source code or look at the Javadocs of any library in the project, run either of the following commands to pull them into your local repository. The IDE should then detect them.
mvn dependency:sources
mvn dependency:resolve -Dclassifier=javadoc
Contributor: If the demo deploys to OpenShift, you can use the following template a starting point to describe the process. Be sure to note:
- APPLICATION_NAME should be replaced with a variation of the demo name, for example: mydemo
- DEMO_NAME should be replaced with your demo name, for example: my-demo
If you do not yet have an OpenShift account and domain, Sign in to OpenShift to create the account and domain. Get Started with OpenShift will show you how to install the OpenShift Express command line interface.
Open a shell command prompt and change to a directory of your choice. Enter the following command, replacing APPLICATION_TYPE with jbosseap-6 for demos running on JBoss EAP 6.1:
rhc app create -a APPLICATION_NAME -t APPLICATION_TYPE
NOTE: The domain name for this application will be APPLICATION_NAME-YOUR_DOMAIN_NAME.rhcloud.com`. Here we use the demo domain. You will need to replace it with your own OpenShift domain name.
This command creates an OpenShift application named and will run the application inside the jbosseap-6 container. You should see some output similar to the following:
Creating application: APPLICATION_NAME
Now your new domain name is being propagated worldwide (this might take a minute)...
Warning: Permanently added 'APPLICATION_NAME-demo.rhcloud.com,107.22.36.32' (RSA) to the list of known hosts.
Confirming application 'APPLICATION_NAME' is available: Success!
APPLICATION_NAME published: http://APPLICATION_NAME-demo.rhcloud.com/
git url: ssh://b92047bdc05e46c980cc3501c3577c1e@APPLICATION_NAME-demo.rhcloud.com/~/git/APPLICATION_NAME.git/
Successfully created application: APPLICATION_NAME
The create command creates a git repository in the current directory with the same name as the application. Notice that the output also reports the URL at which the application can be accessed. Make sure it is available by typing the published url http://APPLICATION_NAME-demo.rhcloud.com/ into a browser or use command line tools such as curl or wget.
Now that you have confirmed it is working you can migrate the demo source. You do not need the generated default application, so navigate to the new git repository directory and tell git to remove the source and pom files:
cd APPLICATION_NAME
git rm -r src pom.xml
Copy the source for the DEMO_NAME demo into this new git repository:
cp -r DEMO_HOME/src .
cp DEMO_HOME/pom.xml .
Contributor: Here you describe any modifications needed for the .openshift/config/standalone.xml file. See other demo README.md files for examples.
You can now deploy the changes to your OpenShift application using git as follows:
git add src pom.xml
git commit -m "DEMO_NAME demo on OpenShift"
git push
The final push command triggers the OpenShift infrastructure to build and deploy the changes.
Note that the openshift profile in pom.xml is activated by OpenShift, and causes the war build by openshift to be copied to the deployments directory, and deployed without a context path.
When the push command returns you can test the application by getting the following URL either via a browser or using tools such as curl or wget:
You can use the OpenShift command line tools or the OpenShift web console to discover and control the application.
When you are finished with the application you can destroy it as follows:
rhc app destroy -a APPLICATION_NAME
Note: There is a limit to the number of applications you can deploy concurrently to OpenShift. If the rhc app create command returns an error indicating you have reached that limit, you must destroy an existing application before you continue.
- To view the list of your OpenShift applications, type:
rhc domain show - To destroy an existing application, type the following, substituting the application name you want to destroy:
rhc app destroy -a APPLICATION_NAME_TO_DESTROY