MetaStore 2 repository
[docker]: <https://ghcr-badge.egpl.dev/kit-data-manager/metastore2/tags?trim=major&color=steelblue&ignore=main,latest&label=docker versions> [currentVersion]: <https://ghcr-badge.egpl.dev/kit-data-manager/metastore2/latest_tag?trim=major&color=steelblue&label=current version>
MetaStore is a research data repository software for storing metadata documents and schemas. Quality and consistency are ensured by associating and validating each document against a schema. It supports JSON and XML.
It allows you to
- register an (XML/JSON) schema
- update an (XML/JSON) schema
- add metadata linked with a registered schema
- validate metadata against a registered schema
- update added metadata
Installation
There are three ways to install metaStore2 as a microservice:
- Using the image available via GitHub Packages (recommended)
- Building docker image locally
- Building and running locally
Installation via GitHub Packages
Prerequisites
In order to run this microservice via docker you'll need:
Installation
Typically, there is no need for locally building images as all version are accessible via GitHub Packages. Have a look of available images and their tags here Just follow instructions below.
Build docker container locally
Prerequisites
In order to run this microservice via docker you'll need:
Installation
Clone repository
First of all you'll have to clone this repository:
user@localhost:/home/user/$ git clone https://github.com/kit-data-manager/metastore2.git
Clone to 'metastore2'
[...]
user@localhost:/home/user/$ cd metastore2
user@localhost:/home/user/metastore2$Create image
Now you'll have to create an image containing the microservice. This can be done via a script. On default the created images will be tagged as follows:
'latest tag'-'actual date(yyyy-mm-dd)' (e.g.: 1.2.0-2023-06-27)
user@localhost:/home/user/metastore2$ bash docker/buildDocker.sh
---------------------------------------------------------------------------
Build docker container ghcr.io/kit-data-manager/metastore2:1.2.0-2023-06-27
---------------------------------------------------------------------------
[...]
---------------------------------------------------------------------------
Now you can create and start the container by calling ...
---------------------------------------------------------------------------
user@localhost:/home/user/metastore2$Build docker container
After building image you have to create (and start) a container for executing microservice:
# If you want to use a specific image you may list all possible tags first.
user@localhost:/home/user/metastore2$ docker images ghcr.io/kit-data-manager/metastore2 --format {{.Tag}}
1.2.0-2023-06-27
user@localhost:/home/user/metastore2$ docker run -d -p8040:8040 --name metastore4docker ghcr.io/kit-data-manager/metastore2:1.2.0-2023-06-27
57c973e7092bfc3778569f90632d60775dfecd12352f13a4fd2fdf4270865286
user@localhost:/home/user/metastore2$Customize settings
If you want to overwrite default configuration of your docker container you have to 'mount' a config directory containing 'application.properties' with your adapted settings. Therefor you have to provide an additional flag to the command mentioned before:
# Overwriting default settings
# Create config folder
user@localhost:/home/user/metastore2$ mkdir config
# Place your own 'application.properties' inside the config directory
# Create/run container
user@localhost:/home/user/metastore2$ docker run -d -p8040:8040 -v `pwd`/config:/spring/metastore2/config --name metastore4docker ghcr.io/kit-data-manager/metastore2:1.2.0-2023-06-27
57c973e7092bfc3778569f90632d60775dfecd12352f13a4fd2fdf4270865286
user@localhost:/home/user/metastore2$Stop docker container
If you want to stop container just type
user@localhost:/home/user/metastore2$ docker stop metastore4docker(Re)start docker container
If you want to (re)start container just type
user@localhost:/home/user/metastore2$ docker start metastore4dockerBuild and run locally
Prerequisites
In order to run this microservice via docker you'll need:
Installation
Clone repository
First of all you'll have to clone this repository:
user@localhost:/home/user/$ git clone https://github.com/kit-data-manager/metastore2.git
Clone to 'metastore2'
[...]
user@localhost:/home/user/$ cd metastore2
user@localhost:/home/user/metastore2$Build service
To build service just execute the build.sh script:
user@localhost:/home/user/metastore2$bash build.sh /PATH/TO/EMPTY/INSTALLATION/DIRECTORY
---------------------------------------------------------------------------
Build microservice of metastore2 at /PATH/TO/EMPTY/INSTALLATION/DIRECTORY
---------------------------------------------------------------------------
[...]
---------------------------------------------------------------------------
Now you can start the service by calling /PATH/TO/EMPTY/INSTALLATION/DIRECTORY/run.sh
---------------------------------------------------------------------------
user@localhost:/home/user/metastore2$Customize settings
If you want to overwrite default configuration of your docker container you have to add a file named 'application.properties' to the 'config' directory inside your installation path (/PATH/TO/EMPTY/INSTALLATION/DIRECTORY)selected before. The added file should only contain your adapted settings. e.g. in case you want to change only the port to '1234' your 'application.properties' should look like this:
# Overwriting default settings from ../application.properties
# Server settings
server.port: 1234Build framework using docker (Linux only)
Based on Docker Compose, the entire framework, including elasticsearch and the UI, can now be installed with a single command.
user@localhost:/home/user/metastore2$ docker compose up -dAs soon all services are running you can browse to http://localhost/index.html
First steps using framework
If you want to use the (external) web frontend please visit:
https://kit-data-manager.github.io/webpage/metastore/documentation/frontend/index.html
A small documentation guiding you through the first steps of using the RESTful API you can find at
https://kit-data-manager.github.io/webpage/metastore/documentation/REST/index.html
If you want to use a script for doing so please refer to
http://metastore.docker:8040/metastore/swagger-ui.html
in order to see available RESTful endpoints and their documentation. Furthermore, you can use this Web interface to test single API calls in order to get familiar with the service.
Managing framework using docker
To stop and start all services do the following:
user@localhost:/home/user/metastore2$ docker compose stop
[+] Running 6/6
⠿ Container dockercompose-my-apache-1 Stopped 1.5s
⠿ Container indexing4metastore Stopped 13.2s
⠿ Container dockercompose-dps-1 Stopped 0.3s
⠿ Container metastore.docker St... 13.1s
⠿ Container rabbitmq4indexing S... 6.5s
⠿ Container elastic4indexing St... 0.8s
user@localhost:/home/user/metastore2$ docker compose start
[+] Running 6/6
⠿ Container dockercompose-dps-1 Started 0.4s
⠿ Container dockercompose-my-apache-1 Started 0.6s
⠿ Container elastic4indexing He... 10.9s
⠿ Container rabbitmq4indexing S... 0.3s
⠿ Container metastore.docker St... 0.5s
⠿ Container indexing4metastore Started 0.5s
user@localhost:/home/user/metastore2$First steps using MetaStore standalone
If you're using MetaStore without the whole framework the service is reachable via http://localhost:8040/metastore/....
Setup for production mode
:WARNING: If you want to use the service in production mode you have modify your configuration (application.properties).
- Don't open port to public (as long as AAI is not implemented)
- Use a productive database (e.g. postgres)
- Setup directories for schemata and metadata to a reliable disc. (metastore.schema.schemaFolder, metastore.metadata.metadataFolder)
- Check all settings in application.properties. (e.g. CSRF)
:information_source: If MetaStore should be used standalone (without KIT Data Manager) you have to install a database before. (See 'Installation PostgreSQL')
Setup MetaStore2
Before you are able to start the repository microservice, you have to modify the file 'application.properties' according to your local setup. Therefor, copy the file 'settings/application-example.properties' to your project folder, rename it to 'application.properties' and customize it. Special attentioned should be payed to the database setup (spring.datasource.*), and the paths of schemata (metastore.schema.schemaFolder) / metadata (metastore.schema.metadataFolder). to the repository base path. Also, the property 'repo.messaging.enabled' should be changed to 'true' in case you want to use the messaging feature of the repository.
Setup database
See setup database and setup for MetaStore2.
Start MetaStore2
As soon as you finished modifying 'application.properties', you may start the repository microservice by executing the following command inside the installation folder:
user@localhost:/home/user/metastore2$bash /PATH/TO/EMPTY/INSTALLATION/DIRECTORY/run.shMore Information
License
The MetaStore2 is licensed under the Apache License, Version 2.0.