wso2 / docs-open-banking

Apache License 2.0
39 stars 26 forks source link

[OB2][AU][MGW] The docs for Microgateway should mention how to handle Multiple Ports #749

Closed verushkat closed 1 year ago

verushkat commented 1 year ago

Affected OB version:

OB2

Affected OB specifications:

CDS

Existing pages to be updated:

MGW

Description (Optional):

[OB2][AU][MGW] The docs for Microgateway should mention how to handle Multiple Ports -->

Instructions:

References:

Labels:

verushkat commented 1 year ago

also please note with regads to dev info pleaase contact @ChinthakaJ98

ChinthakaJ98 commented 1 year ago

Hi @DinithiDiaz,

Please do the below changes in the 4th section "Configure the micro-gw.conf file:" of the OB2 MGW documentation.

If multiple MGW docker images are to be run in parallel on the same server, the ports mentioned in the below configurations need to be changed accordingly so that the ports being used by the docker containers will be unique.

Configuration Format
[listenerConfig]
  httpPort = <HTTP_PORT>
  httpsPort = <HTTPS_Port>
  tokenListenerPort = <Token_Listener_Port>
Default
[listenerConfig]
  httpPort = 9090
  httpsPort = 9095
  tokenListenerPort = 9096

For example: If both wso2-obmg-au-cds-accounts and wso2-obmg-au-cds-transactions MGW docker images need to run in parallel, the configurations need to be changed as below.

wso2-obmg-au-cds-accounts
[listenerConfig]
  httpPort = 9090
  httpsPort = 9095
  tokenListenerPort = 9096
wso2-obmg-au-cds-transactions
[listenerConfig]
  httpPort = 9091
  httpsPort = 9098
  tokenListenerPort = 9097

If the Admin APIs are being deployed using the MGW docker image, make sure to update the below configurations based on the deployment.

Configuration Format
[openbanking.jwt.authentication]
    jwksURL = "<JWKS_URL>"
    issuer = "<Issuer_Value>"
    audience =  "<Audience_Value>"
Default
[openbanking.jwt.authentication]
    jwksURL = "https://keystore.openbankingtest.org.uk/0015800001HQQrZAAX/9b5usDpbNtmxDcTzs7GzKp.jwks"
    issuer = "cdr-register"
    audience =  "https://wso2ob.com"

Finally update the numbering of the points in the 4th section accordingly after adding these content changes.

Thanks & Kind Regards Chinthaka

DinithiDiaz commented 1 year ago

Updated the WSO2 API Microgateway for WSO2 Open Banking page:

1 2
verushkat commented 1 year ago

closing the issue as Verified Thank you Chinthaka for well descriptive information and dinithi for quickly doing this