-
Notifications
You must be signed in to change notification settings - Fork 61
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(mojaloop/3000): merge master branch into mvp-bulk (#518)
* feat(mojaloop/#2352): update and standardise helm charts to use networking v1 (#508) feat(mojaloop/#2352): update and standardise helm charts to use networking v1 - mojaloop/project#2352 # Notes This PR is re-created from #506 which includes some fixes based on tests on k8s v1.24 # Changes: ## Update the Chart.yaml's and standardise all charts to helm v3 (API v2) - move any dependencies in the requirements.yaml to Charts.yaml - update the apiVersion for helm in all the Charts.yaml to 2.0 - add the common dependency to each chart that already has an ingress - remove all requirements.lock - update maintainers in chart.yaml to include tomd@crosslaketech.com - bump chart versions ## Update the ingress and networking API to v1 and standardise where possible - if the chart has an ingress template the chart is not on the exclusion list (see below) => the ingress template is updated to be a clone of the bitnami example (a version of what already exists in the charts repo) - updates the values files for the new ingress settings - ensure the updated values files have the correct hostname for the ingress - checks for paths and extra paths correctly allowed for (i.e. all charts with extraPaths or extraHosts are on e - ensure the updated values files have the correct port number for the ingress - update config/default.json files for values.ingress.api.host or similar to use .Values.ingress.hostname - _helper.tpl's updated to use correct ingress APIs and remove redundant ingress logic and templates ## General Maintenance - Fixed lint issue - Removed forensicloggingsidecar, centralenduserregistry, kube-system from lint scripts since they are no longer supported - Updated Maintainers list for each chart ## Exclusion list of charts - i.e. these charts are not yet standardised to the new ingress modeled on the bitnami example : - Any existing ingress in these charts has been updated "in place" rather than replaced with the newer standardised bitnami modeled chart. - So the ingress.yaml, config/*json, _helper.tpls , values.yaml files etc have been updated to use the latest ingress but they remain non-standard compared to the rest of the code-base. - "finance-portal-settlement-management", - "finance-portal", - ~"thirdparty"~, - ~"thirdparty/chart-tp-api-svc"~, - ~"thirdparty/chart-consent-oracle"~, - ~"thirdparty/chart-auth-svc"~, - ~"mojaloop-simulator"~, - "keycloak", - "monitoring", - "monitoring/promfana", - "monitoring/elk", - "ml-testing-toolkit/chart-keycloak", - "ml-testing-toolkit/chart-backend", - "ml-testing-toolkit/chart-frontend", - "ml-testing-toolkit/chart-connection-manager-backend", - "ml-testing-toolkit/chart-connection-manager-frontend" Co-authored-by: tdaly61 <tdaly61@gmail.com> Co-authored-by: Sam <10507686+elnyry-sam-k@users.noreply.github.com> * fix: als-admin api ingress service port (#511) - fixed als-admin api ingress service port from 4002 to 4001 - fixed formatting issues in for protocol_versions configs * fix(mojaloop/2995): update ttk-ui (#512) * chore: bumped up ttk-ui * chore: some change in appversion * fix: als-admin api ingress service port (#513) - fixed als api ingress service port fix from 4002/4001 to 80 - fixed formatting issues in for protocol_versions configs * chore: updated TTK and fixed some values * feat: added example backend chart for mojaloop (#517) feat: added example backend chart for mojaloop (#517) - mojaloop/project#3000 - updated mojaloop/values.yaml to include CONFIG section with YAML Anchor variables to make configurations easier - added example-mojaloop-backend for external backend dependencies to enable deployments on Kubernetes v1.22+ - updated shell helper scripts to include example-mojaloop-backend charts - updates CI config to add helm dependency repos and updated readme Co-authored-by: Miguel de Barros <miguel@debarros.me> * updates to chart appVersion description * fix: changed the default jws file path in sdk helm chart * fix: sdk helm values Co-authored-by: Miguel de Barros <miguel@debarros.me> Co-authored-by: tdaly61 <tdaly61@gmail.com> Co-authored-by: Sam <10507686+elnyry-sam-k@users.noreply.github.com>
- Loading branch information
4 people
authored
Nov 9, 2022
1 parent
e30bc3f
commit 135e523
Showing
268 changed files
with
11,030 additions
and
5,856 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 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,159 @@ | ||
| # Helm Release Notes | ||
|
|
||
| Date | Revision | Description | ||
| ---------|----------|--------- | ||
| 2022-10-18 | 0 | Initial draft | ||
|
|
||
| - For *BREAKING CHANGES*, please review the section `#5` "Breaking Changes" below. | ||
| - For *KNOWN ISSUES*, please review the section `#8` "Known Issues" below. | ||
|
|
||
| ## 1. New Features | ||
|
|
||
| 1. **mojaloop/#2352:** Mojaloop Helm support for Kubernetes networking.k8s.io/v1 (Ingress) ([mojaloop/helm/pull/#508](https://github.com/mojaloop/helm/pull/508)), closes [mojaloop/#2352](https://github.com/mojaloop/project/issues/2352) | ||
|
|
||
| ## 2. Bug Fixes | ||
|
|
||
| N/A | ||
|
|
||
| ## 3. Application versions | ||
|
|
||
| 1. ml-api-adapter: v13.0.0 -> **v14.0.0** | ||
| 2. central-ledger: v13.16.1 -> **v15.1.2.1** | ||
| 3. account-lookup-service: v13.0.0 -> **v14.0.0** | ||
| 4. quoting-service: v14.0.0 -> **15.0.2** | ||
| 5. central-settlement: 13.4.1 -> **v15.0.0** | ||
| 6. central-event-processor: v11.0.2 -> **v12.0.0** | ||
| 7. bulk-api-adapter: v13.0.1 -> **v14.0.0** | ||
| 8. email-notifier: v11.0.2 -> **v12.0.0** | ||
| 9. als-oracle-pathfinder: v11.0.4 -> **v12.0.0** | ||
| 10. transaction-requests-service: v13.0.0 -> **v14.0.1** | ||
| 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: v11.0.0-snapshot -> **v12.0.0-snapshot.7** | ||
| 17. simulator: 12.0.0 -> **v12.0.0** | ||
| 18. mojaloop-simulator: v12.1.1 -> **v13.0.1** | ||
| 19. sdk-scheme-adapter: v11.18.11 -> **v21.1.0** | ||
| 20. ml-testing-toolkit: v14.0.4 -> **v15.2.0** | ||
| 21. ml-testing-toolkit-ui: v13.5.5 -> **v15.0.1** | ||
| 22. ml-testing-toolkit-client-lib: **v1.0.0** | ||
| 23. auth-service: v11.11.1 -> **v13.0.2** | ||
| 24. als-consent-service: v0.0.8 -> **v0.2.0** | ||
| 25. thirdparty-api-svc: v11.21.0 -> **v13.0.2** | ||
| 26. thirdparty-sdk: v11.55.1 -> **v15.1.0** | ||
|
|
||
| ## 4. Application release notes | ||
|
|
||
| 1. ml-api-adapter - https://github.com/mojaloop/ml-api-adapter/releases/tag/v14.0.0 | ||
| 2. central-ledger - https://github.com/mojaloop/central-ledger/releases/tag/v15.1.0 | ||
| 3. account-lookup-service - https://github.com/mojaloop/account-lookup-service/releases/tag/v14.0.0 | ||
| 4. quoting-service - https://github.com/mojaloop/quoting-service/releases/tag/v15.0.2 | ||
| 5. central-settlement- https://github.com/mojaloop/central-settlement/releases/tag/v15.0.0 | ||
| 6. central-event-processor - https://github.com/mojaloop/central-event-processor/releases/tag/v12.0.0 | ||
| 7. bulk-api-adapter - https://github.com/mojaloop/bulk-api-adapter/releases/tag/v14.0.0 | ||
| 8. email-notifier - https://github.com/mojaloop/email-notifier/releases/tag/v12.0.0 | ||
| 9. als-oracle-pathfinder - https://github.com/mojaloop/als-oracle-pathfinder/releases/tag/v12.0.0 | ||
| 10. transaction-requests-service - https://github.com/mojaloop/transaction-requests-service/releases/tag/v14.0.1 | ||
| 11. finance-portal-ui _(DEPRECATED)_ - https://github.com/mojaloop/finance-portal-ui/releases/tag/v10.4.3 | ||
| 12. finance-portal-backend-service _(DEPRECATED)_ - https://github.com/mojaloop/finance-portal-backend-service/releases/tag/v15.0.2 | ||
| 13. settlement-management _(DEPRECATED)_ - https://github.com/mojaloop/settlement-management/releases/tag/v11.0.0 | ||
| 14. operator-settlement _(DEPRECATED)_ - https://github.com/mojaloop/operator-settlement/releases/tag/v11.0.0 | ||
| 15. event-sidecar - https://github.com/mojaloop/event-sidecar/releases/tag/v12.0.0 | ||
| 16. event-stream-processor - https://github.com/mojaloop/event-stream-processor/releases/v12.0.0-snapshot.7 | ||
| 17. simulator - https://github.com/mojaloop/simulator/releases/tag/v12.0.0 | ||
| 18. mojaloop-simulator - https://github.com/mojaloop/mojaloop-simulator/releases/tag/v13.0.1 | ||
| 19. sdk-scheme-adapter - https://github.com/mojaloop/sdk-scheme-adapter/releases/tag/v21.1.0 | ||
| 20. ml-testing-toolkit - https://github.com/mojaloop/ml-testing-toolkit/releases/tag/v15.2.0 | ||
| 21. ml-testing-toolkit-ui - https://github.com/mojaloop/ml-testing-toolkit-ui/releases/tag/v15.0.1 | ||
| 22. ml-testing-toolkit-client-lib - https://github.com/mojaloop/ml-testing-toolkit-client-lib/releases/tag/v1.0.0 | ||
| 23. auth-service - https://github.com/mojaloop/auth-service/releases/tag/v13.0.2 | ||
| 24. als-consent-service - https://github.com/mojaloop/als-consent-oracle/releases/tag/v0.2.0 | ||
| 25. thirdparty-api-svc - https://github.com/mojaloop/thirdparty-api-svc/releases/tag/v13.0.2 | ||
| 26. thirdparty-sdk-adapter - https://github.com/mojaloop/thirdparty-sdk/releases/tag/v15.1.0 | ||
|
|
||
| ## 5. Breaking changes | ||
|
|
||
| 1. Mojaloop Helm Chart Ingress's have been refactored to support Kubernetes networking.k8s.io/v1 as part of [mojaloop/#2352](https://github.com/mojaloop/project/issues/2352). This means that Mojaloop v14.1.0 Helm release should support Kubernetes versions v1.22 onwards, however keep in mind that we have only tested this release with the current supported Kubernetes version v1.24. | ||
|
|
||
| What is the impact from v14.0.0? | ||
|
|
||
| 1. Ingress Configs have changed. Please compare the Ingress values in [mojaloop/values.yaml](../mojaloop/values.yaml) configs to your customized config to see what changes are required. | ||
| 2. Upgrades are supported from v14.0.0 to this release (v14.1.0), but ensure your Ingress configurations have been updated to reflect the above changes. | ||
| 3. Take note that this change is part of a wider initiative to improve the maintainability of the Mojaloop Helm Charts and to support current Kubernetes versions. The next story as part of this initiative is to remove the external backend dependencies from the next Mojaloop Helm Release as part of [mojaloop/#2887](https://github.com/mojaloop/project/issues/2887). | ||
|
|
||
| ## 6. Deprecations | ||
|
|
||
| The following components are being deprecated from the packaged Mojaloop Helm chart release: | ||
|
|
||
| - [finance-portal](https://github.com/mojaloop/helm/tree/master/finance-portal) Helm Chart | ||
| - [finance-portal-ui](https://github.com/mojaloop/finance-portal-ui/releases/tag/v10.4.3) | ||
| - [finance-portal-backend-service](https://github.com/mojaloop/finance-portal-backend-service/releases/tag/v15.0.2) | ||
| - [finance-portal-settlement-management](https://github.com/mojaloop/helm/tree/master/finance-portal-settlement-management) Helm Chart | ||
| - [settlement-management](https://github.com/mojaloop/settlement-management/releases/tag/v11.0.0) | ||
| - [operator-settlement](https://github.com/mojaloop/operator-settlement/releases/tag/v11.0.0) | ||
|
|
||
| > _Note these Helm Chart are still available for deployment in the [Mojaloop Helm Repo (http://mojaloop.io/helm/repo/)](http://mojaloop.io/helm/repo/index.yaml)._ | ||
| This is due to the underlying services having been deprecated by the Micro-Services provided by the [Business Operation Framework (BOF)](https://github.com/mojaloop/business-operations-framework-docs) for Financial Management and Reporting. | ||
|
|
||
| More information can be found here: | ||
|
|
||
| - https://github.com/mojaloop/business-operations-framework-docs. | ||
|
|
||
| [BOF Helm charts](https://github.com/mojaloop/charts/tree/master/mojaloop/bof) to deploy the [Business Operation Framework](https://github.com/mojaloop/business-operations-framework-docs) can be found here: | ||
|
|
||
| - https://github.com/mojaloop/charts/tree/master/mojaloop/bof | ||
|
|
||
| ## 7. Testing notes | ||
|
|
||
| 1. This release has been tested against the following: | ||
| - Kubernetes: `v1.24.6` | ||
| - Nginx Ingress Controllers: `registry.k8s.io/ingress-nginx/controller:v1.4.0@sha256:34ee929b111ffc7aa426ffd409af44da48e5a0eea1eb2207994d9e0c0882d143` | ||
| - Testing Toolkit Test Cases: [v14.0.0.1](https://github.com/mojaloop/testing-toolkit-test-cases/releases/tag/v14.0.0.1) | ||
|
|
||
| 2. It is recommended that all Mojaloop deployments are verified using the [Mojaloop Testing Toolkit](https://docs.mojaloop.io/documentation/mojaloop-technical-overview/ml-testing-toolkit/). More information can be found in the [Mojaloop Deployment Guide](https://docs.mojaloop.io/documentation/deployment-guide). | ||
|
|
||
| 3. The [testing-toolkit-test-cases](https://github.com/mojaloop/testing-toolkit-test-cases/releases/tag/v14.0.0.1)' Golden Path collections expects: | ||
| - the Quoting service operating mode to be set [quoting-service.config.simple_routing_mode_enabled=true](https://github.com/mojaloop/helm/blob/v13.1.0/mojaloop/values.yaml#L4664). 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](https://github.com/mojaloop/helm/blob/v14.0.0/mojaloop/values.yaml#L7420) to match. | ||
| - the [on-us transfers](https://github.com/mojaloop/helm/blob/v14.0.0/mojaloop/values.yaml#L321) configuration to be disabled. The test-case environment variable parameter ([ON_US_TRANSFERS_ENABLED](https://github.com/mojaloop/helm/blob/v14.0.0/mojaloop/values.yaml#L7423), 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](https://github.com/mojaloop/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: | ||
| - Setup Mojaloop Hub: [MojaloopHub_Setup](https://github.com/mojaloop/postman/blob/v12.0.0/MojaloopHub_Setup.postman_collection.json) | ||
| - Setup Mojaloop Simulators for testing : [MojaloopSims_Onboarding](https://github.com/mojaloop/postman/blob/v12.0.0/MojaloopSims_Onboarding.postman_collection.json) | ||
| - Golden path tests: [Golden_Path_Mojaloop](https://github.com/mojaloop/postman/blob/v12.0.0/Golden_Path_Mojaloop.postman_collection.json) | ||
| - 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](https://github.com/mojaloop/project/issues/2717). 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](../README.md#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](../thirdparty/README.md#validating-and-testing-the-3p-api) on how to enabled and execute Thirdparty verification tests. | ||
|
|
||
| ## 8. Known Issues | ||
|
|
||
| 1. [#2119 - Idempotency for duplicate quote request](https://github.com/mojaloop/project/issues/2119) | ||
| 2. [#2322 - Helm install failing with with "medium to large" release names](https://github.com/mojaloop/project/issues/2322) | ||
| 3. [#2352 - Mojaloop Helm support for Kubernetes 1.22](https://github.com/mojaloop/project/issues/2352) | ||
| 4. [#2448 - Nginx Ingress Controller v1.0.0 is incompatible with Mojaloop Helm v13.0.x releases](https://github.com/mojaloop/project/issues/2448) | ||
| 5. [#2317 - Mojaloop Helm deployments are not compatible when deployed to ARM-arch based hosts](https://github.com/mojaloop/project/issues/2317) | ||
| 6. Testing Toolkit Test Case issues causing instability/intermitant failures on Test Case Results | ||
| 1. [#2717 - Thirdparty TTK Test-Collection is not repeatable](https://github.com/mojaloop/project/issues/2717) | ||
| 2. [#2734 - Failures in daily cron job running GP tests](https://github.com/mojaloop/project/issues/2734) | ||
| 3. [#2845 - QA: Replace Legacy-Simulator as a NORESPONSE_SIMPAYEE in Testing-Toolkit Goden Path Test-Suite](https://github.com/mojaloop/project/issues/2845) | ||
| 4. [#2846 - QA: Mojaloop TTK GP Test Collections to reset available liquidity after each run](https://github.com/mojaloop/project/issues/2846) | ||
|
|
||
| ## 9. Contributors | ||
|
|
||
| - Organizations: BMGF, CrossLake, ModusBox | ||
| - Individuals: @elnyry-sam-k, @mdebarros, @vijayg10, @kleyow, @kirgene, @tdaly61 | ||
|
|
||
| _Note: companies are in alphabetical order, individuals are in no particular order._ |
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 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
Oops, something went wrong.