Vega - ECS requests, Mediated requests, Secure requests deployment

Refer to the https://folio-org.atlassian.net/wiki/spaces/REL/pages/55738414 for up-to-date information

Back-end

Some BE modules only need to be enabled in some tenants:

  • mod-tlr - Central tenant only

  • mod-requests-mediated - Secure tenant only

Environment variables

mod-inventory-storage

Name: ECS_TLR_FEATURE_ENABLED , value: true

mod-patron

Name: SECURE_TENANT_ID , value: secure tenant ID

edge-patron

Name: SECURE_TENANT_ID , value: secure tenant ID

Potential Liquibase issues

If you’re deploying mod-tlr from scratch, there shouldn’t be any issue, but if you upgrade it from an older version, you might encounter an issue with Liquibase checksums. In order to fix you should clean Liquibase tables in mod-tlr’s DB as well as drop mod-tlr’s own tables:

delete from {TENANTID}_mod_tlr.databasechangelog; delete from {TENANTID}_mod_tlr.databasechangeloglock; drop table {TENANTID}_mod_tlr.ecs_tlr; drop table {TENANTID}_mod_tlr.tlr_settings;

Front-end

Add new variable enableEcsRequests: true, to platform-completestripes.config.jsconfig.

Secure tenant

Secure tenant is a non-central tenant that will be used for handling secure requests.

It should be a separate tenant with the property security=true set as described here https://folio-org.atlassian.net/browse/MGRTENANT-32

As mentioned in the Back end section, in LoC-like environments, Secure tenant should be the only one where mod-requests-mediated module is enabled.

Manual set-up after deployment

  • Allow TLR in all tenants (Settings → Circulation → General)

  • Enable ECS TLR feature in the central tenant (Settings → Circulation → General)

  • Optionally, check manually that the feature has been enabled in both mod-tlr and mod-circulation-storage:
    GET /tlr/settings
    GET /circulation-settings-storage/circulation-settings