0010-eureka

Owned by Craig McNally
Last updated: Dec 17, 2024
4 min read

Start Date

Oct 21, 2024

End Date

TBD

Contributors

@Craig McNally @VBar

Status

RFC Preparation

Summary

The Folio Eureka Platform (henceforth referred to as Eureka for brevity) represents the next generation of Folio’s architecture which allows the project to operate at enterprise scale and expand its solution space. It seeks to replace custom-developed core components found in the original Folio architecture, with feature-rich, best-of-class, specialized open-source components. The need for this has become critical as Folio has become widely adopted, and particularly in ever increasing numbers in complex configurations such as consortia and national libraries.

Motivation

It became increasingly clear that requirements imposed by some high-profile libraries adopting Folio were going to be very difficult, if not impossible to meet on the current platform.

Scope

This RFC is intended to cover all aspects of Eureka at a high level. This includes:

Detailed Explanation/Design

This is the bulk of the RFC.

Explain the proposal as though it were already implemented and you were teaching it to someone already familiar with Folio - foregoing unnecessary introductory material.

  • Get into the specifics including corner cases and plenty of examples.

  • Define any new terminology and named concepts

  • Fully explain the scope of the proposal: backend; frontend; full-stack.

  • Provide clear guidance as to how the proposal might be implemented.

  • Include any reference to any existing Folio Jira issues.

  • If appropriate, the use of diagrams and illustrations is encouraged.

  • Provide any assessment of the dependency impact of the proposed change; its interaction with other features is clear.

  • If possible describe how disruptive the change might be to the existing Folio development community.

  • Discuss how any breaking changes can be rolled out (migration guidance).

  • If applicable, provide sample code or pseudo-code, error messages, or deprecation warnings

  • Describe the impact on existing Folio documentation, guides and other reference materials.

New Components

The Eureka platform introduces several new components. These will need to undergo some evaluation process. However, there is insufficient time in the proposed timeline to use the standard TCR/New module evaluation process.

Deprecations

The following could be deprecated/archived once Eureka has been fully adopted and these components are no longer within the support period:

  • Okapi - Functionality has been delegated to various single-purpose components

    • folio-kong

    • folio-keycloak

    • folio-module-sidecar

    • mgr-tenants

    • mgr-applications

    • mgr-tenant-entitlements

    • mod-scheduler

    • mod-okapi-facade

  • mod-authtoken - Replaced by Keycloak/Sidecars

  • mod-login-saml - Replaced by Keycloak

  • mod-consortia - Replaced by mod-consortia-keycloak

  • mod-login - Replaced by mod-login-keycloak

  • mod-permission - Replaced by mod-roles-keycloak

    • Slightly different from the components above in that it’s included in app-platform-minimal. Mod-permissions is needed for migration APIs used when moving to the Eureka platform. After that, it’s no longer needed. So, we need to be sure everyone has fully adopted Eureka before removing it from app-platform-minimal along with the migration APIs.

Benefits

Risks and Drawbacks

Why should we not do this?

A genuine and thoughtful consideration to risks and drawbacks is essential for a well-rounded proposal.

Rationale and Alternatives

Why is this design the best in the space of possible designs? How does this design integrate (or not) into the existing architecture and practices in Folio?

What other designs have been considered and what is the rationale for not choosing them?

This section could also include prior art, that is, how other the same problem may have already been solved elsewhere.

Timing

We would like to get the Eureka platform formally approved and adopted by the Folio community for the Sunflower release.

Unresolved Questions

Optional, but suggested for first drafts. What parts of the design are still TBD?

What related issues do you consider out of scope for this RFC that could be addressed in the future independently of the solution that comes out of this RFC?

Keywords

Optional, but recommended, especially in cases where the RFC links to other documents. This should take the form of a simple comma-separated list of keywords/phrases