Portal installation
From Ogce
Contents |
Prerequisites
The OGCE2 2.0 download includes everything that you need to install the portal on UNIX/Linux/Mac OS X operating systems except Java. Some maven jars used in the main portal are compiled with Java 1.5 so this version must be used.
OGCE portlets are designed to work with installed instances of Grid software (Globus's GRAM and GridFTP, MyProxy, Condor, SRB, etc) that are not included in the download. You must install these separately or use an existing installation such as the NSF TeraGrid.
OGCE 2.2 and 2.3 Series Installation
The OGCE installation process has been significantly revised to provide a more easily extensible and modular build. Installation notes are in the README.INSTALL file in the ogce-portal-only directory. To build the portal, do the following:
- Set your JAVA_HOME environment variable. This should point to JDK 1.5 or 1.6.
- Download and unpack the tar.gz, typically in your $HOME directory.
- Add Maven 2's mvn to your path, i.e. export PATH=$HOME/ogce-portal-only/maven-2.0.7/bin:$PATH
- Edit the <properties> at the top of pom.xml. You should minimally edit <portal.server.ip/> and <host.base.url/>. If you are not installing under your $HOME directory, you need also to edit <project.home/>.
- Run the command
[shell> mvn clean install
from the ogce-portal-only directory.
- To start the portal, use the simple "startup-tomcat.sh" script in the project's top level
directory. To shut down, use "shutdown-tomcat.sh". You can also do this with Tomcat's scripts. These are located in ogce-portal-only/portal_deploy/apache-tomcat-5.5.x/bin/.
- To install optional portlets, or to rebuild a particular portlet after editing, use the command
[shell> mvn clean install -f portlets/someportlet/pom.xml
in the ogce-portal-only directory, replacing "someportlet" of course.
- To clean the portal installation completely, use either "mvn clean".
- Finally, point your browser to http://localhost:8080/gridsphere and create an administration account.
Tips
Cog.properties Settings
The OGCE portlets use the Java CoG 4 to access Grid resources. Your CoGKit property settings are (by default) located in $HOME/.globus/cog.properties. This will be created during the installation phase automatically, but it is also a good idea to verify these if you experience problems. Example settings of properties needed by the OGCE portlets are shown below.
cacert=/home/myacct/.globus/certificates/ ip=123.456.789
The certificates directory includes all of your CA signing policies. The OGCE installation includes several CAs, including a fresh download of all TeraGrid certificates from http://security.teragrid.org/docs/teragrid-certs.tar.gz
Environment Variables
Be careful setting system-wide environment variables. The CLASSPATH and CATALINA_HOME variables can cause unusual problems (overriding OGCE class versions for example). We recommend that you do not use these.
Starting and Monitoring the Tomcat Server
- Optionally use the convenient "shutdown-tomcat.sh" and "startup-tomcat.sh" scripts
- Use the command (in the ogce-portal-only)
[shell>tail -f portal_deploy/apache-tomcat-5.5.12/logs/catalina.out
to monitor the server.
Notes on Older Releases
OGCE 2.0 Requirements
The OGCE2 2.0 and 2.1 releases are designed to run on 2-3 separate Tomcat servers.
1. The Portal Server runs in an Apache Tomcat server on port 8080 by default. This server runs the portal and portlets 2. The GridPort Server runs GridPort's GPIR and CFT services. This server is configured to use port 7070. Versions prior to 2.0.1 use port 9090. 3. The Sakai Server runs Sakai services on port 10010. It is also configured to run Tomcat with necessary JVM memory settings. Because of Sakai's high memory requirements, we recommend you run Sakai on a separate host computer.
Running the portal and Web services on separate Tomcat servers simplifies Jar conflicts and allows you to distribute the OGCE across many different servers. Hey, it's a Grid and machines are cheap.
Installing OGCE2 Release 2.0
To install the portal, first unpack it:
[shell-prompt>tar -zxvf ogce2-2.0.tar.gz
The -z option is a feature of the GNU tar, which we recommend using.
Next, edit the grid.installation.properties and project.properties files to match your local settings.
[shell-prompt>cd ogce2-2.0 [shell-prompt>vi grid.installation.properties
The grid.installation.properties file includes the names of the MyProxy server, Glogus GRAM, and GridFTP servers you want to use. The project.properties file includes build properties. The portal.server.ip is the most important of these and should be set to your portal server's IP address (see below).
Make sure $JAVA_HOME is set.
[shell-prompt> echo $JAVA_HOME [shell-promt> export JAVA_HOME=/path/to/java (if unset)
Finally, run the install script. This may take a few minutes in your first installation, since Maven must download numerous jars.
[shell-prompt> ./install.sh
Note on cog.properties Settings
The OGCE portlets use the Java CoG 4 to access Grid resources. Your CoGKit property settings are (by default) located in $HOME/.globus/cog.properties. To avoid conflicts between OGCE portal and other CoG application property requirements, it is possible to use a non-default cog.properties location.
Example settings of properties needed by the OGCE portlets are shown below.
cacert=/home/myacct/.globus/certificates/ ip=123.456.789
The certificates directory includes all of your CA signing policies.
You have two choices for setting these properties properties:
1. You may create and edit the $HOME/.globus/cog.properties file by hand. This is recommended if you already have a cog.properties file with specific settings from other projects. 2. You may use the OGCE build to provide a minimum cog.properties file. This file may optionally be located in $CATALINA_HOME/OGCE/.globus/cog.properties. This will allow you to use multiple cog.properties files without conflict.
To use an alternative cog.properties file location, you will need to pass the property setting org.globus.config.file=$CATALINA_HOME/OGCE/cog.properties to Tomcat's JVM. This is normally done through the $JAVA_OPTS environment variable:
[shell_prompt> export CATALINA_HOME=$HOME/apache-tomcat-5.5.12/ [shell_prompt> export JAVA_OPTS="-Dorg.globus.config.file=$CATALINA_HOME/OGCE/.globus/cog.properties"
Starting and Stopping Web Servers
Use the convenience scripts portal-tomcat-startup.sh, gp-tomcat-startup.sh, and sakai-tomcat-startup.sh to run the various servers. You can shut everything down with tomcat-shutdown.sh. As described above, we recommend running the Sakai server on a separate host computer.
OGCE2 Release 1.0
OGCE 2's 1.0 portlet series is compatible with the OGCE 2.0 portlets but focused on a uPortal container deployment. For installation instructions, click here.
OGCE1 Release 1.0
The OGCE1 series is based on Chef 1.0/Jetspeed 1.4, which predates the JSR 168 portlet standard. These portlets do not interoperate with later OGCE releases. We still make this system available but do not provide support for it under most circumstances.
