cloud-1813 add quickstart for jdg71

josephites · Jun 22, 2017 · 85ef93c · 85ef93c
1 parent ba0f4cf
commit 85ef93c
Show file tree

Hide file tree

Showing 62 changed files with 5,257 additions and 0 deletions.
diff --git a/datagrid/71/carmart/README-openshift.md b/datagrid/71/carmart/README-openshift.md
@@ -0,0 +1,52 @@
+Running on OpenShift
+====================
+
+This quickstart is designed to run within OpenShift v3, accessing a remote Data
+Grid server running in the same OpenShift project (i.e. the remote-* profiles
+apply when running in OpenShift).
+
+This quickstart requires a hotrod service named carcache-hotrod.
+
+JBoss Data Grid Configuration
+-----------------------------
+
+This quickstart requires a JBoss Data Grid instance to be running within your OpenShift
+project.  An instance can be created easily using the **datagrid65-basic** template.
+
+In the OpenShift console, select a project and click *Add to Project*.  Select
+the *datagrid65-basic* template.  Set the following parameters as specified:
+
+* `APPLICATION_NAME`: carcache
+* `INFINISPAN_CONNECTORS`: hotrod
+* `CACHE_NAMES`: carcache
+
+Press *Create*.  This will create a JBoss Data Grid instance which provides the
+*carcache-hotrod* service.
+
+Creating the Quickstart Application
+-----------------------------------
+
+The Quickstart can be run on either JBoss EAP or JBoss Web Server.
+
+To create the application, select either the **eap64-basic-s2i**,
+**jws30-tomcat7-basic-s2i**, or **jws30-tomcat8-basic-s2i** templates, depending
+on the environment you want to use.  Specify the following for the source
+configuration:
+
+* `SOURCE_REPOSITORY_URL`: https://github.com/jboss-openshift/openshift-quickstarts
+* `SOURCE_REPOSITORY_REF`: 1.2
+* `CONTEXT_DIR`: datagrid/carmart
+
+> Note, the `SOURCE_REPOSITORY_REF` is the branch used when building the
+> source.  Latest source is always available in the `master` branch.
+
+Changes from the original quickstart
+------------------------------------
+
+The only changes that have been made to this quickstart are:
+
+* datagrid.properties:
+  * datagrid.host set to the hotrod service name: carcache-hotrod
+* pom.xml
+  * added activation based on env variables to remote-jboss and remote-tomcat profiles
+  * added openshift profile
diff --git a/datagrid/71/carmart/README-tomcat.md b/datagrid/71/carmart/README-tomcat.md
@@ -0,0 +1,144 @@
+carmart: Basic Infinispan example
+=================================
+Author: Tristan Tarrant, Martin Gencur
+Level: Intermediate
+Technologies: Infinispan, CDI
+Summary: Shows how to use Infinispan instead of a relational database.
+Product Versions: EWS 2, JDG 6.x
+
+What is it?
+-----------
+
+CarMart is a simple web application that uses Infinispan instead of a relational database.
+
+Users can list cars, add new cars or remove them from the CarMart. Information about each car is stored in a cache. The application also shows cache statistics like stores, hits, retrievals, etc.
+
+The CarMart quickstart can work in two modes: 
+
+* _Library mode_  - In this mode, the application and the data grid are running in the same JVM. All libraries (JAR files) are bundled with the application and deployed to Red Hat Enterprise Web Server (EWS). The library mode enables fastest (local) access to the entries stored on the same node as the application instance, but also enables access to data stored in remote nodes (JVMs) that comprise the embedded distributed cluster.
+
+* _Client-server mode_ - In this mode, the Cache is stored in a managed, distributed and clusterable data grid server.  Applications can remotely access the data grid server using Hot Rod, memcached or REST client APIs. This web application bundles only the HotRod client and communicates with a remote JBoss Data Grid (JDG) server. The JDG server is configured via the `standalone.xml` configuration file.
+
+
+System requirements
+-------------------
+
+All you need to build this project is Java 6.0 (Java SDK 1.6) or better, Maven 3.0 or better.
+
+The application this project produces is designed to be run on JBoss Enterprise Web Server 2 or Tomcat 7. 
+
+
+Configure EWS or Tomcat
+-----------------------
+
+Before starting EWS/Tomcat, add the following lines to `conf/tomcat-users.xml` to allow the Maven Tomcat plugin to access the manager application:
+
+        <role rolename="manager-script"/>
+        <user username="admin" password="admin" roles="manager-script"/>
+        
+Configure Maven
+---------------
+
+If you have not yet done so, you must [Configure Maven](../../README.md#configure-maven) before testing the quickstarts.
+
+
+Add a `<server>` element into your Maven settings.xml with `<id>` equal to tomcat and correct credentials:
+
+        <server>
+            <id>tomcat</id>
+            <username>admin</username>
+            <password>admin</password>
+        </server>
+
+        
+Start EWS or Tomcat
+-------------------
+
+1. Open a command line and navigate to the root of the EWS/Tomcat server directory.
+2. The following shows the command line to start the server with the web profile:
+
+        For Linux:   $TOMCAT7_HOME/bin/catalina.sh run
+        For Windows: %TOMCAT7_HOME%\bin\catalina.bat run
+
+
+Build and Deploy the Application in Library Mode
+-----------------------------------------------
+
+1. Make sure you have started EWS/Tomcat as described above.
+2. Open a command line and navigate to the root directory of this quickstart.
+3. Type this command to build and deploy the archive:
+
+        mvn -Plibrary-tomcat clean package tomcat:deploy
+        
+4. This will deploy `target/jboss-carmart.war` to the running instance of EWS/tomcat.
+
+
+Access the application
+---------------------
+
+The application will be running at the following URL: <http://localhost:8080/jboss-carmart/>
+
+
+Undeploy the Archive
+--------------------
+
+1. Make sure you have started Tomcat/EWS as described above.
+2. Open a command line and navigate to the root directory of this quickstart.
+3. When you are finished testing, type this command to undeploy the archive:
+
+    mvn -Plibrary-tomcat tomcat:undeploy
+
+
+Build and Start the Application in Client-Server Mode (using HotRod client)
+---------------------------------------------------------------------------
+
+1. Obtain the JDG server distribution. See the following for more information: <http://www.redhat.com/products/jbossenterprisemiddleware/data-grid/>
+
+2. Configure the remote datagrid in the `$JDG_HOME/standalone/configuration/standalone.xml` file. Copy the following XML into the Infinispan subsystem before the ending </cache-container> tag. If you have an existing `carcache` element, be sure to replace it with this one.
+
+            <local-cache name="carcache" start="EAGER" batching="false"/>
+
+3. Start the JDG server on localhost using port offset: 
+
+        $JDG_HOME/bin/standalone.sh -Djboss.socket.binding.port-offset=100
+
+4. Start EWS or Tomcat into which you want to deploy your application
+
+        $TOMCAT7_HOME/bin/catalina.sh run
+
+5. The application finds the JDG server using the values in the src/main/resources/META-INF/datagrid.properties file. If you are not running the JDG server on the default host and port, you must modify this file to contain the correct values. If you need to change the JDG address:port information, edit src/main/resources/META-INF/datagrid.properties file and specify address and port of the JDG server
+
+        datagrid.host=localhost
+        datagrid.hotrod.port=11322
+
+6. Build the application in the example's directory:
+
+        mvn clean package -Premote-tomcat
+
+7. Deploy the application
+
+        mvn tomcat:deploy -Premote-tomcat
+
+8. The application will be running at the following URL: <http://localhost:8080/jboss-carmart/>
+
+9. Undeploy the application
+
+        mvn tomcat:undeploy -Premote-tomcat
+
+
+Test the Application in Library Mode   
+------------------------------------
+
+If you want to test the application, there are simple Arquillian Selenium tests prepared.
+To run these tests on Tomcat:
+
+1. Undeploy the archive as described above
+2. Stop Tomcat Server
+3. Open a command line and navigate to the root directory of this quickstart.
+4. Build the quickstart using:
+
+        mvn clean package -Plibrary-tomcat
+
+5. Type this command to run the tests:
+
+        mvn test -Puitests-tomcat -Dtomcat7home=/path/to/server
diff --git a/datagrid/71/carmart/README.md b/datagrid/71/carmart/README.md
@@ -0,0 +1,157 @@
+carmart: Basic Infinispan example
+=================================
+Author: Tristan Tarrant, Martin Gencur
+Level: Intermediate
+Technologies: Infinispan, CDI
+Summary: Shows how to use Infinispan instead of a relational database.
+Target Product: JDG
+Product Versions: EAP 6.x, JDG 6.x
+Source: <https://github.com/infinispan/jdg-quickstart>
+
+What is it?
+-----------
+
+CarMart is a simple web application that uses Infinispan Cache instead of a relational database.
+
+Users can list cars, add new cars, or remove them from the CarMart. Information about each car is stored in a cache. The application also shows cache statistics like stores, hits, retrievals, and more.
+
+The CarMart quickstart can work in two modes: 
+
+* _Library mode_  - In this mode, the application and the data grid are running in the same JVM. All libraries (JAR files) are bundled with the application and deployed to Red Hat JBoss Enterprise Application Platform. The library mode enables fastest (local) access to the entries stored on the same node as the application instance, but also enables access to data stored in remote nodes (JVMs) that comprise the embedded distributed cluster.
+
+* _Client-server mode_ - In this mode, the Cache is stored in  a managed, distributed and clusterable data grid server.  Applications can remotely access the data grid server using Hot Rod, memcached or REST client APIs. This web application bundles only the HotRod client and communicates with a remote JBoss Data Grid (JDG) server. The JDG server is configured via the `standalone.xml` configuration file.
+
+
+System requirements
+-------------------
+
+All you need to build this project is Java 6.0 (Java SDK 1.6) or better, Maven 3.0 or better.
+
+The application this project produces is designed to be run on Red Hat JBoss Enterprise Application Platform (EAP) 6.1 or later.
+
+
+Configure Maven
+---------------
+
+If you have not yet done so, you must [Configure Maven](../../README.md#configure-maven) before testing the quickstarts.
+
+
+Start EAP
+---------
+
+1. Open a command line and navigate to the root of the EAP server directory.
+2. The following shows the command line to start the server with the web profile:
+
+        For Linux:   $JBOSS_HOME/bin/standalone.sh
+        For Windows: %JBOSS_HOME%\bin\standalone.bat
+
+
+Build and Deploy the Application in Library Mode
+------------------------------------------------
+
+_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 [Build and Deploy the Quickstarts](../README.md#build-and-deploy-the-quickstarts) for complete instructions and additional options._
+
+1. Make sure you have started EAP as described above.
+2. Open a command line and navigate to the root directory of this quickstart.
+3. Type this command to build and deploy the archive:
+
+        mvn clean package jboss-as:deploy
+        
+4. This will deploy `target/jboss-carmart.war` to the running instance of the server.
+
+
+Access the application
+---------------------
+
+The application will be running at the following URL: <http://localhost:8080/jboss-carmart/>
+
+
+Undeploy the Archive
+--------------------
+
+1. Make sure you have started EAP as described above.
+2. Open a command line and navigate to the root directory of this quickstart.
+3. When you are finished testing, type this command to undeploy the archive:
+
+        mvn jboss-as:undeploy
+
+
+Debug the Application
+---------------------
+
+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
+
+Test the Application in Library mode
+------------------------------------
+
+If you want to test the application, there are simple Arquillian Selenium tests prepared.
+To run these tests on EAP:
+
+1. Stop EAP (if you have one running)
+2. Open a command line and navigate to the root directory of this quickstart.
+3. Build the quickstart using:
+
+        mvn clean package
+
+4. Type this command to run the tests:
+
+        mvn test -Puitests-jbossas -Das7home=/path/to/server
+
+
+Build and Start the Application in Client-Server Mode (using HotRod Client)
+---------------------------------------------------------------------------
+
+NOTE: The application must be deployed to JBoss Enterprise Application Platform (EAP). It can not be deployed to JDG since it does not support deployment of applications.
+
+1. Obtain the JDG server distribution. See the following for more information: <http://www.redhat.com/products/jbossenterprisemiddleware/data-grid/>
+
+2. Configure the remote datagrid in the `$JDG_HOME/standalone/configuration/standalone.xml` file. Copy the following XML into the Infinispan subsystem before the ending </cache-container> tag. If you have an existing `carcache` element, be sure to replace it with this one.
+
+            <local-cache name="carcache" start="EAGER" batching="false"/>
+
+3. Start the JDG server on localhost using port offset: 
+
+        $JDG_HOME/bin/standalone.sh -Djboss.socket.binding.port-offset=100
+
+4. Start EAP into which you want to deploy your application
+
+        $JBOSS_HOME/bin/standalone.sh
+
+5. The application finds the JDG server using the values in the src/main/resources/META-INF/datagrid.properties file. If you are not running the JDG server on the default host and port, you must modify this file to contain the correct values. If you need to change the JDG address:port information, edit src/main/resources/META-INF/datagrid.properties file and specify address and port of the JDG server
+
+        datagrid.host=localhost
+        datagrid.hotrod.port=11322
+
+6. Build the application in the example's directory:
+
+        mvn clean package -Premote-jbossas
+
+7. Deploy the application
+
+        mvn jboss-as:deploy -Premote-jbossas
+
+8. The application will be running at the following URL: <http://localhost:8080/jboss-carmart/>
+
+9. Undeploy the application
+
+        mvn jboss-as:undeploy -Premote-jbossas
+
+
+Test the Application in Client-Server mode (using HotRod client)
+----------------------------------------------------------------
+
+1. Obtain and configure JDG Server (steps 1 and 2 show above)
+2. Make sure that none of EAP or JDG Server is running
+3. Open a command line and navigate to the root directory of this quickstart.
+4. Build the quickstart using:
+
+        mvn clean package -Premote-jbossas
+
+5. Type this command to run the tests:
+
+        mvn test -Puitests-remote -Das7home=/path/to/as/server -DjdgServer=/path/to/jdg/server
+
+