Prerequisites
Before you start, make sure you have the following:- Helm chart connector artifacts published to the enterprise artifactory at repo.backbase.com.
- Access to the applications-live repository for your track (
gc-{installation}-applications-live,gc-devhub-{installation}-applications-live, or both). For more information about repository names, see GitHub organization and repository structure. - The required secrets with connector properties in the Kubernetes key vaults.
Requests to submit
Submit a request to establish Private Link connectivity between the Digital Banking Platform and the Banking OS platform with the Managed Hosting team. The Digital Banking Platform can use the Private Link connection by defining ahostAlias on the connecting integration service.
Contact your Managed Hosting team representative for the Private Link connectivity setup steps and configuration details.
Prepare the runtime
Before you deploy any components, follow these steps:-
Create the runtimes. Create the required runtimes in the
gc-{installation}-applications-liverepository in the GitHub organization provisioned for your installation. -
Deploy the secrets. Deploy the required Secrets Operations (SOPS) secrets under
runtimes/[env]/secrets, such as OAuth client credentials, usernames and passwords, and mTLS certificates.Contact your Managed Hosting team representative for instructions on creating SOPS secrets and using them in connectors.
Deploy APIM components
You deploy APIM components through Argo CD, which syncs and deploys the Helm chart configurations in your YAML files. The supported components are APIs, Named Values, Policy Fragments, Backends, Credential Managers, Products, and Subscriptions.The version numbers in the following samples are illustrative. Check your shared Azure Container Registry (ACR) for the versions available in your environment.
-
Deploy unified APIs. Under
main/runtimes/dev/apim/apis, add a YAML file for each Banking OS unified API specification that you need in APIM. For example, to configure the deposit and payment APIs, add the following files. Adddeposit-api.yaml:AddView sample deposit-api.yaml
payment-api.yaml:View sample payment-api.yaml
-
Deploy API version sets. Add
apiversionsets.values.yaml:View sample apiversionsets.values.yaml
-
Deploy connector backends. Add
backend.values.yamlundermain/runtimes/dev/apim:View sample backend.values.yaml
-
Deploy product policy fragments. Add
policyfragments.values.yamlundermain/runtimes/dev/apim:View sample policyfragments.values.yaml
-
Deploy products. Add
products.values.yamlundermain/runtimes/dev/apim:View sample products.values.yaml
-
Deploy subscriptions. Add
subscription.values.yamlundermain/runtimes/dev/apim:View sample subscription.values.yaml
Deploy the connectors
After the APIM components are in place, follow these steps to deploy the connectors:-
Deploy connector values. Deploy the connector configurations under the values folder of the runtime. These configurations include secret names and connector settings, such as the vendor system base URL, security token type, and connection parameters.
Add
deposit-v0.values.yamlundermain/runtimes/dev/values/gc-flexcube:AddView sample deposit-v0.values.yaml
payment-v0.values.yamlundermain/runtimes/dev/values/gc-alacriti:View sample payment-v0.values.yaml
-
Deploy connectors. Deploy the Banking OS connectors using the configuration under the
appsfolder. This configuration downloads the connector Helm charts from the enterprise shared repository atgcshared671.azurecr.io/charts. These connectors are Backbase-managed. Backbase deploys them fromgc-{installation}-applications-live, with Argo CD projectgrandcentral, into agc-<domain>namespace. The following sample usesgc-flexcube. For a custom connector that you build, use thegc-devhub-{installation}-applications-liverepository, thedevhub-grandcentralproject, and a DevHub namespace such asdevhub-grandcentralordevh-gc-<domain>. The namespace must exist before theApplicationsyncs. For more information, see Deployment namespace. Addmain/runtimes/dev/apps/gc-flexcube.yamlto deploy the managed connectors and the WireMock services for the mocked responses:View sample gc-flexcube.yaml
-
Deploy Istio configurations (optional). To secure outgoing connectivity from Kubernetes, deploy the Istio configurations. The setup uses the Istio egress gateway with the necessary components, such as
serviceEntries,virtualServices, anddestinationRules. Addvalues.yamlundermain/runtimes/dev/istio:View sample values.yaml
- Deploy Sync Hub components (optional). If your connectors use Sync Hub, deploy the required platform components, such as the Sync Hub configurations for the Azure Service Bus (ASB) topic and subscriptions.
- Get the APIM subscription key. In the Azure portal, retrieve the APIM subscription key for the product that you created through the Argo CD deployments. You use this key to test the connectors.
Manage feature flags and custom configuration properties
After the connectors are running, you can change their behavior through the values configuration of the runtime.Add feature flags
Configure the feature flags that the connectors require in the values configuration of the runtime. The connector handles the flow according to how it implements the feature.Add or modify data fields
To map data for a specific integration API, override the Banking OS transformation mappings under the values resource of that API. For more information, see Map connector data fields.Add custom fields
Add any custom fields (additions) that you need to the same transformation mappings in the values resource. The following example shows deposit API custom field additions for the Flexcube deposit connector, including custom fields such asOFFSACC and PERCENTAGE.
View sample custom values.yaml
View sample custom values.yaml
In both cases, add the entire transformation resource file (included in managed connectors) along with the new, modified, or custom data mapping fields.
Test the connectors
Use Postman to test the Banking OS APIs by passing the APIM product subscription key as theapi-key header value.
Important links
The following endpoints help you test and monitor your deployment. Banking OS unified API Web Application Firewall (WAF) endpoint base URL:api.[runtime].[customer].gcservices.io
Argo CD: https://argo.[runtime].[customer].gcservices.io/