Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
ChinthakaJ98 opened this issue Jul 6, 2023 · 0 comments
Assignees
Labels
Accelerator Affects Accelerator documentation

Comments

@ChinthakaJ98
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Accelerator Affects Accelerator documentation
Projects
None yet
Development

No branches or pull requests

2 participants