-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
2ee14fe
commit ae56f35
Showing
3 changed files
with
56 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
|
||
<table><thead><tr><th width="276">Release item</th><th>Links </th></tr></thead><tbody><tr><td><strong>SPAR source code</strong> </td><td><ul><li><a href="https://github.com/OpenG2P/openg2p-spar-mapper-api/releases/tag/v1.0.0">openg2p-spar-mapper-api:v1.0.0</a></li><li><a href="https://github.com/OpenG2P/openg2p-spar-self-service/releases/tag/v1.0.0">openg2p-spar-self-service:v1.0.0</a></li><li><a href="https://github.com/OpenG2P/openg2p-spar-self-service-ui/releases/tag/v1.0.0">openg2p-spar-self-service-ui:v1.0.0</a></li><li><a href="https://github.com/OpenG2P/openg2p-spar-deployment/releases/tag/v1.0.0">openg2p-spar-deployment:v1.0.0</a></li><li><a href="https://github.com/OpenG2P/openg2p-spar-mapper-test/releases/tag/v1.0.0">openg2p-spar-mapper-test:v1.0.0</a></li><li><a href="https://github.com/OpenG2P/openg2p-spar-self-service-test/releases/tag/v1.0.0">openg2p-spar-self-service-test:v1.0.0</a></li></ul></td></tr><tr><td><strong>Packaged dockers</strong></td><td><ul><li><a href="https://hub.docker.com/r/openg2p/openg2p-spar-mapper-api/tags">openg2p-spar-mapper-api:1.0.0</a></li><li><a href="https://hub.docker.com/r/openg2p/openg2p-spar-self-service-api/tags">openg2p-spar-self-service-api:1.0.0</a></li><li><a href="https://hub.docker.com/r/openg2p/openg2p-spar-self-service-ui">openg2p-spar-self-service-ui:1.0.0</a></li></ul></td></tr><tr><td><strong>Deployment</strong></td><td><ul><li><a href="https://github.com/OpenG2P/openg2p-spar-deployment/tree/v1.0.0/charts">Helm Charts</a></li><li><a href="https://github.com/OpenG2P/openg2p-spar-deployment/tree/v1.0.0/deployment">Deployment Scripts</a></li><li><a href="../../spar/deployment/">Deployment documentation</a></li></ul></td></tr><tr><td><strong>Testing</strong></td><td><ul><li><p>Test coverage reports</p><ul><li><a href="https://app.codecov.io/github/OpenG2P/openg2p-spar-mapper-api">openg2p-spar-mapper-api</a></li><li><a href="https://app.codecov.io/github/OpenG2P/openg2p-spar-self-service">openg2p-spar-self-service</a></li><li><a href="https://app.codecov.io/github/OpenG2P/openg2p-g2pconnect-common">openg2p-g2pconnect-common</a></li></ul></li><li><a href="https://drive.google.com/drive/folders/1fofKFfn7yMeDvsIVq-0btJOYaq4vC7VA">Test plans</a></li><li><a href="https://docs.google.com/spreadsheets/d/1tX9Vzp2N2XQEmpLjkzShAykEh9ZDA5zUc6SNbZxV1s8/edit#gid=0">Test reports</a></li></ul></td></tr><tr><td><strong>Documentation</strong></td><td><ul><li><a href="https://docs.openg2p.org/spar">SPAR Documentation</a></li><li><p>API reference</p><ul><li><a href="https://openg2p.stoplight.io/docs/openg2p-spar-mapper-api/b0fb6beb9cd7e-open-g2-p-spar-account-mapper">SPAR Mapper API</a></li><li><a href="https://openg2p.stoplight.io/docs/openg2p-spar-self-service-api/b0fb6beb9cd7e-spar-self-service-api">SPAR Self Service API</a></li></ul></li></ul></td></tr></tbody></table> | ||
|
||
## 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). | ||
|
||
  |