Skip to content

Commit 29abb94

Browse files
committed
Add service description text to readme
1 parent 4eed48d commit 29abb94

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,26 @@ This is the core of the OLA-HD project. OLA-HD is to archive, export and search
2727
* **Identity Management**: Users have to provide proper credentials to import data to the system.
2828
Frontend users are authenticated against the
2929
[GWDG SSO](https://gwdg.de/services/general-services/sso-aai/).
30-
* **Archive manager (CDSTAR)**: The service that is responsible for storing the data. This service
30+
* **Archive Manager (CDSTAR)**: The service that is responsible for storing the data. This service
3131
is called
3232
[CDSTAR](https://info.gwdg.de/dokuwiki/doku.php?id=en:services:storage_services:gwdg_cdstar:start)
3333
and maintained by GWDG. When data is imported, everything will be stored on tapes. To provide
3434
quick access to users, some data are copied to hard drive. In the current configuration, the
3535
system does not store TIFF images on hard drive.
3636
* **MongoDB**: the database of the back-end. It stores all import and export information.
3737

38+
The core of OLA-HD is the REST API (the Java-Spring REST Service Backend). It provides an API for
39+
importing, exporting and searching the data. The REST service also offers other functions such as
40+
exporting single files or querying metadata etc. The Backend-Service itself does not save any
41+
archive-data but sends it to the external archive manager CDSTAR. Each saved OCRD-ZIP is assigned a
42+
unique PID via the external PID-Service during import. The OLA-HD-Service uses a MongoDB to store
43+
information about the stored OCRD-ZIPs, such as the CDSTAR internal ID or the PID used. There are
44+
also 4 containers for the search: Web, Redis, Indexer and Elasticsearch. The information about the
45+
data is stored in Elasticsearch so that it can be searched quickly. This data is written to the
46+
Elasticsearch by the Indexer. It extracts this data from the archived files by querying them
47+
through the OLA-HD-Backend. The Web and Redis containers are used to process and forward the
48+
indexing requests from the Backend to the Indexer.
49+
3850

3951
2\. Installation and startup
4052
----------------------------

0 commit comments

Comments
 (0)