caGrid Installation

caGrid (release 1.2) is the current release of the caBIG infrastructure package. These notes document the install experience on various platforms to support our exploration of the compatibility of caGrid security model with UABgrid, and build a general understanding of the software components of the caGrid platform as part of the UABgrid caBIG exploration effort

Reference: CAGRID 1.2 Installer Guide, National Cancer Institute, Center for Bioinformatics, March 28, 2008

To install caGrid 1.2 using the installer, Java 1.5 JDK is a prerequisite, and a MySql database is also a prerequisite if you want to deploy caGrid services locally. Other prerequisites are Ant 1.6.5, Globus WS-Core with WS-Enum Support, and Tomcat at least version 5.0.28 (if you want to deploy services to Tomcat). The Ant, Globus, and Tomcat prerequisites are installed for you by the installer.

You must set JAVA_HOME to the Java 1.5 Java Development Kit (JDK), not the Java Runtime Environment (JRE), before beginning the installation. Other environment variables must be set later, but may be set after Ant, Globus, and Tomcat are installed:

• ANT_HOME: Ant installation directory. The caGrid development environment requires this variable, but running caGrid services do not.
• GLOBUS_LOCATION: caGrid Globus 4.0.3 distribution installation directory. This is required by the caGrid development environment and caGrid services that are running in the Globus container.
• CATALINA_HOME: Tomcat installation directory. This is required by the caGrid development environment and is necessary to run the Tomcat container.

Download the installer and unzip to a directory of your choosing. The contents of the directory will be:

• caGrid-installer-1.2.jar
• caGrid-installer-1.2.zip
• lib/
  • caGrid-1.2-wizard.jar
  • commons-logging.jar
  • jce-jdk13-125.jar
  • log4j-1.2.14.jar
  • mysql-connectory-java-3.0.16-ga-bin.jar
  • tools.jar
  • xmltask-v1.14.jar
• scripts/
  • build.xml
  • resources/
    • spring-beans.dtd
    • web-app_2_3.dtd
    • web-facesconfig_1_1.dtd

Change to the directory where you unzipped the file, and start the installer with this command:

java -jar caGrid-installer-1.2.jar

The first time I tried that, I had Java 1.5 and 1.6 installed on my machine, but I got an error early on in the installation because my JAVA_HOME environment variable did not point to the 1.5 installation. On my openSUSE 10.3 desktop, JAVA_HOME for caGrid purposes is /usr/lib/jvm/java-1.5.0

Running the installer

When the installer successfully starts, first you are asked to agree to the caGrid license. If you agree, put a check in I agree and click Next. Then the installer asks which of the following it should do:

• Install caGrid
• Configure Container
• Install caGrid Services
• Install caGrid Portal

1. For this installation I first only selected Install caGrid. The installation went smoothly. I did have to set ANT_HOME and GLOBUS_LOCATION at the end of it - I set them to the locations of Ant and Globus that were installed by the installer. The installer reminds the user to do that before it exits.

2. The next selection in the installer is Configure Container. Just run the installer again, once again accepting the license. Under Select Installation Type, clear the box beside Install caGrid and instead select Configure Container. Select Tomcat or Globus container. There will also be opportunities to select where Ant and Tomcat will be installed. If these are already installed I simply selected the same directory again. The installer detects that Globus has already been installed and asks if it should install it again. Leave the box unchecked beside Yes unless you want Globus reinstalled. Likewise the installer will ask about reinstalling caGrid and configuring it for a target grid. Just leave Yes unchecked and click Next, unless you want to make changes. Click Start to begin and the installer will begin by downloading Ant and Tomcat and installing them. You will be asked if the container should be secure. For my example I selected secure, Tomcat container.

Secure container -

A. If you choose to install a secure container, the installer will then ask for the host name of the machine. The host name must be a DNS name that resolves to the same IP address as the IP address(es) to which the container is listening on the specified port.).

B. If you have chosen the Tomcat container, the next screen will prompt you for the Shutdown Port and HTTPS port.

C. If you have chosen the Globus container, you will not be prompted for port information.

D. Next the installer will ask if the service certificate and key (i.e. the host credentials) are present.

• If you have these, select the Yes check box, and click Next. On the next screen, you'll be prompted for the location of these credentials.
• If you don't have host credentials, do not select the Yes check box. Then click Next.
  

E. The installer asks if you have a CA certificate and key. These are what the installer will need in order to generate host credentials for you.

• If you have these, select the Yes check box. Then click Next. On the following screen, you'll be prompted for the locations of the CA certificate and key as well as the password for the key. Once you've entered these, click Next. You'll then be prompted for the location to write the host certificates.
• If you don't have a CA certificate and key, do not select the Yes check box on the screen that asks if they are present. Then click Next.
  

F. You'll then be prompted for locations to write the certificate and key as well as the CA password, the distinguished name (DN) to be used, and the number of days that the CA certificate will be valid. Once you've entered that information, click Next. The following screen will prompt you for the location to write the host certificates.

Non-secure Container -

If you have not chosen to configure a secure container, the installer will just ask you for the host name and, if using Tomcat, the shutdown and HTTP ports.

Once all the options are selected, click Start to begin. At the end of the installation, you will once again be reminded to set the environment variables.

3. Install caGrid Services - Begin the installer again and accept the license. Select Install caGrid Services and clear the other choices. From the list presented, select the service(s) to be installed. This time, I only selected Dorian then clicked Next. Select the container type you set up in 2. above. Once again you will be asked about where to install Ant and Tomcat and whether to reinstall Globus and caGrid. Make choices accordingly then proceed to the page where you click Start to begin. The same questions about host name and Tomcat ports will be asked. Answer them as in 2. and click Next. A form where Dorian Service Metadata can be edited is presented. Make desired changes and click Next. Likewise, a form to edit standard properties for the Dorian service will be presented. Make changes needed then click Next. The next item is the database information. Enter a name for the desired database and also enter the username and password for your mySQL instance - a username that will have access to create and modify the new database. I used my root mySQL user. If you enter a database name that is already present in your mySQL server, you will get a message asking if it should be deleted. If it should not, click Previous and use a different name. The next few pages will be forms to configure the idp and ifs and to ask about the type of CA. Then you will be asked if there are Dorian credentials present. As in 2. if there are already credentials, click Yes but otherwise leave the box clear. You will either be asked the path to your certificates or to configure the new CA, based on that answer. If credentials were not present, they will be generated. The installation will finish as always by reminding you to set environment variables.
A. Once again I ran the installer selecting Install caGrid Services. This time I selected CDS, GTS, and GridGrouper to install. The installation is the same as for Dorian, including forms for modifying the metadata for CDS, GTS, and GridGrouper and providing information to configure the databases. The latter included once again providing the password for MySQL.

B. Once all settings are configured appropriately,click Start to begin installation and configuration.
Changing the target grid: Once caGrid is built, it is already configured to target a default grid. You can find details about what grid you are currently targeting at anytime by typing the following command from the caGrid directory:

ant configureHelp

(If you get an ant: Command Not Found error, add $ANT_HOME/bin to your $PATH and also make $ANT_HOME/bin/ant executable).

To use a different target grid, set property 'target.grid'to the grid's name, and run the 'configure' target. For example, type:

ant -Dtarget.grid=nci_prod-1.2 configure

or to use the training grid, the following command should be run from the caGrid directory:

ant -Dtarget.grid=training-1.2 configure

Now the Gaards UI can be launched by going to the directory where caGrid is installed and typing:

ant gaardsui