Skip to content

Latest commit

 

History

History
294 lines (252 loc) · 23.2 KB

release-v13.1.0.md

File metadata and controls

294 lines (252 loc) · 23.2 KB
Raw

Helm release notes

  1. GitHub issue: mojaloop/project#2528
  2. For breaking changes, please review the section #7 "Breaking Changes" below.
  3. Revisions:
Date Revision Description
2022-03-14 0 Release
2021-10-01 0 Initial draft

1. Maintenance updates

  1. Change endpoint types to line up with enums (#863)
  2. Added Helm Tests for Thirdparty Provisioning and Verification Collections (#2650)

2. New Features

  1. mojaloop/#2314: Add CGS default settlement test cases in testing toolkit test collection (testing-toolkit-test-cases/pull/#54, (testing-toolkit-test-cases/pull/#57)[mojaloop/testing-toolkit-test-cases#57], mojaloop/helm/pull/#458, closes mojaloop/#2314)
  2. mojaloop/#2505: als-subid-error-callback-endpoint-not-implemented (account-lookup-service/issues/#429), closes mojaloop/#2505)
  3. mojaloop/#2450: feat(thirdparty): add tp-api-svc and round out thirdparty sub-chart (helm/pull/#454, closes mojaloop/#2450)
  4. mojaloop/#2532: feat(thirdparty): add thirdparty support to mojaloop-simulator chart (helm/pull/#456, closes mojaloop/#2532)
  5. mojaloop/#2556: Implement patch notification for failure scenarios (following v1.1 update) (central-services-shared/pull/321, central-ledger/pull/874, ml-api-adapter/pull/492, closes mojaloop/#2556)
  6. Testing Toolkit:
    1. Moved object store init config to system config (ml-testing-toolkit/pull/189)
    2. Added labels functionality to test cases (ml-testing-toolkit/pull/193, ml-testing-toolkit-ui/pull/122, ml-testing-toolkit-ui/pull/123 and ml-testing-toolkit-ui/pull/124), closes mojaloop/#2161
    3. Added thirdparty-sdk outbound API (ml-testing-toolkit/pull/195), closes mojaloop/#2533
    4. New feature: Test cases definition report with grouping (ml-testing-toolkit/pull/196), closes mojaloop/#2348
    5. Callback rule updates to support patch notification test-scenarios (ml-testing-toolkit/pull/200), closes mojaloop/#2556 and mojaloop/#2676
  7. Added Timeout Configuration to the centralledger-handler-timeout chart, and associated values files
  8. mojaloop/#2589: Added resource versions configuration parameter for all outbound requests from sdk-scheme-adapter (sdk-scheme-adapter/pull/288, closes mojaloop/#2589)
  9. mojaloop/#2704: Core-services support for non-breaking backward API compatibility for PROTOCOL_VERSION configs (central-services-shared/pull/325, ml-api-adapter/pull/496, quoting-service/pull/295, account-lookup-service/pull/436, account-lookup-service/pull/438, quoting-service/pull/297, bulk-api-adapter/pull/74, bulk-api-adapter/pull/77, transaction-requests-service/pull/85, central-ledger/pull/884, testing-toolkit-test-cases/pull/66, closes mojaloop/#2704)

3. Bug Fixes

  1. mojaloop/#2522: cl-migration scripts should configure quoting tables to utf8 follow-up (central-ledger/issues/#865), closes mojaloop/#2522
  2. mojaloop/#2525: transfers are not being assigned to a settlementWindow on transfers version=1.1 (central-ledger/issues/#866), closes mojaloop/#2525
  3. mojaloop/#2527: transfers PUT callback on version=1.1 is not assigning destination headers correctly (ml-api-adapter/issues/#866), closes mojaloop/#2527
  4. mojaloop/#2549: sdk-scheme-adapter support for test currencies XXX, XTS revoked with use of api-snippets (api-snippets/pull/#115, sdk-scheme-adapter/pull/287, closes mojaloop/#2527)
  5. mojaloop/#2534: FSPIOP API version negotiation not handled - Account-lookup-service (account-lookup-service/pull/#430, account-lookup-service/pull/#432, closesmojaloop/#2534)
  6. mojaloop/#2535: FSPIOP API version negotiation not handled - Quoting-Service (quoting-service/pull/#289, quoting-service/pull/290, closes mojaloop/#2535)
  7. mojaloop/#2536: FSPIOP API version negotiation not handled - Transfers-service (ml-api-adapter/pull/#487, ml-api-adapter/pull/#490, closes mojaloop/#2536)
  8. mojaloop/#2537: FSPIOP API version negotiation not handled - Transaction-request-service (transaction-requests-service/pull/#80, closes mojaloop/#2537)
  9. mojaloop/#2538: FSPIOP API version negotiation not handled - Bulk-api-adapter (bulk-api-adapter/pull/#67, bulk-api-adapter/pull/#70, closesmojaloop/#2538)
  10. mojaloop/#2557: In error notification to Payer FSP, header for source having wrong value (ml-api-adapter/pull/#488, central-ledger/pull/#869, central-services-shared/pull/#316, closes mojaloop/#2557)
  11. mojaloop/#2574: SDK-Scheme-Adapter is not returning Party Sub-Id (mojaloop-simulator/pull/#120, closes mojaloop/#2574)
  12. mojaloop/#2584: bulk-api-adapter is unable to process requests with individualTransfers[].extensionLists (bulk-api-adapter/pull/69, closesmojaloop/#2584)
  13. mojaloop/#2585: bulk-api-adapter fails when extensionLists are not send in the POST /bulkTransfer requests (bulk-api-adapter/pull/69, object-store-lib/pull/35, closesmojaloop/#2585)
  14. mojaloop/#2697: Central-Ledger Fulfil Handler does not correctly invalidate requests with an incorrect/non-existent FSP-ID in the FSPIOP-Destination header (central-ledger/pull/874, closesmojaloop/#2697)
  15. mojaloop/#2719: POST Quotes fails when transactionId != transactionRequestId (central-ledger/pull/887, testing-toolkit-test-cases/pull/68, closes mojaloop/#2697)
  16. als-oracle-pathfinder fix: init and startup issues (als-oracle-pathfinder/pull/#61)
  17. Testing Toolkit:
    1. Fixed TLS connectivity in hosted mode (ml-testing-toolkit/pull/192), closes mojaloop/#1790
    2. Fixed fxapi callback map (ml-testing-toolkit/pull/194)
    3. Fixed stop button not working intermittently (ml-testing-toolkit-ui/pull/121), closes mojaloop/#2332
    4. Fixed fulfilment override issue when set in a callback-rules (ml-testing-toolkit/pull/202), closes mojaloop/#2696

4. Application versions

  1. ml-api-adapter: v11.1.6 -> v13.0.0
  2. central-ledger: v13.14.0 -> v13.16.1
  3. account-lookup-service: v11.7.7 -> v13.0.0
  4. quoting-service: 12.0.10 -> 14.0.0
  5. central-settlement: 13.4.1
  6. central-event-processor: v11.0.2
  7. bulk-api-adapter: 11.1.4 -> v13.0.1
  8. email-notifier: v11.0.2
  9. als-oracle-pathfinder: v11.0.0 -> v11.0.4
  10. transaction-requests-service: v13.0.0
  11. finance-portal-ui: v10.4.3
  12. finance-portal-backend-service: v15.0.2
  13. settlement-management: v11.0.0
  14. operator-settlement: v11.0.0
  15. event-sidecar: v11.0.1
  16. event-stream-processor: v11.0.0-snapshot
  17. simulator: v11.1.3
  18. mojaloop-simulator: v11.6.1
  19. sdk-scheme-adapter: v11.18.8 -> v11.18.11
  20. ml-testing-toolkit: v13.5.1 -> v14.0.4
  21. ml-testing-toolkit-ui: v13.5.2 -> v13.5.5
  22. auth-service: v11.11.1
  23. als-consent-service: v0.0.8
  24. thirdparty-api-svc: v11.21.0
  25. thirdparty-sdk: v11.55.1

5. Application release notes

  1. ml-api-adapter - https://github.com/mojaloop/ml-api-adapter/releases/tag/v13.0.0
  2. central-ledger - https://github.com/mojaloop/central-ledger/releases/tag/v13.16.1
  3. account-lookup-service - https://github.com/mojaloop/account-lookup-service/releases/tag/v13.0.0
  4. quoting-service - https://github.com/mojaloop/quoting-service/releases/tag/v14.0.0
  5. central-settlement- https://github.com/mojaloop/central-settlement/releases/tag/v13.4.1
  6. central-event-processor - https://github.com/mojaloop/central-event-processor/releases/tag/v11.0.2
  7. bulk-api-adapter - https://github.com/mojaloop/bulk-api-adapter/releases/tag/v13.0.1
  8. email-notifier - https://github.com/mojaloop/email-notifier/releases/tag/v12.0.2
  9. als-oracle-pathfinder - https://github.com/mojaloop/als-oracle-pathfinder/releases/tag/v11.0.4
  10. transaction-requests-service - https://github.com/mojaloop/transaction-requests-service/releases/tag/v13.0.0
  11. finance-portal-ui - https://github.com/mojaloop/finance-portal-ui/releases/tag/v10.4.3
  12. finance-portal-backend-service - https://github.com/mojaloop/finance-portal-backend-service/releases/tag/v15.0.2
  13. settlement-management - https://github.com/mojaloop/settlement-management/releases/tag/v11.0.0
  14. operator-settlement - https://github.com/mojaloop/operator-settlement/releases/tag/v11.0.0
  15. event-sidecar - https://github.com/mojaloop/event-sidecar/releases/tag/v11.0.1
  16. event-stream-processor - https://github.com/mojaloop/event-stream-processor/releases/v11.0.0-snapshot
  17. simulator - https://github.com/mojaloop/simulator/releases/tag/v11.1.3
  18. mojaloop-simulator - https://github.com/mojaloop/mojaloop-simulator/releases/tag/v11.6.1
  19. sdk-scheme-adapter - https://github.com/mojaloop/sdk-scheme-adapter/releases/tag/v11.18.11
  20. ml-testing-toolkit - https://github.com/mojaloop/ml-testing-toolkit/releases/tag/v14.0.4
  21. ml-testing-toolkit-ui - https://github.com/mojaloop/ml-testing-toolkit-ui/releases/tag/v13.5.5
  22. auth-service - https://github.com/mojaloop/auth-service/releases/tag/v11.11.1
  23. als-consent-service - https://github.com/mojaloop/als-consent-oracle/releases/tag/v0.0.8
  24. thirdparty-api-svc - https://github.com/mojaloop/thirdparty-api-svc/releases/tag/v11.21.0
  25. thirdparty-sdk-adapter - https://github.com/mojaloop/thirdparty-sdk/releases/tag/v11.55.1

6. Operational Chart versions

  1. EFK: v12.0.0
  2. Promfana: v11.0.0

7. Breaking changes

  1. Testing Toolkit - Moved TLS related configuration parameters from user config to system config (ml-testing-toolkit/releases/v14.0.0)

  2. Helm test jobs name ml-ttk-test-validation (and its associated configuration tag in the values.yaml) have been shortened to ml-ttk-test-val-gp and made more meaningful with the introduction of the Bulk-API-Adapter tests (ml-ttk-test-val-bulk). Ensure you update your Helm values config to match this change (i.e. rename ml-ttk-test-validation to ml-ttk-test-val-gp).

8. Upgrade notes

  1. Mojaloop-Simulator Rules path requires a $ prefix (Known Issue)

Take note that existing rules may not work without modifying the path to add a $ prefix. See the following link for more information: mojaloop/mojaloop-simulator#120 (comment).

  1. The following new environment variables are added to the Testing Toolkit default values:
  • acceptParties
  • acceptPartiesOld
  • acceptPartiesNotSupported
  • acceptParticipants
  • acceptParticipantsOld
  • acceptParticipantsNotSupported
  • acceptQuotes
  • acceptQuotesOld
  • acceptQuotesNotSupported
  • acceptTransfers
  • acceptTransfersOld
  • acceptTransfersNotSupported
  • acceptTransactionRequests
  • acceptTransactionRequestsOld
  • acceptTransactionRequestsNotSupported
  • acceptAuthorizations
  • acceptAuthorizationsOld
  • acceptAuthorizationsNotSupported
  • acceptBulkTransfers
  • acceptBulkTransfersOld
  • acceptBulkTransfersNotSupported
  • contentTypeTransfers
  • contentTypeTransfersOld
  • contentTypeTransfersNotSupported
  • contentTypeParties
  • contentTypePartiesOld
  • contentTypePartiesNotSupported
  • contentTypeParticipants
  • contentTypeParticipantsOld
  • contentTypeParticipantsNotSupported
  • contentTypeQuotes
  • contentTypeQuotesOld
  • contentTypeQuotesNotSupported
  • contentTypeTransactionRequests
  • contentTypeTransactionRequestsOld
  • contentTypeTransactionRequestsNotSupported
  • contentTypeAuthorizations
  • contentTypeAuthorizationsOld
  • contentTypeAuthorizationsNotSupported
  • contentBulkTransfers
  • contentBulkTransfersOld
  • contentBulkTransfersNotSupported
  • SIM3_NAME
  • SIM4_NAME
  • SIM3_MSISDN
  • SIM4_MSISDN
  • TESTFSP3_BACKEND_TESTAPI_URL
  • TESTFSP3_CALLBACK_URL
  • TESTFSP3_SDK_TESTAPI_URL
  • TESTFSP3_SDK_TESTAPI_WS_URL
  • TESTFSP4_BACKEND_TESTAPI_URL
  • TESTFSP4_CALLBACK_URL
  • TESTFSP4_SDK_TESTAPI_URL
  • TESTFSP4_SDK_TESTAPI_WS_URL
  • HOST_ORACLE_CONSENT
  • DFSPA_NAME
  • DFSPA_CB_FSPIOP
  • DFSPA_CB_THIRDPARTY
  • DFSPB_NAME
  • DFSPB_CB_FSPIOP
  • DFSPB_CB_THIRDPARTY
  • PISP_NAME
  • PISP_CB_FSPIOP
  • PISP_CB_THIRDPARTY
  • CENTRALAUTH_NAME
  • CENTRALAUTH_CB_FSPIOP
  • PISP_THIRDPARTY_SDK_OUTBOUND_URL
  • PISP_BACKEND_TESTAPI_URL
  • PISP_CALLBACK_URL
  • PISP_SDK_TESTAPI_URL
  • PISP_SDK_TESTAPI_WS_URL
  • DFSPA_BACKEND_TESTAPI_URL
  • DFSPA_CALLBACK_URL
  • DFSPA_SDK_TESTAPI_URL
  • DFSPA_SDK_TESTAPI_WS_URL
  • DFSPB_BACKEND_TESTAPI_URL
  • DFSPB_CALLBACK_URL
  • DFSPB_SDK_TESTAPI_URL
  • DFSPB_SDK_TESTAPI_WS_URL

  1. The following services now support configurable Content-Type and Accept Header validations and set header version when generating messages from the Switch:

    1. ml-api-adapter v13.0.0
    2. account-lookup-service - v13.0.0
    3. quoting-service - v14.0.0
    4. bulk-api-adapter - v13.0.0
    5. transaction-requests-service - v13.0.0

    This can be set by the PROTOCOL_VERSIONS configuration as follows in the default.json or via environmental variables:

     "PROTOCOL_VERSIONS": {
   "CONTENT": {
     "DEFAULT": "1.1", <-- used to set the header CONTENT version when generating messages from the *SWITCH*
     "VALIDATELIST": [ <-- used to validate incoming FSPIOP API requests/callbacks version within the CONTENT-TYPE headers
       "1.1",
       "1.0"
     ]
   },
   "ACCEPT": {
     "DEFAULT": "1", <-- used to set the header ACCEPT-TYPE version when generating messages from the *SWITCH*
     "VALIDATELIST": [ <-- used to validate incoming FSPIOP API requests/callbacks version within the ACCEPT headers
       "1",
       "1.0",
       "1.1"
     ]
   }
 },

    Note the above configuration is optional, as it will default to what is shown above if not overridden by a set configuration.

  2. Enabling Bulk and Thirdparty components

Refer to the deployment section in the helm/README.md for more information.

9. Testing notes

  1. It is recommended that all Mojaloop deployments are verified using the Mojaloop Testing Toolkit. More information can be found in the Mojaloop Deployment Guide.

  2. The testing-toolkit-test-cases' Golden Path collections expects:

  3. Simulators

    • We recommend using Testing Toolkit instead of Postman which is better suited for the async nature of the Mojaloop API specification (see above)
    • Mojaloop-Simulator is enabled by default (six instances used).
    • Ensure that correct Postman Scripts are used if you wish to test against the Mojaloop-Simulators:
    • Legacy Simulators are still required and deployed by default; disabling this will cause issues since there is Account Lookup directory mocking functionality in this service.

  4. This release has been tested against the following:

    • Kubernetes: v1.20.6
    • Nginx Ingress Controllers: 0.43.0
    • Testing Toolkit Test Cases: v13.1.0

  5. Thirdparty Testing Toolkit Test Collections are not repeatable. Please refer to the following issue for more information #2717 - Thirdparty TTK Test-Collection is not repeatable. It is possible to manually cleanup persistent data to re-run the test if required.

  6. Bulk API Helm Tests

Refer to the Testing Deployments section in the main README for detailed information on how to enable bulk-api-adapter tests.

  1. Thirdparty API Helm Tests

Refer to thirdparty/README.md#validating-and-testing-the-3p-api on how to enabled and execute Thirdparty verification tests.

10. Known Issues

  1. #2119 - Idempotency for duplicate quote request
  2. #2322 - Helm install failing with with "medium to large" release names
  3. #2352 - Mojaloop Helm support for Kubernetes 1.22
  4. #2448 - Nginx Ingress Controller v1.0.0 is incompatible with Mojaloop Helm v13.0.x releases
  5. #2317 - Mojaloop Helm deployments are not compatible when deployed to ARM-arch based hosts
  6. #2654 - Unstable GP tests for 13.1.0 Release Candidate
  7. #2717 - Thirdparty TTK Test-Collection is not repeatable

11. Contributors

  • Organizations: BMGF, CrossLake, ModusBox, Sybrin
  • Individuals: @elnyry-sam-k, @mdebarros, @vijayg10, @shashi165, @kleyow, @lewisdaly, @donaldbartlett

Note: companies are in alphabetical order, individuals are in no particular order.