Upgrade Notes

The upgrade to IBM Financial Services Workbench 2.4 is supported from the earlier versions 2.2 and 2.3.

Depending on the already installed version the upgrade steps are described below.

For detailed information about upgrading IBM Financial Services Workbench, see Installing an Upgrade or Hotfix.

Deployment Versions

In the following table you will find the expected versions of Solution Designer and Solution Hub after the installation was performed:


Release Version	Component	Deployment Name	Deployment Version
`2.4.0`	Solution Designer	`release-ssob-solution-designer`	`3.2.2`
`2.4.0`	Solution Hub	`release-ssob-solution-hub`	`2.4.5`

Upgrading from 2.2 to 2.4

Adjust Configuration

Two configuration parameters have been added to the solution-designer-values.yaml that affect the k5-local-marketplace-controller, which is responsible for providing the API endpoints to work with the local marketplace:

global.endpoints.localMarketplaceController.host
k5-local-marketplace-controller.marketplace.storage.secretName

You can probably use the default values for these parameters, see the YAML file solution-designer-values.yaml.

Migrate API Bindings

Every existing API-binding (DEV binding or stored in the Configuration Management) that is referring to API dependencies that have been developed also with Financial Services Workbench need to be adjusted if the JSON Web Token (JWT) used in your solution should be forwarded to call the API dependency. The option k5_propagate_security_token: true|false is introduced in version 2.3 and needs to be included in the existing API bindings (JSON format).

The second option is to use the Local Lookup property to enable dynamic dependency determination for API dependencies developed with Financial Services Workbench.

Migrate Custom Implementation Solutions (Java)

Every existing Custom-Code-Solution (Java) needs to be updated in the Git repository. Please change the files listed below. The placeholders <SOLUTION_ACRONYM> (solution acronym in upper case) and <solution_acronym> (solution acronym in lower case) needs to be replaced:


File
`./api.json`	Change the value of `url` to `/<SOLUTION_ACRONYM>/v3/api-docs/<SOLUTION_ACRONYM>`
`./<solution_acronym>-application/pom.xml`	Change the value of `version` of the <parent> to `2.0.4`
`./<solution_acronym>-application/src/main/java/<solution_acronym>/ config/SecurityConfigurer.java`	Change line 25 from `.antMatchers(appContextPath()+"/api-docs").permitAll()` to `.antMatchers(appContextPath()+"/v3/api-docs/*").permitAll()`
`./<solution_acronym>-application/src/main/java/<solution_acronym>/ provider/HelloWorldController.java`	Change `"/*/api/v1/hello"` in line 17 to `"/${de.knowis.cp.solution.acronym:<SOLUTION_ACRONYM>}/api/v1/hello"` Please change your other controllers accordingly.

Solution CLI Setup

Upgrade your CLI:

Run fss upgrade-cli

Upgrading from 2.3 to 2.4

Migrate Custom-Code-Solutions (Java)

Any existing Custom-Code-Solution (Java) needs to be updated in the Git repository. Please change the files listed below. The placeholders <SOLUTION_ACRONYM> (solution acronym in upper case) and <solution_acronym> (solution acronym in lower case) needs to be replaced:


File
`./api.json`	Change the value of `url` to `/<SOLUTION_ACRONYM>/v3/api-docs/<SOLUTION_ACRONYM>`
`./<solution_acronym>-application/pom.xml`	Change the value of `version` of the <parent> to `2.0.4`
`./<solution_acronym>-application/src/main/java/<solution_acronym>/ config/SecurityConfigurer.java`	Change line 25 from `.antMatchers(appContextPath()+"/api-docs").permitAll()` to `.antMatchers(appContextPath()+"/v3/api-docs/*").permitAll()`
`./<solution_acronym>-application/src/main/java/<solution_acronym>/ provider/HelloWorldController.java`	Change `"/*/api/v1/hello"` in line 17 to `"/${de.knowis.cp.solution.acronym:<SOLUTION_ACRONYM>}/api/v1/hello"` Please change your other controllers accordingly.

Solution CLI Setup

Upgrade your CLI:

Run fss upgrade-cli