Installation

This section describes how to install the Registry Service software contained in the registry-service package. The following topics can be found in this section:

• System Requirements
• Unpacking the Package
• Deploying the Application
• Configuration

System Requirements

The Registry Service was developed using Java and Jersey and will run under a standard Java Application Server. The tool was specifically developed under Sun Java version 1.6, so the tool will execute correctly under 1.6 and future versions.

Since the tool was developed using Sun's Java, the target Java Application Server should support Sun's Java Runtime Environment (JRE). The application was tested using Apache's Tomcat version 5.5.X, which is the preferred Java Application Server for deployment. The software can be obtained from the Apache Tomcat web site. Other Java Application Servers should be compatible.

Although it is generally a useful tool for interacting with the Registry Service, the cURL command-line application is required by the load_registry script for populating the service with the supported object types. See the Configuration section for more information.

Unpacking the Package

Download the registry-service package from the yet to be developed PDS 2010 web page. The binary distribution is available in identical zip or tar/gzip packages. Unpack the selected binary distribution file with one of the following commands:

% unzip registry-service-0.5.0-bin.zip
or
% tar -xzvf registry-service-0.5.0-bin.tar.gz
      

Note: Depending on the platform, the native version of tar may produce an error when attempting to unpack the distribution file because many of the file paths are greater than 100 characters. If available, the GNU version of tar will resolve this problem. If that is not available or cannot be installed, the zipped package will work just fine in a UNIX environment.

The commands above result in the creation of the registry-service-0.5.0 directory with the following directory structure:

• README.txt
  

  A README file directing the user to the available documentation for the project.

• LICENSE.txt
  

  The copyright notice from the California Institute of Technology detailing the restrictions regarding the use and distribution of this software. Although the license is strictly worded, the software has been classified as Technology and Software Publicly Available (TSPA) and is available for anyone to download and use.

• registry-service-0.5.0.war
  

  This is the Web ARchive (WAR) file containing the Registry Service software including all dependent JAR files.

• bin/
  

  This directory contains the batch and shell scripts for registering the supported object types.

• conf/
  

  This directory contains the policy files identifying the supported object types.

• doc/
  

  This document directory contains a local web site with the Registry Service Guide, javadoc, unit test results and other configuration management related information. Just point your favorite browser to the index.html file in this directory.

• examples/
  

  This directory contains examples of artifact descriptions that can be registered with a service instance.

Deploying the Application

The Registry Service web application is packaged as a WAR file and is intended for installation under a standard Java Application Server. Prior to installation the WAR file should be renamed from registry-service-0.5.0.war to registry-service.war. A WAR file is normally copied directly to the webapps directory or installed via the Manager interface. Once this step is complete, the application is ready for operation.

If deploying to an Apache Tomcat server and using Derby as the backend database, you may want to permanently set the home directory of the database by adding the following to the CATALINA_OPTS environment variable:

CATALINA_OPTS="-Dderby.system.home=/path/to/registrydb/home"
      

The CATALINA_OPTS environment variable is loaded from the Apache Tomcat startup scripts. If this value is not set, the Derby database home will default to the current working directory where the Apache Tomcat server was launched.

Verify a successful installation by executing the command from the Ping Service portion of the Operation section.

Configuration

Once the Registry Service is installed and running, the list of supported object types must be registered with the service. The list of objects types corresponds with the types of products that a given instance of the Registry Service will support. Execute the load_registry script from the bin directory in order to registry the full set of object types:

% cd registry-service-0.5.0/bin
% load_registry
      

The load_registry script defaults to a Registry Service end point of http://localhost:8080/registry-service. If necessary, modify the script so that it corresponds with the target installation. In addition, this script should be executed prior to applying security to the service URLs since it does not account for a secured interface.