Release Description 1.1.0
This release of the PDS4 System represents Build 1c and is intended as a prototype release in support of the assessment of the PDS4 standards and the system components to date. The following sections can be found in this document:
Reference Documents
This section details the controlling and applicable documents referenced for this release. The controlling documents are as follows:
- Planetary Data System (PDS) Level 1, 2 and 3 Requirements, March 26, 2010.
- Planetary Data System (PDS) 2010 Project Plan, February 2010.
- Planetary Data System (PDS) 2010 System Architecture Specification, Version 1.1, May 5, 2010.
- Planetary Data System (PDS) 2010 Operations Concept, February 2010.
- Planetary Data System (PDS) General System Software Requirements Document (SRD), Version 0.1, September 27, 2010.
- Planetary Data System (PDS) Harvest Tool Software Requirements and Design Document (SRD/SDD), Version 0.4, September 28, 2010.
- Planetary Data System (PDS) Preparation Tools Software Requirements and Design Document (SRD/SDD), Version 0.1, October 6, 2010.
- Planetary Data System (PDS) Registry Service Software Requirements and Design Document (SRD/SDD), Version 0.6, September 28, 2010.
- Planetary Data System (PDS) Report Service Software Requirements and Design Document (SRD/SDD), Version 0.7, September 28, 2010.
- Planetary Data System (PDS) Security Service Software Requirements and Design Document (SRD/SDD), Version 0.6, September 28, 2010.
The applicable documents are as follows:
- NASA Planetary Data System (PDS) 2010 System Build I Test Plan
Capabilities
This section details the new, modified and corrected capabilities that comprise this release. They are summarized here for a system-level view. A more detailed list of capabilities can be found in the release notes and change logs for each component.
New Capabilities
The following capabilities are new for this release:
- Harvest Tool now includes support for validation of products prior to registration and can now be executed and run as a daemon process.
- Registry Service now includes a configuration endpoint allowing the configuration file generated from the data model to be processed in one action. Also added support for a registry package object to support batch operations. Also added support for MySQL as a backend database.
Modified Capabilities
The following capabilities have been modified for this release:
- Harvest Tool was modified for more robust handling of Association registrations as well as modified to keep pace with changes occurring in the PDS4 data model and the Registry Service interface.
- Registry Service was modified to move the core functionality to the Registry Core component to better satisfy JAR dependencies from other components. Also modified to include additional support for service registrations, general query improvements for registry objects and better alignment with the ebXML registry specification.
- Registry User Interface was modified to keep pace with the changes to the Registry Service interface.
- Security Service was modified to simplify the deployed solution by utilizing a single directory service to satisfy the requirements.
- Validate Tool was modified to include the latest set of generic schemas generated from the data model.
Corrected Capabilities
There were no corrected capabilities in this release.
Liens
This section details the liens against the capabilities that have yet to be implemented or are partially implemented. They are summarized here for a system-level view. A more detailed list of liens can be found in the release notes for each component.
- Need to add support for registration of PDS3 products to the Harvest Tool.
- Need to expand the Registry Service functionality to include registration of federation and registry objects.
- Need to expand the Registry User Interface to support browsing of objects beyond products and associations. Also need to add support for updating status and single product registration.
System Requirements
This section details the system requirements for installing and operating the software. The custom software contained in this release was developed using Java and will run on any platform with a supported Java Runtime Environment (JRE). The software was specifically developed under Sun Java version 1.6 and has only been tested with this version.
The other main system requirement pertains to providing an application server for hosting certain components (Registry Service, Registry User Interface and Report Service). The suggested application server for this release is Apache Tomcat with a minimal version of 6.0.20.
Specific system requirements for each component in this release can be found in their respective Installation documents.
Installation/Operation
This section details the installation and operation of the software in this release. This release is intended for deployment in the Engineering Node operations environment with certain components deployed in the environments of participating Nodes. Details regarding the release for each of these components, including installation of the packages and operation of the associated software, can be found in the documentation for each component. This release is comprised of the following versions of the components:
- Harvest Tool - 0.3.0
- Preparation Tools
- Core Library - 0.2.0
- Design Tool - 0.2.0
- Validate Tool - 0.2.0
- Registry
- Registry Core - 0.1.0
- Registry Service - 0.6.0
- Registry User Interface - 0.3.0
- Report Service - 0.1.0
- Security Service - 0.3.0
EN Environment
This section details deployment to the EN operations environment. The following diagram details the deployment of the major components of this release and gives a very high-level view of the interfaces between the components and system resources:
If viewing this document in online form, click the image for a larger version.
The components depicted above serve as the operational deployment of this release for the Engineering Node. The main purpose of this deployment is for demonstration and testing purposes.
- Registry Service
The Registry Service provides functionality for tracking, auditing, locating and maintaining artifacts within the system. For this release, the registry is populated with the PDS4 context products migrated from the PDS3 central catalog database. New for this release, the EN deployment will utilize MySQL as the backend database for the service. The web-based endpoint for this service is http://pdsops2.jpl.nasa.gov/registry-service/registry/.
- Registry User Interface
The Registry User Interface provides a simple viewing capability of the contents of the associated Registry Service. It is intended to offer visual verification of successful registration of products. The web-based endpoint for this application is http://pdsops2.jpl.nasa.gov/registry-ui/.
- Report Service
The Report Service provides the capability for capturing and reporting metrics. With this release and the previous release, this service is undergoing testing of configurations and features with a set of metrics from the Engineering Node and the Imaging Node at JPL. This service is not yet available to the user community. The web-based endpoint for this service is http://pdsops.jpl.nasa.gov/report-service/.
- Security Service
The Security Service provides authentication and authorization functions for the system. This service is satisfied with an open source directory service. The directory service is populated with the PDS personnel list extracted from the PDS3 central catalog database. The application server hosting the Registry Service and Registry User Interface is configured to restrict access to certain URLs and to forward those requests to this service for authentication and authorization.
- Harvest Tool
The Harvest Tool provides the means for registering products with the Registry Service. This tool reads a PDS4 product label, extracts specified metadata and registers the product with the registry. This tool allows the user to register a batch of products and generates a summary report.
Node Environment
This section details the deployment to a participating Node environment. The Nodes are asked to download, install and exercise the software that makes up this release. The following diagram details an example deployment of selected components:
If viewing this document in online form, click the image for a larger version.
The selected components depicted above are intended to aid the Nodes in their PDS3 to PDS4 conversion exercises. The following diagram depicts a normalized system flow, starting with schema design, continuing onto data product label generation and validation and finishing up with data product registration:
If viewing this document in online form, click the image for a larger version.
The system flow depicted above is described in more detail in the Data Provider's Handbook, albeit with a different flavor of this diagram. This diagram identifies where the system components come into play within the system flow. These components and the ones depicted in the deployment diagram, are described in more detail with respect to how the components can be utilized in the PDS3 to PDS4 conversion exercises with an eye towards testing these components for use in operations:
- Design Tool
Although not depicted in the deployment diagram, the Design Tool is intended to aid users in the development of their data product label schemas. This release identifies two off-the-shelf products (Oxygen and Eclipse) that are available for this purpose. The provided documentation guides the user with respect to the download, installation and operation of each of these products.
- Validate Tool
The Validate Tool comes pre-packaged with the latest version of the generic schemas generated from the data model. The tool allows the user to validate collections of products or single products against the associated generic schema. Specific schemas can be passed into the tool to enable a more detailed validation check. Although the Design Tools listed above provide a file-by-file validation capability, this tool allows the user to validate a batch of products and generates a summary report.
- Registry Service
The Registry Service provides functionality for tracking, auditing, locating and maintaining artifacts within the system. Ultimately, all products (including PDS3 products) will be registered and tracked with the Registry Service. For this release, users are asked to install and configure a local instance of the service in order to exercise this procedure. Additionally if the user is participating in the PDS3 to PDS4 conversion exercises, the resulting products or collections of products can be registered with their local registry instance. For this release, it is assumed that the Node deployments will utilize Derby as the backend database for the service. If MySQL is preferred, a specific package can be provided upon request.
- Registry User Interface
The Registry User Interface provides a simple viewing capability of the contents of the associated Registry Service. It is intended to offer visual verification of successful registration of products.
- Harvest Tool
The Harvest Tool provides the means for registering products with the Registry Service. This tool reads a PDS4 product label, extracts specified metadata and registers the product with the registry. This tool functions as the Validate Tool does, in that it allows the user to register a batch of products and generates a summary report.