Version: 2.0

REGARDS catalog microservice

Overview

Catalog (or rs-catalog) microservice is used to consult the meta-catalog.

Several functionalities are enabled by this service:

Searching for products with search criteria, respecting user access rights
Downloading product files
Retrieving datasets and collections information
Compatibility with search standards like STAC or OpenSearch through dedicated plugins
Performing operations on the products such as restoring, updating or deleting products through dedicated plugins

These functionalities ensure that user access rights are respected.

Storage : Some operations eventually are under Storage service's responsibility. This is the case for downloading, restoring or checking availability of products. When one of these operation is needed, Catalog calls Storage through a Storage REST Client.

Concept	Compatibility	Description
Multitenant	Yes	Can handle multiple tenants/projects
Vertical scalability	No	Does not use jobs system
Horizontal scalability	Yes	Service can be deployed with multiple instances

You can learn how the service works with the How it works section.

You can learn how to operate with the microservice thanks to API Guides :

Legacy Search API using REST API shows you how to make search requests with default REGARDS lucene based engine.
OpenSearch API using REST API shows you how to make search requests with OpenSearch engine.
STAC Search API using REST API shows you how to make search requests with STAC engine.
Complex Search using REST API shows you how to elaborate complex requests on the catalog with many search requests.
Download products using REST API
Product files restoration using REST API shows you how to make a product available for downloading if it is not.

See Plugins section to learn how to extend the functionality of the service.

To learn how the microservice is configured with static parameters from properties files see Configuration section.

To understand the configuration of specific tenant (aka project) see Import/export configuration section.

You can follow the User manuel to learn about the administrator HMI related functionalities :

Microservice source code is available on GitHub.