From ae56f351a5f6dcaf7442a8b2b87c3355d56e93ea Mon Sep 17 00:00:00 2001 From: Venkatachalam Ganapathy Date: Tue, 3 Dec 2024 06:39:22 +0000 Subject: [PATCH] GITBOOK-1193: No subject --- SUMMARY.md | 2 +- g2p-bridge/releases/1.0.0.md | 2 -- g2p-bridge/releases/1.0.1.md | 55 ++++++++++++++++++++++++++++++++++++ 3 files changed, 56 insertions(+), 3 deletions(-) delete mode 100644 g2p-bridge/releases/1.0.0.md create mode 100644 g2p-bridge/releases/1.0.1.md diff --git a/SUMMARY.md b/SUMMARY.md index e124e7f0..df91ba9c 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -379,7 +379,7 @@ * [Tech Guides](g2p-bridge/tech-guides.md) * [User Guides](g2p-bridge/user-guides/README.md) * [Releases](g2p-bridge/releases/README.md) - * [1.0.0](g2p-bridge/releases/1.0.0.md) + * [1.0.1](g2p-bridge/releases/1.0.1.md) * [Utilities and Tools](utilities-and-tools/README.md) * [ODK](utilities-and-tools/odk-collection-app.md) * [📔 User Guides](utilities-and-tools/odk-collection-app/user-guides/README.md) diff --git a/g2p-bridge/releases/1.0.0.md b/g2p-bridge/releases/1.0.0.md deleted file mode 100644 index 3f205851..00000000 --- a/g2p-bridge/releases/1.0.0.md +++ /dev/null @@ -1,2 +0,0 @@ -# 1.0.0 - diff --git a/g2p-bridge/releases/1.0.1.md b/g2p-bridge/releases/1.0.1.md new file mode 100644 index 00000000..4805c11d --- /dev/null +++ b/g2p-bridge/releases/1.0.1.md @@ -0,0 +1,55 @@ +# 1.0.1 + +### Release version: 1.0.1 + +### Release date: 3rd December 2024 + +## Summary + +openg2p-g2p-bridge Release 1.0.1 represents a fully functional digital cash disbursement hub. This subsystem accepts disbursement payloads from upstream the PBMS (aka Program MIS) systems. It then interfaces with the downstream Sponsor Bank to initiate the corresponding payment requests. It also accepts account statement from the Sponsor Bank (account statement for the program funding account) and reconciles the payments and failures if any with the original disbursement requests. + +To demonstrate the end to end lifecycle of disbursments, this release also ships a Sponsor Bank simulator - called openg2p-g2p-bridge-example-bank. This simulator implements all the APIs expected from a Sponsor Bank. It also generates Account Statement in MT940 format. + +## Features of this release + +The g2p-bridge subsystem has the following microservices and libraries + +### openg2p-g2p-bridge + +#### openg2p-g2p-bridge-api + +1. Microservice - that implements all the APIs (incoming APIs from upstream PBMS/MIS systems, outgoing APIs into Sponsor Bank and incoming APIs from Sponsor Bank) + +#### openg2p-g2p-bridge-celery-beat-producers + +1. All processing in g2p-bridge is handled asynchronously. This asynchronous processing is orchestrated using Celery Beat producers. + +#### openg2p-g2p-bridge-celery-workers + +1. The beats produced by the aforementioned beat producers are processed by celery workers. This module implements the necessary workers. + +#### openg2p-g2p-bridge-models + +1. This is a library that contains the pydantic schemas and sqlalchemy models for the g2p-bridge subsystem + +#### openg2p-g2p-bridge-bank-connectors + +1. This library contains the interface definitions for connecting with the sponsor bank. It also contains an implementation of this interface, to connect with Example Bank. + +### openg2p-g2p-bridge-example-bank + +## Release contents + +
Release itemLinks
SPAR source code
Packaged dockers
Deployment
Testing
Documentation
+ +## Deploy + +To deploy this release on Kubernetes refer to the [deployment guide](../../spar/deployment/). + +## Limitations and known issues + +1. Release 1.0.0 has been tested with limited scale. Load testing and performance benchmarks are planned for Release 1.1.0 +2. REST API security for Mapper APIs (openg2p-spar-mapper-api) - While the self-service-apis are secured using Auth tokens (from OIDC-OAuth2.0 Login Providers), the mapper-apis will need a JWS Token based authorization for partner systems. This has been described [here](https://docs.openg2p.org/spar/privacy-and-security). +3. You can find the full list of Jira issues/backlogs [here](https://openg2p.atlassian.net/jira/software/projects/SSSIM/boards/6/backlog). + +