Skip to content

Latest commit

 

History

History
184 lines (140 loc) · 17.7 KB

release-v15.1.0.md

File metadata and controls

184 lines (140 loc) · 17.7 KB
Raw

Helm Release Notes

Date Revision Description
2023-06-08 0 Initial draft
2023-06-21 1 Initial release
  • For BREAKING CHANGES, please review the section #5 "Breaking Changes" below.
  • For KNOWN ISSUES, please review the section #8 "Known Issues" below.

0. Summary

Minor enhancements for v15.0.0 Release, which includes the following changes:

  1. Account Lookup Service & Transaction Request Service updated to support test ISO currencies: XTS, XXX
  2. CronJob for cleanup scripts to ensure that liquidity is reset. This should allow daily cron-jobs to run indefinitely.
  3. SDK Scheme Adapter support for non-auth based Request-To-Pay scenarios has been enhanced and closely aligned to the FSPIOP v1.1 Specification, with Helm tests added to verify this functionality. Ensure you enable them by configuring the following mojaloop/values.yaml values if required:
    1. mojaloop-ttk-simulators.enabled=true - Enable Mojaloop Testing Toolkit based simulators required to execute the tests.
    2. ml-ttk-test-val-sdk-r2p.tests.enabled=true - Enable SDK Request To Pay Helm test.
  4. Some additional quality of life improvements have been made to the Helm Tests and CronJobs:
    1. Helm Tests now support allowFailures configuration, this allows the TTK CLI Test Runner to return failure exit-codes to the terminal:
      • By default this is false - which means that any consecutive Helm tests will not be executed by Helm.
      • If this is set to true - it will allow the next consecutive Helm test to be executed regardless of any failures.
    2. The following configuration values have now been parameterized: restartPolicy, backoffLimit - see here.
    3. The following configuration values have been added to CronJobs:
      1. successfulJobsHistoryLimit, and failedJobsHistoryLimit - see here.
      2. suspend - see here.
      3. timeZone - see here.
    4. Moved command arguments to parameterized script value configuration to allow for override.
  5. Testing-Toolkit improvements
    1. Now supports "No Callback" rules, which has allowed us to replace the legacy-simulator for noresponsepayeefsp test-cases with the Testing-Toolkit. Note that we still require the legacy-simulator for the simulated oracle.
    2. Configurable Payer name in Mobile Simulator, which is useful for demo purposes.

Refer to full feature and bug fix list below for more info; and testing improvements listed separately.

1. New Features

  1. mojaloop/#2740 add testing currency codes and update codeowners (account-lookup-service/pull/450, transaction-requests-service/pull/92), closes mojaloop/#2740
  2. mojaloop/#3361 [Helm] Add CRON Job to reset liquidity (helm/pull/569), closes mojaloop/#3361
  3. mojaloop/#3344 [SDK-Scheme-Adapter] Enhance SDK Scheme Adaptor to support the request to Pay use case(sdk-scheme-adapter/pull/442, sdk-scheme-adapter/pull/446), epic mojaloop/#3344
    1. feat(mojaloop/#3345): Extend Payee requestToPay API process to support the validation of the payer details , closes mojaloop/#3345
    2. feat(mojaloop/#3347): Enhance the requestToPayTransfer API process for Payer Acceptance flow, closes mojaloop/#3347
  4. mojaloop/#3176 [Testing-Toolkit] add option for no callback in callback/validation rules (ml-testing-toolkit-ui/issues/176) (b783a92), closes mojaloop/#3176
  5. [Testing-Toolkit] configurable payer name in mobilesim (ml-testing-toolkit-ui/issues/176)

2. Bug Fixes

  1. mojaloop/#3285 [SDK-Scheme-Adapter] /requestToPay is failing at validation (sdk-scheme-adapter/pull/442), closes mojaloop/#3285
  2. mojaloop/#3382 [SDK-Scheme-Adapter] Sdk-Scheme-Adapter config.transactionRequestsEndpoint is not being set correctly (sdk-scheme-adapter/pull/451), closes mojaloop/#3382

3. Application versions

  1. ml-api-adapter: v14.0.0
  2. central-ledger: v17.0.3
  3. account-lookup-service: 14.0.0 -> v14.1.0 (Compare)
  4. quoting-service: v15.0.2
  5. central-settlement: v15.0.0
  6. bulk-api-adapter: v15.0.3
  7. central-event-processor: v12.0.0 (Refer to section 5. BREAKING CHANGES)
  8. email-notifier: v12.0.0 (Refer to section 5. BREAKING CHANGES)
  9. als-oracle-pathfinder: v12.0.0
  10. transaction-requests-service: v14.0.1 -> v14.1.0 (Compare)
  11. finance-portal-ui: v10.4.3 (DEPRECATED)
  12. finance-portal-backend-service: v15.0.2 (DEPRECATED)
  13. settlement-management: v11.0.0 (DEPRECATED)
  14. operator-settlement: v11.0.0 (DEPRECATED)
  15. event-sidecar: v12.0.0
  16. event-stream-processor: v12.0.0-snapshot.7
  17. simulator: 12.0.0
  18. mojaloop-simulator: v14.0.1
  19. sdk-scheme-adapter: v22.0.1 -> v23.0.1 (Compare)
  20. ml-testing-toolkit: v16.1.1
  21. ml-testing-toolkit-ui: v15.3.0 -> v15.4.0 (Compare)
  22. ml-testing-toolkit-client-lib: v1.2.0
  23. auth-service: v14.0.0
  24. als-consent-oracle: v0.2.0
  25. thirdparty-api-svc: v13.0.2
  26. thirdparty-sdk: v15.1.0

4. API Versions

This release supports the following versions of the Mojaloop family of APIs:

API Supported Versions Notes
FSPIOP v1.1, v1.0
Settlements v2.0
Admin v1.0
Oracle v1.0
Thirdparty v1.0

5. Breaking changes

N/A

6. Deprecations

The following components have been deprecated from the packaged Mojaloop Helm chart release and have been with Business Operation Framework (BOF), which can be deployed by the official BoF Helm Chart:

Note these Helm Chart are still available for deployment in the Mojaloop Helm Repo (http://mojaloop.io/helm/repo/).

This is due to the underlying services having been deprecated by the Micro-Services provided by the Business Operation Framework (BOF) for Financial Management and Reporting.

More information can be found here:

BOF Helm charts to deploy the Business Operation Framework can be found here:

7. Testing notes

  1. This release has been validated against the following Dependency Test Matrix:

    Dependency Version Notes
    Kubernetes v1.27.1 AWS EKS, AWS EKS Supported Version Notes
    containerd v1.6.19
    Nginx Ingress Controller helm-ingress-nginx-4.7.0 / ingress-controller-v1.8.0
    Amazon Linux v2
    MySQL bitnami/mysql:8.0.32-debian-11-r0
    Kafka bitnami/kafka:3.3.1-debian-11-r1
    Redis bitnami/redis:7.0.5-debian-11-r7
    MongoDB bitnami/mongodb:6.0.2-debian-11-r11
    Testing Toolkit Test Cases v15.1.0
    example-mojaloop-backend v15.0.0 README

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

  3. The testing-toolkit-test-cases (See above Dependency Test Matrix for exact version required for this release) Golden Path collections expects:

    • the Quoting service operating mode to be set quoting-service.config.simple_routing_mode_enabled=true (in helm mojaloop/values.yaml under quoting-service config). If this is incorrectly configured, it will result in several failures in the quoting-service tests (7 expected failures). If this is disabled, ensure that you update the corresponding test-case environment variable parameter SIMPLE_ROUTING_MODE_ENABLED ( in helm mojaloop/values.yaml ml-testing-toolkit -> extraEnvironments.hub-k8s-default-environment.json.inputValues) to match.
    • the on-us transfers (in mojaloop/values.yaml "enable_on_us_transfers: false" under centralledger-handler-transfer-prepare -> config and cl-handler-bulk-transfer-prepare -> config) configuration to be disabled. The test-case environment variable parameter (ON_US_TRANSFERS_ENABLED (in helm mojaloop/values.yaml ml-testing-toolkit -> extraEnvironments.hub-k8s-default-environment.json.inputValues), the same name used on postman collections) must similarly match this value.

  4. 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 for single transfers usually and three more specific to bulk).
    • 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.

  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.

  7. Thirdparty API Helm Tests

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

  8. Testing the new Bulk functionality (sdk-scheme-adapter)

    For details regarding deployment and validation of simulators needed for bulk (for adoption provided in sdk-scheme-adapter) refer to deploying Mojaloop TTK simulators.

8. Known Issues

  1. #2119 - Idempotency for duplicate quote request
  2. #2322 - Helm install failing with with "medium to large" release names
  3. #2317 - Mojaloop Helm deployments are not compatible when deployed to ARM-arch based hosts
  4. #2892 - Disabled DFSP showing getParty info
  5. #2435 - Quoting-Service is incorrectly handling failed responses to FSPs when forwarding requests
  6. Test issues causing instability/intermitant failures on Test Case Results
    1. #2717 - Thirdparty TTK Test-Collection is not repeatable
    2. #2845 - QA: Replace Legacy-Simulator as a NORESPONSE_SIMPAYEE in Testing-Toolkit Goden Path Test-Suite
    3. #3027 - QA: Mojaloop Helm v14.1.0 Release - Bulk Tests fail on first run
    4. #2925 - Helm Test Intermittent failure with 'Generic ID not found
    5. #3164 - GP Tests fail intermitantly when upgrading a release from v14.1.1 to v15 due to WS issues between TTK and SDKs

9. Contributors

  • Organizations: BMGF, InFiTX
  • Individuals: @chris-me-law , @dfry , @elnyry-sam-k , @PaulGregoryBaker , @mdebarros , @vijayg10

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