[FOLIO-3215] SPIKE: Improved Reference data handling during upgrades PoC Created: 22/Jun/21  Updated: 24/Mar/23

Status: Open
Project: FOLIO
Components: None
Affects versions: None
Fix versions: None

Type: Story Priority: P3
Reporter: Craig McNally Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Issue links:
Relates
relates to RMB-873 TenantLoading Reference Data Upgrade Open
relates to UXPROD-3111 Improved management of reference data... Draft
Sprint:
Development Team: Core: Platform

 Description   

Overview

The objective of this spike is to create a proof of concept that will help evaluate the proposal for improved handling of reference data during upgrades. Ideally this work will exercise enough of the proposal to expose any pitfalls and provide insight into how much work it will be to implement this across the various FOLIO modules.

See the proposal on the wiki .

Approach

The PoC should be based on either:

  1. A brand new (PoC) module with one or more simple controlled vocabularies (can borrow something existing like materialTypes if that's easier)
  2. A fork of an existing module which has a reasonable controlled vocabulary, e.g. mod-inventory-storage. In this case it's not necessary to implement the proposal for ALL controlled vocabularies in the module.

Evaluation

The PoC will be evaluated by the Technical Council as well as the SysOps SIG. The evaluation will look at the following metrics:

  • Does the PoC exercise all of the use cases outlined in the proposal?
  • Is it clear to the system operator what's needs review?
  • Is it clear to the system operator what's is in conflict and needs to be resolved?
  • What is the perceived amount of effort required to implement the proposed solution across FOLIO modules with reference data?
  • Are there any challenges or concerns related to security, maintainability, extensibility, etc.?

Acceptance Criteria

The PoC must:

  • Be checked into the folio-org GitHub
  • Include sufficient documentation for the SysOps SIG to run/test the upgrade process
  • Be demonstrable to the Technical Council/SysOps SIG
  • Exercise the use cases outlined in the proposal

A wiki page should be created that documents:

  • Challenges/pitfals encountered and the solution(s) explored/implemented
  • Concerns about the approach, e.g. related to security, maintainability, extensibility, ease of implementation, etc.

Generated at Thu Feb 08 23:26:28 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.