UXPROD-5534: Migration from mod-configuration to mod-settings

UXPROD-5534: Migration from mod-configuration to mod-settings

mod-users-bl

This module uses configuration (as well as mod-users-keycloak) to generate a password reset link for module USERSBL:

Migration Approach

Implement a local settings API to store this configuration locally with the same keys:

  • FOLIO_HOST (it is a global setting, it should be retrieved from mod-settings)

  • RESET_PASSWORD_UI_PATH

  • FORGOT_PASSWORD_UI_PATH

An additional step is required to migrate existing settings from mod-configuration to mod-settings

mod-tags / ui-tags

Uses the global variable for module TAGS

query=(module==TAGS and configName==tags_enabled)

Migration Approach

It will be migrated to mod-settings entry with the same key

An additional step is required to migrate existing settings from mod-configuration to mod-settings

edge-sip2

This module uses the following configuration from mod-configuration

  1. Tenant properties: https://github.com/folio-org/edge-sip2?tab=readme-ov-file#tenant-properties

  2. Kiosk (service point) Properties: https://github.com/folio-org/edge-sip2?tab=readme-ov-file#tenant-properties

  3. FOLIO Provided Properties (Locale and currency configuration): https://github.com/folio-org/edge-sip2?tab=readme-ov-file#folio-provided-properties

Migration Approach

The simplest approach is to move this configuration from mod-configuration to mod-settings, with the value being an actual JSON object instead of a String

  • An additional step is required to migrate existing settings from mod-configuration to mod-settings

mod-email

This module uses the SMTP configuration (it is a second choice) from mod-configuration

Also, this module provides an SMTP configuration endpoint: https://s3.amazonaws.com/foliodocs/api/mod-email/p/smtp-configuration.html

Migration approach

Deprecate the SMTP configuration endpoint (make it for some period of time as a secondary choice) and migrate to the local settings endpoint (with SMTP configuration being stored under the smtp-configuration key)

It could be done without an additional step, and when the endpoint is deprecated, it is expected that existing configuration jobs are updated