DOCSEARCHbyAlgolia
Submit Docs

REGARDS Documentation

website·Indexed 29 days ago

https://regardsoss.github.io/

Technical documentation for REGARDS, an open-source microservices-based system. Covers development guides for backend frameworks, AMQP and REST APIs, storage location plugins (Local, S3, S3 Glacier), and user guides for data catalog configuration and SIP ingestion. Documentation available for versions 2.2.0 and 2.4.1.

Tokens
1.1M
Snippets
4.1K
Records
7.3K
Agent score
63%

What's inside REGARDS

  3. Overview of Toponyms in REGARDS

    A toponym is a name used to qualify a place represented by a geographic area (e.g., countries, continents, regions, or lakes). In REGARDS, a toponym server is deployed within the access-instance microservice. This server provides default toponyms for all countries worldwide based on georeferenced data from ArcGIS. The user interface uses this server to allow users to search the data catalog by geographic zone.

  7. Overview of REGARDS OSS scientific archive framework

    REGARDS OSS is a cloud-native microservice framework designed to build scientific archives for storing data and metadata from spatial agencies on safe storage systems. It is based on the OAIS (Open Archival Information System) recommendation from the CCSDS and supports high-performance ingestion of data and metadata in both standard and non-standard formats.

  10. Overview of the rs-access-project microservice

    The rs-access-project (Access project) microservice serves as a Backend for Frontend (BFF) for the Regards Web UI. It is a multitenant service deployed for each user project. Its primary responsibilities include managing the configuration of the user's UI (modules, plugins, theme, and layout) and acting as a proxy for the following microservices:

    • rs-admin: Handles CRUD operations for project users.
    • rs-catalog: Facilitates product searches to add applicable service plugins.
    • rs-storage: Manages quotas to limit file downloads per user in an order.
    • rs-access-instance & rs-catalog: Replaces toponyms with geometries during searches.

    Scalability and Compatibility:

    • Multitenant: Yes (can handle multiple tenants/projects).
    • Vertical Scalability: No (uses the Jobs system).
    • Horizontal Scalability: No (cannot be deployed with multiple instances).

  11. Overview of Front-end Service Plugins

    A front-end service plugin is a JavaScript bundle used by search results modules to add graphical services (such as charts or custom interfaces) to a specific entity or a selection of entities. Unlike catalog plugins, which run on a server and typically output files, front-end services run in the user's browser and are used for interactive UI functionality. For tasks involving heavy data volumes, it is recommended to couple a catalog plugin (for data retrieval and file preparation) with a front-end service (to consume that file and display the view).

  12. Overview of the rs-worker-manager microservice

    The rs-worker-manager (Worker Manager) is a microservice designed to manage light, scalable, and hot-deployable treatments performed by standalone applications called workers.

    Key responsibilities include:

    • Managing the lifecycle of workers.
    • Sending requests to workers and handling retries for failed requests.
    • Monitoring treatments executed by workers.
    • Managing worker workflows, where the output of one worker serves as the input for the next.

    Capabilities:

    • Multitenancy: Supports multiple tenants and projects.
    • Vertical Scalability: Utilizes a Jobs system.
    • Horizontal Scalability: Supports deployment across multiple service instances.