Installation Overview

The high level architecture of PDS Registry and its main components is shown below.

You can run all components on your laptop or install some or all of them on a server.

Java

Java is required to run many Registry components and tools such as Harvest, Registry Manager, API Server and Elasticsearch. Only Java 11 is supported. Some applications, like Harvest or Registry Manager will not run with Java 1.8. To install JDK 11 follow instructions in Java Installation section.

Elasticsearch

Elasticsearch is required to store and search PDS metadata. Elasticsearch can be installed on a developer laptop as described in Elasticsearch - Quick Start section. For production deployment see Production Deployment section.

Registry Tools

Harvest is a tool to crawl and extract metadata from PDS4 labels. Extracted metadata is stored in an "intermediate" JSON or XML data files. JSON data files can be loaded into Elasticsearch by Registry Manager.

Registry Manager is a tool to create Registry indices in Elasticsearch and to load, delete and export registry data.

The installation of Harvest and Registry Manager is described in Tools section.

API Server

API Server provides read-only REST APIs to search and access PDS data. The APIs are standardized between different PDS nodes.

The installation of API Server is described in API Server section.