17 Deploying Community-Gadgets

This chapter describes the steps for deploying Community-Gadgets on supported application servers.

This chapter contains the following sections:

17.1 Overview

When deploying Community-Gadgets, you will do the following:

  • On the management system, you will deploy the management Community-Gadgets web application and the management Shindig web application (for gadgets rendering).

  • On the production system, you will deploy the production Community-Gadgets web application, the production Shindig web application (for gadgets rendering), and the Visitors CAS web application (for authentication).

Instructions are available in this chapter.

Note:

Before proceeding with this chapter, ensure you have completed requirements procedures in the previous chapters of Part IV, "Installing Oracle WebCenter Sites: Community-Gadgets."

17.2 Deploying a Non-Clustered Community-Gadgets Application

This section describes the steps for deploying a non-clustered Community-Gadgets application to supported application servers.

This section covers the following deployment configurations:

17.2.1 Deploying on Apache Tomcat

In this section, you will deploy a non-clustered Community-Gadgets application on Tomcat.

Note:

If you need detailed steps on how to deploy an application on Apache Tomcat, refer to the vendor's documentation.
  1. Before deploying the Community-Gadgets application, ensure that each application server's classpath points to the respective Community-Gadgets configuration directories (created in Section 16.2, "Copying Installer-Generated Configuration Files").

    For reference, this guide uses the configurations described in Table 17-1.

    Table 17-1 Classpath Configuration for Tomcat Servers (Non-clustered)

    Tomcat Server Server Classpath

    <cgA_M1>

    CLASSPATH="/<cg_install_dir>/<cg-standalone-configs>/<cgA_M1>:${CLASSPATH}"

    <cgB_P1>

    CLASSPATH="/<cg_install_dir>/<cg-standalone-configs>/<cgB_P1>:${CLASSPATH}"


  2. The Community-Gadgets installer creates war and ear files in the <cg_install_dir>/deploy/management directory and the <cg_install_dir>/deploy/production directory. Deploy the Community-Gadgets application either through the Tomcat administration console, or by copying the exploded war files to the webapps directory. Locations of the war files are shown in Table 17-2.

    Note:

    In the catalina.sh (or catalina.bat) file, ensure that the line "CLASSPATH=" is commented out.
    • On UNIX: #CLASSPATH=

    • On Windows: REM CLASSPATH=

    Table 17-2 war File Locations for Tomcat (Non-clustered)

    Application Server Instances Location of WAR Files Sample Deployment Locations

    <cgA_M1>

    <cg_install_dir>/deploy/management/cg.war

    <cg_install_dir>/deploy/management/shindig.war

    <cgA_M1>/webapps/cg

    <cgA_M1>/webapps/shindig

    <cgB_P1>

    <cg_install_dir>/deploy/production/cg.war

    <cg_install_dir>/deploy/production/shindig.war

    <cg_install_dir>/deploy/production/cas.war

    <cgB_P1>/webapps/cg

    <cgB_P1>/webapps/shindig

    <cgB_P1>/webapps/cas


    Note:

    If the CG context root is changed at the time of installation, then in the tomcat webapps the CG deploy folder name should be the same as the CG Context root.
  3. Before starting the managed servers, ensure that you have WebCenter Sites running and configured as described in Chapter 13, "Prerequisites for Installing Community-Gadgets."

  4. Start the production and management deployment servers.

    For example, in Linux:

    On <ServerB>:

    cd <cgB_P1>/bin
    ./catalina.sh run
    

    On <ServerA>:

    cd <cgA_M1>/bin
    ./catalina.sh run
    
  5. Continue to Chapter 18, "Verifying and Implementing Community-Gadgets."

17.2.2 Deploying on Oracle WebLogic Application Server

In this section, you will deploy a non-clustered Community-Gadgets application on Oracle WebLogic Application Server.

Note:

Consider the following:
  • If you need detailed steps on deploying web applications on Oracle WebLogic Application Server, refer to the Oracle WebLogic Application Server documentation.

  • If the Community-Gadgets application will be deployed on WebLogic application server, add the following JVM parameter to JAVA_OPTIONS of WebLogic application server: -DUseSunHttpHandler=true

  1. Before deploying the Community-Gadgets application, ensure that each application server's classpath points to the respective Community-Gadgets configuration directories (created in Section 16.2, "Copying Installer-Generated Configuration Files.")

    For reference, this guide uses the configurations described in Table 17-3.

    Table 17-3 Classpath Configuration for Managed Servers (WebLogic, Non-clustered)

    Managed Servers Server Classpath

    <cgA_M1>

    CLASSPATH="/<cg_install_dir>/<cg-standalone-configs>/<cgA_M1>:${CLASSPATH}"

    <cgB_P1>

    CLASSPATH="/<cg_install_dir>/<cg-standalone-configs>/<cgB_P1>:${CLASSPATH}"


  2. The Community-Gadgets installer creates war and ear files in the <cg_install_dir>/deploy/management and <cg_install_dir>/deploy/production directories. Extract the contents of the war files and deploy them via the command line or the Administration Console. Locations of the war files are shown in Table 17-4.

    Table 17-4 war File Locations for WebLogic (Non-clustered)

    Managed Server Location of war Files Sample Deployment Location

    <cgA_M1>

    <cg_install_dir>/deploy/management/cg.war

    <cg_install_dir>/deploy/management/shindig.war

    <WL_HOME>/user_projects/domains/<cgMgmt>/applications/cg

    <WL_HOME>/user_projects/domains/<cgMgmt>/applications/shindig

    <cgB_P1>

    <cg_install_dir>/deploy/production/cg.war

    <cg_install_dir>/deploy/management/shindig.war

    <cg_install_dir>/deploy/production/cas.war

    <WL_HOME>/user_projects/domains/<cgProd>/applications/cg

    <WL_HOME>/user_projects/domains/<cgProd>/applications/shindig

    <WL_HOME>/user_projects/domains/<cgProd>/applications/cas


  3. Before starting the managed servers, ensure that you have WebCenter Sites running and configured as described in Chapter 13, "Prerequisites for Installing Community-Gadgets."

  4. Copy the following files from the Community-Gadgets application to its application server's JRE: jaxb-api-2.2.2.jar and jaxb-impl-2.2.3-1.jar. To get these files, unzip cos.war. These JARs are located in the WEB-INF/lib directory.

    The files must be placed into the <WebLogic_JDK>/jre/lib/endorsed folder (if the endorsed folder does not exist, create it).

  5. Start the production and management deployment servers.

    For example, in Linux:

    cd <WL_HOME>/user_projects/domains/<cgProd>/bin
    ./startManagedServer <cgB_P1> http://<ServerB>:7001
    
    cd <WL_HOME>/user_projects/domains/<cgMgmt>/bin
    ./startManagedServer <cgA_M1> http://<ServerA>:7001
    
  6. Continue to Chapter 18, "Verifying and Implementing Community-Gadgets."

17.2.3 Deploying on IBM WebSphere Application Server

In this section, you will deploy a non-clustered Community-Gadgets application on IBM WebSphere Application Server.

Note:

If you need detailed steps on deploying web applications on IBM WebSphere Application Server, refer to the vendor's documentation.
  1. Before deploying the Community-Gadgets application, ensure that each application server's classpath points to the respective Community-Gadgets configuration directories (created in Section 16.2, "Copying Installer-Generated Configuration Files."). To do so:

    1. Log in to the deployment manager (for example, access http://<ServerA>:9060/ibm/console).

    2. For each server, select Java and Process Management, then select Process Definition, then select Java Virtual Machine and edit the CLASSPATH field.

    For reference, this guide uses the configurations described in Table 17-5.

    Table 17-5 Classpath Configuration for WebSphere (Non-clustered)

    Managed Server Server Classpath

    <cgA_M1>

    /<cg_install_dir>/<cg-standalone-configs>/<cgA_M1>

    <cgB_P1>

    /<cg_install_dir>/<cg-standalone-configs>/<cgB_P1>


  2. The Community-Gadgets installer creates war and ear files in the <cg_install_dir>/deploy/management directory and the <cg_install_dir>/deploy/production directory. Locations of the ear files are shown in Table 17-6.

    Table 17-6 EAR File Locations for WebSphere (Non-clustered)

    Managed Server Location of EAR Files

    <cgA_M1>

    <cg_install_dir>/deploy/management/CommunityGadgets.ear

    <cg_install_dir>/deploy/management/Shindig.ear

    <cgB_P1>

    <cg_install_dir>/deploy/production/CommunityGadgets.ear

    <cg_install_dir>/deploy/production/Shindig.ear

    <cg_install_dir>/deploy/production/cas.ear


  3. Complete the following steps in the WebSphere Admin Console for Community-Gadgets applications, Shindig applications, and the Visitors CAS application:

    1. Select Applications, then select Application Types, then select WebSphere enterprise applications, then select application_name.

    2. Under Web Module Properties, select Session management.

    3. Under General Properties, select Enable Cookies and change the value for Cookie path from / to /<application-context-root> (the default value for the Community-Gadgets application is /cg, for Shindig it is /shindig, and for the Visitors CAS application it is/cas).

    4. Click Apply and Save.

    5. Under General Properties, select Override session management.

    6. Click Apply and Save.

  4. Copy the following files from the Community-Gadgets application to its application server's JRE: axb-api-2.2.2.jar, jaxb-impl-2.2.3-1.jar and asm-3.1.jar. The files must be placed into the <WebSphere_JDK>/jre/lib/endorsed folder (if the endorsed folder does not exist, create it).

  5. Before starting the managed servers, ensure that you have WebCenter Sites running and configured as described in Chapter 13, "Prerequisites for Installing Community-Gadgets."

  6. Start the Deployment Manager profile and nodes.

    For example, in Linux:

    On <ServerA>:

    <WS_HOME>/bin
    ./startManager.sh -profileName <Dmgr01>
    ./startNode.sh -profileName <AppSrv01>
    

    On <ServerB>:

    ./startNode.sh -profileName <AppSrv02>
    
  7. Start the production and management servers.

    For example, in Linux:

    On <ServerB>:

    ./startServer.sh cgB_P1 -profileName <AppSrv02>
    

    On <ServerA>:

    ./startServer.sh cgA_M1 -profileName <AppSrv01>
    
  8. Continue to Chapter 18, "Verifying and Implementing Community-Gadgets."

17.3 Deploying a Clustered Community-Gadgets Application

This section describes the steps for deploying a clustered Community-Gadgets application to supported application servers.

This section covers the following deployment configurations:

17.3.1 Deploying on Apache Tomcat (Clustered)

In this section, you will deploy a clustered Community-Gadgets application on Tomcat.

Note:

If you need detailed steps on how to deploy an application on Apache Tomcat, refer to the vendor's documentation.
  1. Before deploying the Community-Gadgets application, ensure that each application server's classpath points to the respective Community-Gadgets configuration directories (created in Section 16.2, "Copying Installer-Generated Configuration Files").

    For reference, this guide uses the configurations described in Table 17-7.

    Table 17-7 Classpath Configuration for Tomcat Servers (Clustered)

    Managed Server Server Classpath

    <cgA_M1>

    CLASSPATH="/<cg_install_dir>/<cg-standalone-configs>/<cgA_M1>:${CLASSPATH}"

    <cgB_P1>

    CLASSPATH="/<cg_install_dir>/<cg-standalone-configs>/<cgB_P1>:${CLASSPATH}"

    <cgA_M2>

    CLASSPATH="/<cg_install_dir>/<cg-standalone-configs>/<cgA_M2>:${CLASSPATH}"

    <cgB_P2>

    CLASSPATH="/<cg_install_dir>/<cg-standalone-configs>/<cgB_P2>:${CLASSPATH}"


  2. The Community-Gadgets installer creates war and ear files in the <cg_install_dir>/deploy/management and <cg_install_dir>/deploy/production directories. Deploy the Community-Gadgets application either through the Tomcat administration console, or by copying the exploded war files to the webapps directory. Locations of the war files are shown in Table 17-8.

    Table 17-8 WAR File Locations for Tomcat (Clustered)

    Application Server Instances Location of WAR Files Sample Deployment Location

    <cgA_M1>

    <cg_install_dir>/deploy/management/cg.war

    <cg_install_dir>/deploy/management/shindig.war

    <cgA_M1>/webapps/cg

    <cgA_M1>/webapps/shindig

    <cgB_P1>

    <cg_install_dir>/deploy/production/cg.war

    <cg_install_dir>/deploy/production/shindig.war

    <cg_install_dir>/deploy/production/cas.war

    <cgB_P1>/webapps/cg

    <cgB_P1>/webapps/shindig

    <cgB_P1>/webapps/cas

    <cgA_M2>

    <cg_install_dir>/deploy/management/cg.war

    <cg_install_dir>/deploy/management/shindig.war

    <cgA_M2>/webapps/cg

    <cgA_M2>/webapps/shindig

    <cgB_P2>

    <cg_install_dir>/deploy/production/cg.war

    <cg_install_dir>/deploy/production/shindig.war

    <cg_install_dir>/deploy/production/cas.war

    <cgB_P2>/webapps/cg

    <cgB_P2>/webapps/shindig

    <cgB_P2>/webapps/cas


  3. Before starting the managed servers, ensure that you have WebCenter Sites running and configured as described in Chapter 13, "Prerequisites for Installing Community-Gadgets."

  4. Start the production and management deployment servers.

    For example, in Linux:

    On <ServerB>:

    cd <cgB_P1>/bin
    ./catalina.sh run
    cd <cgB_P2>/bin
    ./catalina.sh run
    

    On <ServerA>:

    cd <cgA_M1>/bin
    ./catalina.sh run
    cd <cgA_M2>/bin
    ./catalina.sh run
    
  5. Continue to Chapter 18, "Verifying and Implementing Community-Gadgets."

17.3.2 Deploying on Oracle WebLogic Application Server (Clustered)

In this section, you will deploy a clustered Community-Gadgets application on Oracle WebLogic Application Server.

Note:

Consider the following:
  • If you need detailed steps on deploying web applications on Oracle WebLogic Application Server, refer to the Oracle WebLogic Application Server documentation.

  • Before deploying the Community-Gadgets application on WebLogic application server, add the following JVM parameter to JAVA_OPTIONS of WebLogic application server: -DUseSunHttpHandler=true

  1. Before deploying the Community-Gadgets application, ensure that each application server's classpath points to the respective Community-Gadgets configuration directories (created in Section 16.2, "Copying Installer-Generated Configuration Files.").

    For reference, this guide uses the configurations described in Table 17-9.

    Table 17-9 Classpath Configuration for Managed Servers (Clustered WebLogic)

    Managed Server Server Classpath

    <cgA_M1>

    CLASSPATH="/<cg_install_dir>/<cg-standalone-configs>/<cgA_M1>:${CLASSPATH}"

    <cgB_P1>

    CLASSPATH="/<cg_install_dir>/<cg-standalone-configs>/<cgB_P1>:${CLASSPATH}"

    <cgA_M2>

    CLASSPATH="/<cg_install_dir>/<cg-standalone-configs>/<cgA_M2>:${CLASSPATH}"

    <cgB_P2>

    CLASSPATH="/<cg_install_dir>/<cg-standalone-configs>/<cgB_P2>:${CLASSPATH}"


  2. The Community-Gadgets installer creates war and ear files in the <cg_install_dir>/deploy/management and <cg_install_dir>/deploy/production directories. Extract the contents of the war files and deploy them via the command line or the Administration Console. Locations of the war files are shown in Table 17-10.

    Table 17-10 WAR File Locations for WebLogic (Clustered)

    Target Servers: All Cluster Members Location of WAR Files Sample Deployment Location

    <cgA_M1>

    <cgA_M2>

    <cg_install_dir>/deploy/management/cg.war

    <cg_install_dir>/deploy/management/shindig.war

    <WL_HOME>/user_projects/domains/<cgMgmt>/applications/cg

    <WL_HOME>/user_projects/domains/<cgMgmt>/applications/shindig

    <cgB_P1>

    <cgB_P2>

    <cg_install_dir>/deploy/production/cg.war

    <cg_install_dir>/deploy/production/shindig.war

    <cg_install_dir>/deploy/production/cas.war

    <WL_HOME>/user_projects/domains/<cgProd>/applications/cg

    <WL_HOME>/user_projects/domains/<cgProd>/applications/shindig

    <WL_HOME>/user_projects/domains/<cgProd>/applications/cas


  3. Before starting the managed servers, ensure that you have WebCenter Sites running and configured as described in Chapter 13, "Prerequisites for Installing Community-Gadgets."

  4. Copy the following files from the Community-Gadgets application to its application server's JRE: jaxb-api-2.2.2.jar file and jaxb-impl-2.2.3-1.jar. The files must be placed into the <WebLogic_JDK>/jre/lib/endorsed folder (if the endorsed folder does not exist, create it).

  5. Start the production and management deployment servers.

    For example, in Linux:

    On <ServerB>:

    cd <WL_HOME>/user_projects/domains/<cgProd>/bin
    ./startManagedServer <cgB_P1> http://<ServerB>:7001
    cd <WL_HOME>/user_projects/domains/<cgProd>/bin
    ./startManagedServer <cgB_P2> http://<ServerB>:7001
    

    On <ServerA>:

    cd <WL_HOME>/user_projects/domains/<cgMgmt>/bin
    ./startManagedServer <cgA_M1> http://<ServerA>:7001
    cd <WL_HOME>/user_projects/domains/<cgMgmt>/bin
    ./startManagedServer <cgA_M2> http://<ServerA>:7001
    
  6. Continue to Chapter 18, "Verifying and Implementing Community-Gadgets."

17.3.3 Deploying on IBM WebSphere Application Server (Clustered)

In this section, you will deploy a clustered Community-Gadgets application on IBM WebSphere Application Server.

Note:

If you need detailed steps on deploying web applications on IBM WebSphere Application Server, refer to the vendor's documentation.
  1. Before deploying the Community-Gadgets application, ensure that each application server's classpath points to the respective Community-Gadgets configuration directories (created in Section 16.2, "Copying Installer-Generated Configuration Files."). To do so:

    1. Log in to the deployment manager (for example, access http://<ServerA>:9060/ibm/console).

    2. For each server, select Java and Process Management, then select Process Definition, then select Java Virtual Machine and edit the CLASSPATH field.

      For reference, this guide uses the configurations described in Table 17-11.

      Table 17-11 Classpath Configuration for WebSphere (Clustered)

      Managed Server Server Classpath

      <cgA_M1>

      /<cg_install_dir>/<cg-standalone-configs>/<cgA_M1>

      <cgB_P1>

      /<cg_install_dir>/<cg-standalone-configs>/<cgB_P1>

      <cgA_M2>

      /<cg_install_dir>/<cg-standalone-configs>/<cgA_M2>

      <cgB_P2>

      /<cg_install_dir>/<cg-standalone-configs>/<cgB_P2>


  2. The Community-Gadgets installer creates war and ear files in the <cg_install_dir>/deploy/management and <cg_install_dir>/deploy/production directories. Locations of the ear files are shown in Table 17-12.

    Table 17-12 EAR File Locations for WebSphere (Clustered)

    Target Server Location of EAR Files

    <wscg_M> cluster:

    <cgA_M1>,<cgA_M2>

    <cg_install_dir>/deploy/management/CommunityGadgets.ear

    <cg_install_dir>/deploy/management/Shindig.ear

    <wscg_P> cluster:

    <cgB_P1>,<cgB_P2>

    <cg_install_dir>/deploy/production/CommunityGadgets.ear

    <cg_install_dir>/deploy/production/Shindig.ear

    <cg_install_dir>/deploy/production/cas.ear


  3. Complete the following steps in the WebSphere Admin Console for each Community-Gadgets application, Shindig application, and Visitors CAS application:

    1. Select Applications, then select Application Types, then select WebSphere enterprise applications, then select application_name.

    2. Under Web Module Properties, select Session management.

    3. Under General Properties, select Enable Cookies and change the value for Cookie path from / to /<application-context-root> (the default value for the Community-Gadgets application is /cg, for Shindig is /shindig, and for the Visitors CAS application it is/cas).

    4. Click Apply and Save.

    5. Under General Properties, select Override session management.

    6. Click Apply and Save.

  4. Copy the following files from Community-Gadgets to its application server's JRE: axb-api-2.2.2.jar, jaxb-impl-2.2.3-1.jar and asm-3.1.jar. The files must be placed into the <WebSphere_JDK>/jre/lib/endorsed folder (if the endorsed folder does not exist, create it).

  5. Before starting the managed servers, ensure that you have WebCenter Sites running and configured as described in Chapter 13, "Prerequisites for Installing Community-Gadgets."

  6. Start the Deployment Manager profile and nodes.

    For example, in Linux:

    On <ServerA>:

    <WS_HOME>/bin
    ./startManager.sh -profileName <Dmgr01>
    ./startNode.sh -profileName <AppSrv01>
    

    On <ServerB>:

    ./startNode.sh -profileName <AppSrv02>
    
  7. Start the production and management servers.

    For example, in Linux:

    On <ServerB>:

    ./startServer.sh cgB_P1 -profileName <AppSrv02>
    ./startServer.sh cgB_P2 -profileName <AppSrv02>
    

    On <ServerA>:

    ./startServer.sh cgA_M1 -profileName <AppSrv01>
    ./startServer.sh cgA_M2 -profileName <AppSrv01>
    
  8. Continue to Chapter 18, "Verifying and Implementing Community-Gadgets."