- Home
-
Metastore migration/update guide
Downloads:
A Research Data Repository Service for Managing Metadata Documents based on JSON or XML.
If you are migrating from an older version please look at all versions starting from the current version of your installation. If you are updating a local installation you have to copy the new jar file to the installation directory. For older versions (< 1.3.1) you also have to overwrite run.sh with the new version. For newer versions updating link of metastore2.jar to newest version should be sufficient.
Before starting the new version you should check the migration guide for any changes. Even though it is not specifically mentioned, it is always a good idea to do a backup before upgrading. (See Backup)
Add the new settings to ‘application.properties’ (if not recommended otherwise). If the values should not correspond to the default value, please add the adjusted values to ‘config/application.properties’.
Please start the new version once with an additional parameter to migrate to the new database structure. This will also migrate the elasticsearch index (if available).
$ run.sh --migrate2DataCite
[...]
2024-11-25T10:04:55.670+01:00 INFO 54393 --- [ main] e.k.datamanager.metastore2.Application : Spring is running!
Nothing to migrate.
Nothing to migrate.
Nothing to migrate.
Nothing to migrate.
There are new configuration options inside the application.properties:
Due to a new feature in proxy library the below property is REQUIRED for the search endpoints to work properly:
###############################################################################
# Due to bug in spring cloud gateway
# https://github.com/spring-cloud/spring-cloud-gateway/issues/3154
###############################################################################
spring.cloud.gateway.proxy.sensitive=content-length
It allows administrators to define an external landing page in case of an existing external WebUI:
###############################################################################
# Landing Page (Schema & Metadata Documents)
# Redirect to internal or external landing page.
# The string may contain two placeholders for substitution:
# - $(id) - Identifier of the digital object (mandatory)
# - $(version) - Version of the digital object (optional)
#
# e.g.: https://www.example.org/landingpage?id=$(id)&version=$(version)
#
# For frontend-collection use metastore-landing-page.html?pid=$(id)
# e.g. https://HOSTNAME/metastore-landing-page.html?pid=$(id)&version=$(version)
#
# Defaults:
# - /schema-landing-page?schemaId=$(id)&version=$(version) (schema documents)
# - /metadata-landing-page?id=$(id)&version=$(version) (metadata documents)
###############################################################################
metastore.schema.landingpage:/schema-landing-page?schemaId=$(id)&version=$(version)
metastore.metadata.landingpage:/metadata-landing-page?id=$(id)&version=$(version)
Set credentials for RabbitMQ in case of RabbitMQ is public available and therefore default credentials are not valid:
###############################################################################
# Messaging - RabbitMQ
###############################################################################
repo.[...]
repo.messaging.username:guest
repo.messaging.password:guest
repo.[...]
Please start the new version once to create the new database structure. There will be a new sequence created called ‘linked_metadata_record_seq’. You have to set the last_value of the sequence to the maximum ‘id’ of the ‘linked_metadata_record’ table.
In postgres this could be done like follows:
postgres@hostname:/$ psql
psql (14.9 (Ubuntu 14.9-0ubuntu0.22.04.1))
Type "help" for help.
postgres=# \c DATABASE (see connection settings in application.properties)
You are now connected to database "DATABASE" as user "postgres".
DATABASE=# select MAX(id) from linked_metadata_record;
max
-----
MAX_ID
(1 row)
DATABASE=# SELECT pg_catalog.setval('public.linked_metadata_record_seq', MAX_ID, true);
Replace DATABASE and MAX_ID with the values you determined.
There is a new configuration option inside the application.properties: Default context path switched from ‘/’ to ‘/metastore’ In case of an update remove this line.
###############################################################################
# Context Path (Don't add or change once service contains documents.)
###############################################################################
server.servlet.context-path=/metastore
There are new configuration options inside the application.properties: It allows administrators to define directory structure while storing metadata/schema documents.
###############################################################################
# Setup folder management for metadata documents
# Note: Creating more than 50.000 directories inside one directory might cause
# performance issues.
# Possible values:
# - simple (No hierarchie at all)
# - idBased (Split ID in small parts and create directory structure out of it)
# - dateBased (Create directory structure by date) (default)
###############################################################################
metastore.metadata.storagepattern:dateBased
# Configuration for 'idBased' e.g. 4ca2cc62-df0b-49b1-b622-ce855554adfc -> 4ca2/cc62/df0b/49b1/b622/ce85/5554/4ca2cc62df0b49b1b622ce855554adfc
# default: charPerDirectory: 4, maxDepth: 7
repo.plugin.storage.id.charPerDirectory:4
repo.plugin.storage.id.maxDepth:7
# Configuration for 'dateBased' e.g.: @{year}/@{year}_@{month}_@{day}_@{hour}_@{minute}
# default: @{year}/@{month}
repo.plugin.storage.date.pathPattern:@{year}/@{month}
There is a new configuration option inside the application.properties: It allows administrators to run MetaStore service behind a proxy.
###############################################################################
# Proxy (enable this line if you want to use the service behind a proxy.)
###############################################################################
#server.forward-headers-strategy=framework
Nothing to migrate.
There is a new configuration option inside the application.properties: Add actuators for info and health as default.
###############################################################################
# Management endpoint settings
###############################################################################
management.endpoint.health.enabled: true
management.endpoint.health.show-details: WHEN-AUTHORIZED
management.endpoint.health.sensitive: false
management.endpoints.web.exposure.include: *
# Disable unused service
# Remove or enable the corresponding lines if you want to check the health of
# dependent services as well.
management.health.elasticsearch.enabled: false
management.health.rabbit.enabled: false
Nothing to migrate.
First production ready version.