ADR: Deprecate Ingestion Framework for R3

Status

  • Proposed
  • Trialing
  • Under Review
  • Approved
  • Retired

Context

  • Currently, the Ingestion Framework is only leveraged by the manifest ingestion workflow
  • In previous versions of the Ingestion Framework, pre-pass validation occurred
  • In the current version, pre-pass validation is moved to the manifest ingestion DAG workflow
  • The Ingestion Framework is now a passthrough to the Workflow Service that initiates the manifest ingestion workflow
  • No additional operations are performed by the Ingestion Framework

Scope

  • For the purposes of R3, deprecate the Ingestion Framework endpoints
  • Remove the tests from the automated testing process to prevent Ingestion Framework failures from reflecting against R3
  • OSDU Platform implementers can keep the Ingestion Framework in place if they desire, but it will not be a part of the official Release 3 implementation

Decision

  • To deprecate the Ingestion Framework API endpoints for R3
  • Remove test cases from automated testing for the Ingestion Framework

Rationale

  • Lack of meaningful functionality within the Ingestion Framework should take it out of the critical path for Release 3

Consequences

  • Any existing services or postman collections that leverage the Ingestion Framework endpoints may only work on some implementations
  • Any code that leverages the Ingestion Framework to initiate a manifest ingestion workflow will need to switch to leverage the Workflow Service