[UXPROD-4641] Edge API improvements Created: 28/Dec/23  Updated: 31/Dec/23

Status: Open
Project: UX Product
Components: None
Affects versions: None
Fix versions: None

Type: New Feature Priority: P2
Reporter: Natalia Zaitseva Assignee: Craig McNally
Resolution: Unresolved Votes: 0
Labels: back-end, epam-eureka, eureka-phase4
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Issue links:
Defines
is defined by MGRENTITLE-7 PLACEHOLDER - mgr-tenant-entitlements... Open
is defined by MGRENTITLE-15 PLACEHOLDER - route edge API traffic ... Open
is defined by MODROLESKC-101 PLACEHOLDER - Update edge-* module de... Open
is defined by MODROLESKC-102 PLACEHOLDER - Implement edge API impr... Open
is defined by MODROLESKC-103 PLACEHOLDER - Implement edge API impr... Open
Back End Estimate: Medium < 5 days
Back End Estimator: Oleksii Kuzminov
Back-End Confidence factor: 100%
Development Team: Eureka

 Description   

In Phase 1 we determined that edge APIs will continue to work as-is, but there's room for improvement.  This feature aims to identify potential areas for improvements, investigate options, design, and finally implement.

Scope:

  • Operational concerns - Possibly defer
    • Rate limiting / Throttling 
      • Required for LoC, e.g. for Z39.50, possibly others too.
      • Still not sure if LoC requires only SRU, or if we need to support "traditional" z39.50...
    • Transaction logging
    • Observability 
      • Open telemetry?  New Relic?
      • Keep in mind there are multiple stacks - vertx/spring.  Also there are several non-http-based edge modules (SIP2, connexion, z39.50, etc.)
    • Should we put edge APIs behind Kong? 
      • Only if it makes things easier for us.  Note that not all edge APIs are HTTP-based, so this may not even be an option.
    • Should we use an NGINX reverse proxy in the edge module containers?  
      • This would help with several of these things, at least transaction logging and rate limiting, possibly more.
  • User/key mgmt 
    • Update edge-* module descriptors to specify institutional users w/ appropriate privs.

NOTE:  Need to touch base with Khalilah on requirements...  It could be that most of this can be deferred.

Source - F72847: Edge API improvements


Generated at Fri Feb 09 00:41:26 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.