Skip to main content

Upgrade from DSF 1.1.0

DSF-TeamAbout 2 min

Upgrading the DSF from 1.1.0 to 1.2.0 involves modifying the docker-compose.yml files and recreating the containers.

Upgrade from 0.9.x

If you want to migrate from DSF 0.9.x, please follow these instructions.

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_1.2.0_upgrade

  2. Modify the DSF FHIR docker-compose.yml file, replace the version number with 1.2.0 and remove the old healthcheck definition. The new healthcheck is defined as part of the docker image.

version: '3.8'
services:
  proxy:
-   image: ghcr.io/datasharingframework/fhir_proxy:1.1.0
+   image: ghcr.io/datasharingframework/fhir_proxy:1.2.0
    restart: on-failure
...
  app:
-   image: ghcr.io/datasharingframework/fhir:1.1.0
+   image: ghcr.io/datasharingframework/fhir:1.2.0
    restart: on-failure
-   healthcheck:
-     test: ["CMD", "java", "-cp", "dsf_fhir.jar", "dev.dsf.common.status.client.StatusClient"]
-     interval: 10s
-     timeout: 15s
-     retries: 5
...
  1. The role configuration is now optional. If you don't use roles, you can remove the role config (default for new installations):
  app:
...
    environment:
...
-     # TODO specify role configuration to allow access to the UI via web-browser or REST API for specific users, see documentation at dsf.dev
-     DEV_DSF_FHIR_SERVER_ROLECONFIG: |
  1. 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_1.2.0_upgrade

  2. Modify the DSF BPE docker-compose.yml file, replace the version number with 1.2.0 and remove the old healthcheck definition. The new healthcheck is defined as part of the docker image.

version: '3.8'
services:
  app:
-   image: ghcr.io/datasharingframework/bpe:1.1.0
+   image: ghcr.io/datasharingframework/bpe:1.2.0
    restart: on-failure
-   healthcheck:
-     test: ["CMD", "java", "-cp", "dsf_bpe.jar", "dev.dsf.common.status.client.StatusClient"]
-     interval: 10s
-     timeout: 15s
-     retries: 5
...

  1. DSF v1.2.0 is not compatible with the Ping/Pong process plugin v1.0.0.0, upgrade to the Ping/Pong plugin v1.0.1.0open in new window by removing the old jar file and replacing it with the new v1.0.1.0 one.

  2. We have released a new version of the Allow List Process plugin where we added support for delete operations. Please upgrade to the Allow-List process v1.0.0.1open in new window by removing the old jar file and replacing it with the new v1.0.0.1 one.

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

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

  4. Verify your upgrade:

    • Verify the DSF FHIR server is running in version 1.2.0. The log should contain a message:
      INFO main - BuildInfoReaderImpl.logBuildInfo(137) | Artifact: dsf-fhir-server-jetty, version: 1.2.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/open in new window (authentication with your client-certificate)
    • Verify the DSF BPE server is running in version 1.2.0. The log should contain a message:
      INFO main - BuildInfoReaderImpl.logBuildInfo(137) | Artifact: dsf-bpe-server-jetty, version: 1.2.0, [...]
    • Verify the DSF BPE server started without errors
    • Verify your install with a ping/pong test
Last update: