Overview
Ingest (or rs-ingest) microservice is the service that manage
OAIS products. It
is the main service of
the set of OAIS Services (Functional overview).
It is one of the many data sources that can be
crawled by rs-dam microservice to populate
the meta-catalog.
This microservice is designed to comply with the CCSDS OAIS recommendation.
In this recommendation :
- Products are submitted with SIP (Submission Information Package).
- SIP are converted into AIP (Archival Information Package) thanks to a Ingest chain.
- Files are stored in one or many locations (functionality delegated to rs-storage microservice)
- AIP are updated with files locations and preservation additional information.
The REGARDS implementation of the OAIS SIP format is describe in the appendix Regards OAIS.
rs-ingest responsibilities :
- Ingest SIP,
- Transform SIP to AIP, with metadata enhancement thanks to an Ingest chain.
- Submit files to rs-storage microservice to be stored in one or several storage locations
- Listen for rs-storage responses and update AIP with new files information
- Delete AIP
- Handle SIP and AIP versioning
- Notify events on AIP products to subscribers
| Concept | Compatibility | Description |
|---|---|---|
| Multitenant | Yes | Can handle multiple tenants/projects |
| Vertical scalability | Yes | Uses Jobs system |
| Horizontal scalability | No | Service can not be deployed with multiple instances |
You can learn how the service works with the How it works section.
How to use
You can learn how to operate with the microservice thanks to API Guides :
- Submit product using REST API or using AMQP API shows you how to submit SIP.
- Search products using REST API
- Browse all REST API available endpoints.
Plugins
See Plugins section to learn how the products creation is customizable for each mission or project.
How to configure
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.
How to access through UI
You can follow the User manuel to learn about the administrator UI related functionalities :
- How to configure Ingest chains.
- How to configure global settings
- How to submit a SIP
- How to notify products
How to access source code
Microservice source code is available on GitHub.