search

wso2 / docs-open-banking

Apache License 2.0
39 stars 25 forks source link

[OB3] Multiple deployment.toml files maintained for different base product versions #839

Open ChinthakaJ98 opened 1 year ago

ChinthakaJ98 commented 1 year ago

Affected OB version:

OB3

Affected OB specifications:

OB Accelerator

Existing pages to be updated:

https://ob.docs.wso2.com/en/latest/get-started/set-up-accelerators https://ob.docs.wso2.com/en/latest/install-and-setup/setting-up-servers/#copying-the-deploymenttoml

Description (Optional):

As the OB Accelerator now supports multiple base product versions, we are maintaining separate deployment.toml files that could be used for each of these versions as their configurations could differ from one another. Therefore in the documentation we need to mention that the relevant deployment.toml file should be used when setting up the pack as per the base product versions that are being used.

Instructions:

In the get started page we need to mention the relevant deployment.toml file to be used in the configure.properties file as below. For wso2-obam-accelerator 

PRODUCT_CONF_PATH=repository/resources/wso2am-4.0.0-deployment.toml
PRODUCT_CONF_PATH=repository/resources/wso2am-4.1.0-deployment.toml
PRODUCT_CONF_PATH=repository/resources/wso2am-4.1.0-deployment.toml

For wso2-obiam-accelerator

PRODUCT_CONF_PATH=repository/resources/wso2is-5.11.0-deployment.toml
PRODUCT_CONF_PATH=repository/resources/wso2is-6.0.0-deployment.toml
PRODUCT_CONF_PATH=repository/resources/wso2is-6.1.0-deployment.toml

wso2-obbi-accelerator

PRODUCT_CONF_PATH=repository/resources/wso2si-4.0.0-deployment.yaml
PRODUCT_CONF_PATH=repository/resources/wso2si-4.2.0-deployment.yaml

In the install and setup page, instructions should be given to copy the relevant deployment.toml file out of the aforementioned files as per the base product version that is being used.

You can refer to this as an example. https://ob.docs.wso2.com/en/latest/get-started/data-publishing-try-out