Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

DSF Upgrade From 0.8.0 to 0.9.0

Jump to bottom
Hauke Hund edited this page Oct 18, 2022 · 2 revisions

Upgrading from 0.8.0

Upgrading the DSF from 0.8.0 to 0.9.0 involves modifying the docker-compose.yml files, replacing the process plugins and recreating the containers.

If you are upgrading from 0.6.0 please see the Upgrade from 0.6.0 to 0.7.0 guide first and then visit the Upgrade from 0.7.0 to 0.9.0 guide. If you are upgrading from 0.7.0 please see the Upgrade from 0.7.0 to 0.9.0 guide.

Modify DSF FHIR Server Setup

  1. Preparation / Backup

    • We recommend to create a backup of the /opt/fhir directory before proceeding with the upgrade.
      For example using: sudo cp -rp /opt/fhir /opt/fhir_backup_pre_0.9.0_upgrade

  2. Modify the DSF FHIR docker-compose.yml file, replace 0.8.0 with 0.9.0

    @@ -1,7 +1,7 @@
 version: '3.8'
 services:
   proxy:
-    image: ghcr.io/highmed/fhir_proxy:0.8.0
+    image: ghcr.io/highmed/fhir_proxy:0.9.0
     restart: on-failure
     ports:
       - 127.0.0.1:80:80
@@ -27,7 +27,7 @@ services:
       - app
 
   app:
-    image: ghcr.io/highmed/fhir:0.8.0
+    image: ghcr.io/highmed/fhir:0.9.0
     restart: on-failure
     healthcheck:
       test: ["CMD", "java", "-cp", "dsf_fhir.jar", "org.highmed.dsf.fhir.StatusClient"]

  3. Upgrade the DSF FHIR containers
    From /opt/fhir execute

    docker-compose up -d && docker-compose logs -f

Modify DSF BPE Server Setup

  1. Preparation / Backup

    • We recommend to create a backup of the /opt/bpe directory before proceeding with the upgrade.
      For example using: sudo cp -rp /opt/bpe /opt/bpe_backup_pre_0.9.0_upgrade

  2. Modify the DSF BPE docker-compose.yml file

    • NUM-CODEX (non HiGHmed) instance:
      Change the bpe container version from 0.8.0 to 0.9.0, update the process exclude config and remove a bind mount

      @@ -1,7 +1,7 @@
 version: '3.8'
 services:
   app:
-    image: ghcr.io/highmed/bpe:0.8.0
+    image: ghcr.io/highmed/bpe:0.9.0
     restart: on-failure
     healthcheck:
       test: ["CMD", "java", "-cp", "dsf_bpe.jar", "org.highmed.dsf.bpe.StatusClient"]

    • HiGHmed instance:
      Change the bpe container version from 0.7.0 to 0.9.0, update the process exclude config, and remove a bind mount

      @@ -1,7 +1,7 @@
 version: '3.8'
 services:
   app:
-    image: ghcr.io/highmed/bpe:0.8.0
+    image: ghcr.io/highmed/bpe:0.9.0
     restart: on-failure
     healthcheck:
       test: ["CMD", "java", "-cp", "dsf_bpe.jar", "org.highmed.dsf.bpe.StatusClient"]
@@ -48,9 +48,9 @@ services:
       ORG_HIGHMED_DSF_BPE_FHIR_SERVER_ORGANIZATION_IDENTIFIER_VALUE: TODO_ORGANIZATION_IDENTIFIER
       ORG_HIGHMED_DSF_BPE_FHIR_SERVER_BASE_URL: https://TODO_DSF_FRIR_SERVER_FQDN/fhir
       ORG_HIGHMED_DSF_BPE_PROCESS_EXCLUDED: |
-        highmedorg_computeFeasibility/0.6.0
-        highmedorg_computeDataSharing/0.6.0
-        highmedorg_updateAllowList/0.6.0
+        highmedorg_computeFeasibility/0.7.0
+        highmedorg_computeDataSharing/0.7.0
+        highmedorg_updateAllowList/0.7.0
         wwwnetzwerk-universitaetsmedizinde_dataTranslate/0.7.0
         wwwnetzwerk-universitaetsmedizinde_dataReceive/0.7.0

  3. Upgrade DSF Plugins and Process-Plugins

    • NUM-CODEX (non HiGHmed) instance:

      • Process plugins in /opt/bpe/process:

        1. Replace codex-process-data-transfer-0.6.0.jar with codex-process-data-transfer-0.7.0.jar from the latest NUM-CODEX processes release
        2. Replace dsf-bpe-process-ping-0.6.0.jar with dsf-bpe-process-ping-0.7.0.jar from the latest HiGHmed processes release

        Make sure the process plugins in /opt/bpe/process are configured with chmod 440 and chown root:bpe.

    • HiGHmed instance:

      • Process plugins in /opt/bpe/process:

        1. Replace codex-process-data-transfer-0.6.0.jar with codex-process-data-transfer-0.7.0.jar from the latest NUM-CODEX processes release
        2. Replace dsf-bpe-process-data-sharing-0.6.0.jar with dsf-bpe-process-data-sharing-0.7.0.jar from the latest HiGHmed processes release
        3. Replace dsf-bpe-process-feasibility-0.6.0.jar with dsf-bpe-process-feasibility-0.7.0.jar from the latest HiGHmed processes release
        4. Replace dsf-bpe-process-feasibility-mpc-0.6.0.jar with dsf-bpe-process-feasibility-mpc-0.7.0.jar from the latest HiGHmed processes release
        5. Replace dsf-bpe-process-local-services-0.6.0.jar with dsf-bpe-process-local-services-0.7.0.jar from the latest HiGHmed processes release
        6. Replace dsf-bpe-process-ping-0.6.0.jar with dsf-bpe-process-ping-0.7.0.jar from the latest HiGHmed processes release
        7. Replace dsf-bpe-process-update-allow-list-0.6.0.jar with dsf-bpe-process-update-allow-list-0.7.0.jar from the latest HiGHmed processes release

        Make sure the process plugins in /opt/bpe/process are configured with chmod 440 and chown root:bpe.

      • Plugins in '/opt/bpe/plugin':

        1. If you are using the provided PDQ MPI Client, replace dsf-mpi-client-pdq-0.7.0.jar, hapi-base-2.3.jar and hapi-structures-v25-2.3.jar with the new files from dsf-mpi-client-pdq-0.9.0.zip, see DSF release notes
        2. If you are using the provided openEHR Client, replace dsf-openehr-client-impl-0.7.0.jar with the new file from dsf-openehr-client-impl-0.9.0.zip, see DSF release notes

        Make sure the plugins in /opt/bpe/plugin are configured with chmod 440 and chown root:bpe.

  4. Upgrade the DSF BPE containers
    From /opt/bpe execute

    docker-compose up -d && docker-compose logs -f

  5. Verify your upgrade:

    • Verify the DSF FHIR server is running in version 0.9.0. The log should contain a message:
      INFO main - BuildInfoReaderImpl.logBuildInfo(137) | Artifact: dsf-fhir-server-jetty, version: 0.9.0, [...]
    • Verify the DSF FHIR server started without errors
    • Verify the DSF FHIR server is accessible via https, for example by browsing to https://your-dsf-endpoint.de/fhir/ (authentication with your client-certificate)
    • Verify the DSF BPE server is running in version 0.9.0. The log should contain a message:
      INFO main - BuildInfoReaderImpl.logBuildInfo(137) | Artifact: dsf-bpe-server-jetty, version: 0.9.0, [...]
    • Verify the DSF BPE server started without errors
    • Verify the DSF BPE server removed ActivityDefinition resources for the deleted process plugin from the DSF FHIR server and created new ActivityDefinition for the new process plugin.
    • Verify your install with a ping/pong test
      For a Task resource compatible with the 0.7.0 release of the ping process, see the Ping/Pong process wiki.
Clone this wiki locally