Skip to main content

Upgrading from 4.1.1 to 4.2.0

How to upgrade​

Please notice that upgrading to version 4.2.0 is only possible from version 4.1.1, please check Upgrading from 4.1.0 to 4.1.1 if you need to upgrade from a previous version.

Upgrade OpenShift version​

From version 4.2.0, IBM Industry Solutions Workbench supports OpenShift version 4.16 in addition to 4.14. Openshift version 4.12 is deprecated.

Solution CLI​

Starting from Solution CLI version 10.0.0, the Solution CLI uses OIDC device authorization flow, logging in via username and password is no longer supported.

Generic Service Java (formally known as pro-code Java project)​

Adjust your Generic Service Java projects created with previous versions​

Dependency update​

Generic Service Java projects use several functionalities provided by the dependency "cp-framework-sdk", which has been updated to include new fixes, and versions of underlying used dependencies.

All existing Generic Service Java projects have to download this new version and migrate to this new version.

Migration steps​

  1. Open the Solution Envoy dashboard (you can find the link in Solution Designer on the CI/CD page after you have set up at least one deploy pipeline or inside Solution Hub after selecting a k5-project and opening the tab "Service Deployments")

  2. Navigate to the Infrastructure page and download all the dependencies listed under Maven Dependencies (Java)

  3. Install dependencies in the local maven repository. Below is an example how the dependencies can be installed via maven

    mvn install:install-file -Dfile=cp-framework-sdk-autoconfiguration-4.0.366.jar -DpomFile=cp-framework-sdk-autoconfiguration-4.0.366.pom
    mvn install:install-file -Dfile=cp-framework-sdk-parent-4.0.366.pom -DpomFile=cp-framework-sdk-parent-4.0.366.pom

  4. Clone / Open your service project

  5. Navigate to pom.xml file

  6. Search for the parent attribute and change it to match the new "cp-framework-sdk" version, see the following snippet example:

    <parent>
        <groupId>de.knowis.cp.sdk</groupId>
        <artifactId>cp-framework-sdk-parent</artifactId>
        <version>4.0.366</version>
        <relativePath>
            ./.framework/repo/de/knowis/cp/sdk/cp-framework-sdk-parent/4.0.366/cp-framework-sdk-parent-4.0.366.pom
        </relativePath>
    </parent>

    NOTE Current latest version of "cp-framework-sdk" that is shipped with the IBM Industry Solutions Workbench is 4.0.366.

  7. Push your adjustment and run your pipeline(s) to make sure your projects deploy successfully

Domain Service Java (formally known as low-code Java project)​

Adjust your Domain Service Java projects created with previous versions​

Dependency Update​

Domain Service Java projects use several functionalities provided by the dependency "cp-framework-sdk", which has been updated to include new fixes, and versions of underlying used dependencies.

All existing Domain Service Java projects are required to migrate to this new version.

  1. Clone (k5 clone) or update (k5 pull) your service project

  2. Open your service project

  3. Navigate to pom.xml file

  4. Search for the parent attribute and change it to match the new "cp-framework-sdk" version, see the following snippet example:

    <parent>
        <groupId>de.knowis.cp.sdk</groupId>
        <artifactId>cp-framework-managed-sdk-parent</artifactId>
        <version>4.0.366</version>
        <relativePath>
            ./.framework/repo/de/knowis/cp/sdk/cp-framework-managed-sdk-parent/4.0.366/cp-framework-managed-sdk-parent-4.0.366.pom
        </relativePath>
    </parent>

    NOTE Current latest version of "cp-framework-sdk" that is shipped with the IBM Industry Solutions Workbench [knowis_version] is 4.0.366.

  5. Push your adjustment and run your pipeline(s) to make sure your projects deploy successfully

Additional configurations​

The creation of projects now also includes assets on the first page of the creation dialog. By default, already existing assets from all asset catalogs are included. If you want to exclude assets of specific asset catalogs from the creation dialog, follow these steps:

  1. In the Solution Designer, go to Admin settings.
  2. Select the "Asset catalogs" tab.
  3. Search for the asset catalog you want to exclude and click on "Edit" within its table row.
  4. Uncheck the checkbox "Include assets from this catalog in the project creation".

The assets from this catalog are now no longer displayed in the project creation dialog.