General purpose metadata repository and schema registry service.
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
There are three ways to install metaStore2 as a micorservice:
- Using the image available via DockerHub (recommended)
- Building docker image locally
- Building and running locally
In order to run this microservice via docker you'll need:
Typically, there is no need for locally building images as all version are accessible via DockerHub. Have a look of available images and their tags here Just follow instructions below.
In order to run this microservice via docker you'll need:
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$
Now you'll have to create an image containing the micro service. 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.: 0.1.1-2020-10-05)
user@localhost:/home/user/metastore2$ bash docker/buildDocker.sh
---------------------------------------------------------------------------
Build docker container kitdm/metastore2:0.1.1-2020-10-05
---------------------------------------------------------------------------
[...]
---------------------------------------------------------------------------
Now you can create and start the container by calling ...
---------------------------------------------------------------------------
user@localhost:/home/user/metastore2$
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 kitdm/metastore2 --format {{.Tag}}
0.1.1-2020-10-05
user@localhost:/home/user/metastore2$ docker run -d -p8040:8040 --name metastore4docker kitdm/metastore2:0.1.1-2020-10-05
57c973e7092bfc3778569f90632d60775dfecd12352f13a4fd2fdf4270865286
user@localhost:/home/user/metastore2$
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 kitdm/metastore2:0.1.1-2020-10-05
57c973e7092bfc3778569f90632d60775dfecd12352f13a4fd2fdf4270865286
user@localhost:/home/user/metastore2$
If you want to stop container just type
user@localhost:/home/user/metastore2$ docker stop metastore4docker
If you want to (re)start container just type
user@localhost:/home/user/metastore2$ docker start metastore4docker
In order to run this microservice via docker you'll need:
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$
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$
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: 1234
The metaStore framework consists of the following services:
- RabbitMQ - messaging service
- Elasticsearch - indexing service
- Indexing-service - service transforming metadata documents to json
- MetaStore2 - service managing metadata schema and metadata documents To build the whole framework use the shell script ('metatoreFramework.sh').
user@localhost:/home/user/metastore2$ bash metaStoreFramework.sh --help
Script for managing MetaStore service.
USAGE:
metaStoreFramework.sh [init|start|stop]
init - Initialize/Reset the whole framework
start - Start stopped framework
stop - Stop framework
user@localhost:/home/user/metastore2$
Two services may be customized to your needs.
- MetaStore
- overwrite settings by copying your application.properties file to ./settings/metastore
- Indexing-Service
- overwrite settings by copying your application.properties file to ./settings/indexing
As soon as the microservice is started, you can browse to
and start ingesting schemas and metadata documents.
If you want to use a script for doing so please refer to
http://localhost:8040/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.
A small documentation guiding you through the first steps of using the RESTful API you can find at
http://localhost:8040/static/docs/documentation.html
: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)
ℹ️ If metaStore should be used standalone (without KIT Data Manager) you have to setup a database before. (See 'Installation PostgreSQL')
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.
See setup database and setup for 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.sh
The MetaStore2 is licensed under the Apache License, Version 2.0.