/
Sunflower (R1 2025) Changes and required actions

Sunflower (R1 2025) Changes and required actions

Functional Area

Change or Additions

Considerations

Action timing,
Action required

Comments

Contact person,
Related JIRAs

Functional Area

Change or Additions

Considerations

Action timing,
Action required

Comments

Contact person,
Related JIRAs

Affected app or module

What has been changed or added that should be noted for this release

What challenges may arise related to this change or addition

When can the action be taken (before, during or after upgrade)?

If applicable, detail what action(s) must be taken here

Is this action required for the next release?

Name of user leaving comment: comment on what you encountered or ask a question @mention Contact person

User name of person that can provide additional detail.
Include issue link for bug fix, story or feature that applies

mod-organizations
Integrations

Integration type added for “Claiming”

Prior to Sunflower, integration type is undefined and assumed to be Ordering

During the upgrade, existing integrations should have “Ordering” added as “Integration type”.

 

@Joseph Reimers
UIORGS-442: Add claiming to organization integration detailsClosed (See Scenario 7 for specifics)

mod-users-keycloak/mod-consortia-keycloak

Enable the feature to allow users created in member tenants to log in to ECS.

Prior to Sunflower, only users created in the central tenant were able to log in in Eureka. The feature to enable login for users from member tenants should be enabled by making modifications to the following two modules:

  1. mod-users-keycloak

    • Set the SINGLE_TENANT_UX variable to true.

  2. mod-consortia-keycloak

    • Set the SINGLE_TENANT_UX variable to true. Additionally, the following environment variable must be added:
      KC_IDENTITY_PROVIDER_BASE_URL

When adding a tenant to the consortium, all existing users and Keycloak identity providers (IDPs) are automatically created or upgraded to enable login functionality.

If the tenant was already added to the consortium previously, it is necessary to invoke the following endpoints:

  1. For the central tenant: To create a Custom Login Flow, use:
    https://s3.amazonaws.com/foliodocs/api/mod-consortia-keycloak/s/tenants.html#operation/setupCustomLogin

  2. For each member tenant: To create a Keycloak IDP and migrate users, use

https://s3.amazonaws.com/foliodocs/api/mod-consortia-keycloak/s/tenants.html#operation/createIdentityProvider

More details about new migration is presented in this Confluence page:

Run migration for existing users tor unified login in Eureka

@Serhii_Nosko

RANCHER-2125: Enable the feature that allows to log in to member tenantsClosed (Refer to the related PR in the story to see how the feature was enabled for Rancher-based environments)

 

 

 

 

 

 

 

 

 

 

mod-organizations-storage/mod-invoice-storage

Add Kafka related env variables for these 2 modules

Starting with Sunflower, these two modules began sending Kafka events to support the Audit Events History functionality, which will be consumed by mod-audit

Add Kafka-related environment variables like KAFKA_HOST, KAFKA_PORT with the same values as those used for mod-orders-storage, where the audit events functionality was implemented prior to the Sunflower release

 

@Serhii_Nosko

https://folio-org.atlassian.net/browse/UXPROD-3457

https://folio-org.atlassian.net/browse/UXPROD-3456

Authorities

Changes to MARC-Authority mappings were introduced

MARC migration for authorities must be executed with "publishEvents": false according to instructions:https://folio-org.atlassian.net/wiki/spaces/SPITFIRE/pages/492142594
After migration is executed, the Authority re-index must be executed according to instructions: https://github.com/folio-org/mod-search/tree/MSEARCH-966?tab=readme-ov-file#recreating-elasticsearch-index
It’s crucial that during the MARC migration process, there is no interaction with the environment.

After upgrading to new module versions

 

@Pavlo Smahin

Instances

Changes to OpenSearch index mappings

Instance re-index is required to be executed according to instructions: https://github.com/folio-org/mod-search/tree/MSEARCH-966?tab=readme-ov-file#indexing-of-instance-records

After upgrading to new module versions

 

@Pavlo Smahin

Agreements file storage

  • Added new environment variable GLOBAL_S3_SECRET_KEY

  • Deprecated environment variable AWS_SECRET_ACCESS_KEY

The new environment variable GLOBAL_S3_SECRET_KEY can be used to set an S3 secret key, used by the module when configured to use S3 for document storage (see https://folio-org.atlassian.net/wiki/spaces/FOLIOtips/pages/5673711 for more information on this configuration)

Using this environment overrides the “S3 secret key” setting in the app and so can be used to avoid exposing the secret key in the FOLIO Settings UI

The “GLOBAL_S3_SECRET_KEY” environment variable should be set if it is preferred to make the secret key inaccessible via the FOLIO UI. This can be done at any time.

 

@Owen Stephens

Licenses file storage

  • Added new environment variable GLOBAL_S3_SECRET_KEY

  • Deprecated environment variable AWS_SECRET_ACCESS_KEY

The new environment variable GLOBAL_S3_SECRET_KEY can be used to set an S3 secret key, used by the module when configured to use S3 for document storage (see File storage options for more information on this configuration)

Using this environment overrides the “S3 secret key” setting in the app and so can be used to avoid exposing the secret key in the FOLIO Settings UI

The “GLOBAL_S3_SECRET_KEY” environment variable should be set if it is preferred to make the secret key inaccessible via the FOLIO UI. This can be done at any time.

 

@Owen Stephens

Agreements Local KB

New boolean environment variable SYNC_PACKAGES_VIA_HARVEST. Defaults to false

This environment variable controls whether when using the Harvest method to get data from an external KB (specifically GOKb) whether packages are initially treated as “synchronising” (true) or “paused” (false - the default).

For “paused” packages the harvester will not update the package title list (PCIs) for the package.

For “synchronising” packages, the package title list will be updated.

The variable can be set at any time. The default behaviour will be observed if the variable is not set.

 

Changing the variable will only affect packages that are first harvested after the variable has been changed (i.e. does not affect existing packages)

@Owen Stephens

Search

 

Set action.auto_create_index = false OpenSearch cluster-level index settings.

 

It will prevent index creation with unexpected mappings because Index creation should be allowed only explicitly via mod-search (during re-index or enabling module for tenant)

RANCHER-2189: Set action.auto_create_index = false OpenSearch cluster-level index settingsClosed
@Pavlo Smahin

Circulation

New boolean environment variable ENABLE_FLOATING_COLLECTIONS; default false

To allow items to shift (“float”) between different locations depending on check-in location, this environment variable must be present and set to true

The variable can be set at any time.

 

CIRC-2136: Add support for floating collectionsClosed

Related content