Draft report on adoption and timeline of the Eureka platform

Table of contents
Introduction
Timeline
Next steps for councils
Next steps for hosts and implementers
Next steps for EBSCO
Implications of Eureka adoption
Eureka adopter support

Introduction

The community has two key questions to answer:

• Does the community adopt Eureka?

There is significant 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. FOLIO will be moving to Eureka as its new platform, and away from Okapi, therefore:

• On what timeline does the community make Eureka the official FOLIO architecture release?

• On what timeline does the community stop supporting Okapi?

Timeline options 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:

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

  • Developer documentation for working in the Eureka platform

  • 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

  • Build hosted reference environments using Eureka

    • 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

• If the community is unable to shift to Eureka and must continue supporting the Okapi architecture these high level requirements will need to be met:

  • 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

• How long does the community support Okapi? Does the community shift from Okapi to Eureka in Sunflower? Will the councils affirm an intention to shift to Eureka in Sunflower?

Timeline if the community transitions in Sunflower:

Possible next steps for councils to support the Sunflower timeframe

• Technical council

  • Determine how to approve the large number of modules in time for Sunflower, or agree to approve as a package, or agree to exempt from approval: https://folio-org.atlassian.net/wiki/spaces/TC/pages/518946885/0010-eureka#New-Components

  • Update module approval processes to account for application formalization

  • Affirm with the sysops SIG and others that the early adopter program for hosting providers is on track

  • How does tech council affirm that community dev ops intends to be ready for Sunflower?

• Product council

  • Support SIGs and POs in implementation of application formalization

  • Ensure there is enough support for the user management SIG to allow implementers to effectively adopt the new permissions structure in Eureka

  • Work with end user early adopters to outline and document any other product/UX oriented changes from Eureka

• Community council

  • Evaluate any budgetary needs for meeting the Sunflower deadline and whether or not they are feasible

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

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

Implications of Eureka adoption

• Changes

  • Move from module based platform to application-based platform

  • 0005-application-formalization

  • 0010-eureka

  • Change in maintenance through deprecation of homegrown modules:https://folio-org.atlassian.net/wiki/spaces/TC/pages/518946885/0010-eureka#Deprecations

• Benefits

  • https://folio-org.atlassian.net/wiki/spaces/TC/pages/518946885/0010-eureka#Benefits

• Challenges

  • Uncertainty of non-FSE providers ability to adopt for Sunflower

  • Incomplete documentation

  • RFC process not completed

Eureka adopter support

• Existing support

  • End-user early adopter program has begun (private slack channel #eureka-early-adopters)

  • Some documentation exists on the Wiki: Eureka - How to ...

  • Docker-based minimal eureka platform: https://github.com/folio-org/eureka-platform-bootstrap

  • CLI for local deployment: https://github.com/folio-org/eureka-setup

  • Reference environments (links, schedule)

• Planned support

  • Hosting early adopter program will begin in January 2025 with GBV and potentially others

• Gaps in support

  • Additional operational and development support will be needed