Draft report on adoption and timeline of the Eureka platform

Table of contents

Introduction

There is community momentum toward the Eureka environment, and it was extensively discussed in 2024. There will also be significant benefit from well coordinated migration to the new platform and quick consolidation on just one platform. EBSCO plans to shift their support from the Okapi-based FOLIO architecture to the Eureka-based FOLIO architecture in the Sunflower release. The FOLIO chairs recommend coordinating community resources to follow in EBSCO’s steps and transition to Eureka in Sunflower.

We ask that the councils affirm the community’s intention to shift to Eureka in Sunflower and focus on planning for the transition.

Assumptions

  • EBSCO will shift their support to the FOLIO Eureka architecture in Sunflower

  • The community is best served by being on a single architecture and by transitioning in a coordinated way

  • Existing roles like Index Data’s management of community dev ops will continue after the transition to Eureka

Timeline for community transition to Eureka

  • In Sunflower EBSCO will shift support from Okapi to Eureka.

  • In order for the community to transition to Eureka in Sunflower as well, these high level requirements/milestones should be met:

 

Requirement

Status

Requirement

Status

FOLIO community devops and hosting providers beyond EBSCO are confident in operating Eureka

Being addressed by hosting provider early adopter program

Define flower releases using Eureka based applications

  • Replaces the release branches (e.g. 2024 R2) of current platform-complete definitions

  • May use a different repository

    • May want to be consistent with how the Eureka based Rancher environments are being defined

Kitfox has patterns for reference builds to start from that can be adopted/updated by Index Data

Developer documentation for working in the Eureka platform

Existing documentation should be gathered and made findable. More effort may be needed here.

Hosted reference environments have been built using Eureka, which includes these steps:

  • Define environment configurations using Eureka based applications

    • Similar to above for flower releases, instead for the snapshot branch

  • Use Eureka based architecture

    • Including Keycloak, Kong, sidecars for module docker containers etc

  • Use Eureka management API to enable applications defined above

Addressed in part through the hosting providers early adopters program. Additionally, Kitfox has patterns for reference builds to start from that can be adopted/updated by Index Data

Architecture support given a transition in Sunflower:

The FOLIO support policy provides for support on the current release and one previous release. Therefore if the community transitions to the Eureka architecture in Sunflower, official support for Okapi will cease upon release of Trillium.

 

Quesnelia

Ramsons

Sunflower

Trillium

 

Quesnelia

Ramsons

Sunflower

Trillium

EBSCO Primary development platform

Okapi

Okapi

Eureka

Eureka

EBSCO Bugfixing for

Okapi and Eureka

Okapi and Eureka

Eureka

Eureka

Community Bugfixing for

Okapi and Eureka

Okapi and Eureka

Eureka

Eureka

Community Testing (bugfest) - EBSCO hosted

Okapi and Eureka

Okapi and Eureka

Eureka

Eureka

Support for CSPs (critical issues only)

Quesnelia/Okapi
Quesnelia/Eureka

Poppy/Okapi

Ramsons/Okapi
Ramsons/Eureka

Quesnelia/Okapi
Quesnelia/Eureka

Sunflower/Eureka

Ramsons/Okapi
Ramsons/Eureka

Trillium/Eureka

Sunflower/Eureka

Option

 

 

Running Sunflower modules
under Ramsons Okapi is
possible but not officially
supported.

Ramsons and Okapi support
ends on Trillium GA.

 

Possible next steps for councils to support the Sunflower timeframe

Next steps for community dev ops

  • Plan to work collaboratively with EBSCO teams in 2025 to build reference environments using Eureka and provide community support for Eureka adoption.

  • Gap analysis and further investigation

  • Need to figure out what is needed to retool

Next steps for hosts and implementers

  • Implementers participating in the early adopter end user program will

    • report their experiences and

    • request any changes or help they need if any.

  • Sysops SIG participants should continue to voice their needs for support to TC and EBSCO

Next steps for EBSCO

  • Continued knowledge transfer to community dev ops teams

  • Onboard additional hosts into early adopter program

Appendices

Eureka adopter support

Implications of Eureka adoption

What if the community does not transition to Eureka in Sunflower?

If the community were unable to shift to Eureka in Sunflower and must continue supporting the Okapi architecture these high level requirements will need to be met, we believe these needs exceed the community’s capacity:

  • Community support for an Okapi-based bugfest environment

  • Community support for Okapi-based CSPs

  • Community dev ops is able to prove the Ramsons release of Okapi will run Sunflower modules and perhaps modules from future releases as well

 

Architecture support if the community does not transition in Sunflower:

 

Quesnelia

Ramsons

Sunflower

Trillium

 

Quesnelia

Ramsons

Sunflower

Trillium

EBSCO Primary development platform

Okapi

Okapi

Eureka

Eureka

EBSCO Bugfixing for

Okapi and Eureka

Okapi and Eureka

Eureka

Eureka

Community Bugfixing for

Okapi and Eureka

Okapi and Eureka

Eureka

Okapi

Eureka

Okapi

Community Testing (bugfest) - EBSCO hosted

Okapi and Eureka

Okapi and Eureka

Eureka

Eureka

Community Testing (bugfest) - Community

NA

NA

Okapi

Okapi

Support for CSPs (critical issues only)

Quesnelia/Okapi
Quesnelia/Eureka

Poppy/Okapi

Ramsons/Okapi
Ramsons/Eureka

Quesnelia/Okapi
Quesnelia/Eureka

Sunflower/Eureka

Ramsons/Okapi
Ramsons/Eureka

Trillium/Eureka

Sunflower/Eureka

Trillium/Okapi

Sunflower/Okapi

Option

 

 

Running Sunflower modules
under Ramsons Okapi is
possible but not officially
supported.

Ramsons and Okapi support
ends on Trillium GA.