Skip to content

Commit

Permalink
GITBOOK-1198: No subject
Browse files Browse the repository at this point in the history
  • Loading branch information
venky-ganapathy authored and gitbook-bot committed Dec 3, 2024
1 parent 1451a22 commit 7d46fca
Showing 1 changed file with 20 additions and 8 deletions.
28 changes: 20 additions & 8 deletions g2p-bridge/releases/1.0.2.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,34 +26,46 @@ Microservice - that implements all the APIs (incoming APIs from upstream PBMS/MI

#### openg2p-g2p-bridge-celery-beat-producers

All processing in g2p-bridge is handled asynchronously. This asynchronous processing is orchestrated using Celery Beat producers.
Microservice - All processing in g2p-bridge is handled asynchronously. This asynchronous processing is orchestrated using Celery Beat producers.

#### openg2p-g2p-bridge-celery-workers

The beats produced by the aforementioned beat producers are processed by celery workers. This module implements the necessary workers.
Microservice - The beats produced by the aforementioned beat producers are processed by celery workers. This module implements the necessary workers.

#### openg2p-g2p-bridge-models

This is a library that contains the pydantic schemas and sqlalchemy models for the g2p-bridge subsystem
Library - This is a library that contains the pydantic schemas and sqlalchemy models for the g2p-bridge subsystem

#### openg2p-g2p-bridge-bank-connectors

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. Connecting with different sponsor banks during implementations will require custom connectors to be written - on the lines of Example Bank Connector.
Library - 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. Connecting with different sponsor banks during implementations will require custom connectors to be written - on the lines of Example Bank Connector.

### openg2p-g2p-bridge-example-bank

#### openg2p-g2p-bridge-example-bank-api

Microservice - This microservice implements the APIs expected from any Sponsor Bank. This is a Bank Simulator to facilitate end-to-end feature demonstrations of G2P Bridge. This microservice is not expected to be deployed in any Production environment.

#### openg2p-g2p-bridge-example-bank-celery

Microservice - Handles all asynchrononous processing in the Bank Simulator. It has both the components, viz the beat producers and the workers.

#### openg2p-g2p-bridge-example-bank-models

Library - Contains the Pydantic schemas and Sqlalchemy models for 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>
<table><thead><tr><th width="276">Release item</th><th>Links </th></tr></thead><tbody><tr><td>G2P Bridge Source Code<br>&#x26; Example Bank Source Code</td><td><ul><li>openg2p-g2p-bridge:v1.0.2</li><li>openg2p-g2p-bridge-example-bank:v1.0.2</li><li>openg2p-g2p-bridge-deployment:v1.0.2</li><li>openg2p-g2p-bridge-example-bank-deployment:v1.0.2</li><li>openg2p-g2p-bridge-test:v1.0.2</li></ul></td></tr><tr><td><strong>Packaged dockers</strong></td><td><ul><li>openg2p-g2p-bridge-api:v1.0.2</li><li>openg2p-g2p-bridge-celery-beat-producers:v1.0.2</li><li>openg2p-g2p-bridge-celery-workers:v1.0.2</li><li>openg2p-g2p-bridge-example-bank-api:v1.0.2</li><li>openg2p-g2p-bridge-example-bank-celery:v1.0.2</li></ul></td></tr><tr><td><strong>Deployment</strong></td><td><ul><li></li><li></li><li></li></ul></td></tr><tr><td><strong>Testing</strong></td><td><ul><li><p>Test coverage reports</p><ul><li></li><li></li></ul></li><li></li><li></li></ul></td></tr><tr><td><strong>Documentation</strong></td><td><ul><li><a href="https://docs.openg2p.org/g2p-bridge">G2P Bridge Documentation</a></li><li><p>API reference</p><ul><li><a href="https://openg2p.stoplight.io/docs/openg2p-g2p-bridge-api/b0fb6beb9cd7e-open-g2-p-g2-p-bridge-api">openg2p-g2p-bridge-api</a></li><li><a href="https://openg2p.stoplight.io/docs/g2p-bridge-example-bank-api/b0fb6beb9cd7e-example-bank-ap-is-for-cash-transfer">openg2p-g2p-bridge-example-bank-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).
1. Release 1.0.2 has been tested with limited scale. Load testing and performance benchmarks are planned for Release 1.1.0.
2. REST API security for Incoming APIs into openg2p-g2p-bridge-api needs JWT implementation as described [here](https://docs.openg2p.org/g2p-bridge/features/privacy-and-security). This is planned for Release 1.1.0.
3. REST API security for outgoing APIs in openg2p-g2p-bridge-celery-workers needs JWT implementation as described [here](https://docs.openg2p.org/g2p-bridge/features/privacy-and-security). This is planned for Release 1.1.0.

&#x20;

0 comments on commit 7d46fca

Please sign in to comment.