Skip to content

Commit 709b03a

Browse files
schwzrschwzr
committed
upgrade instructions from 2.0.0
1 parent aa49ec1 commit 709b03a

File tree

3 files changed

+165
-2
lines changed

3 files changed

+165
-2
lines changed

‎docs/src/.vuepress/sidebar/operations-v2.ts‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,84 @@
11
export function generate_v2_latest_sidebar() {
2+
return [
3+
4+
{
5+
text: "Get Started",
6+
icon: "tool",
7+
link: "./",
8+
},
9+
"release-notes", "install", "upgrade-from-2", "upgrade-from-1", "allowList-mgm", "root-certificates", "passwords-secrets", {
10+
text: "FHIR Reverse Proxy",
11+
icon: "module",
12+
children: [
13+
{
14+
icon: "config",
15+
text: "Configuration",
16+
link: "fhir-reverse-proxy/configuration",
17+
}
18+
]},
19+
{
20+
text: "FHIR Server",
21+
icon: "module",
22+
prefix: "fhir/",
23+
link: "fhir/",
24+
children: [{
25+
icon: "config",
26+
text: "Configuration",
27+
link: "configuration"
28+
}, {
29+
icon: "config",
30+
text: "Access Control",
31+
link: "access-control"
32+
}, {
33+
icon: "config",
34+
text: "OpenID Connect",
35+
link: "oidc"
36+
}, {
37+
icon: "config",
38+
text: "Logging",
39+
link: "logging"
40+
}]
41+
}, {
42+
text: "BPE Reverse Proxy",
43+
icon: "module",
44+
children: [
45+
{
46+
icon: "config",
47+
text: "Configuration",
48+
link: "bpe-reverse-proxy/configuration",
49+
}
50+
]
51+
}, {
52+
text: "BPE Server",
53+
icon: "module",
54+
prefix: "bpe/",
55+
link: "bpe/",
56+
children: [{
57+
icon: "config",
58+
text: "Configuration",
59+
link: "configuration"
60+
}, {
61+
icon: "config",
62+
text: "Access Control",
63+
link: "access-control"
64+
}, {
65+
icon: "config",
66+
text: "OpenID Connect",
67+
link: "oidc"
68+
}, {
69+
icon: "config",
70+
text: "Logging",
71+
link: "logging"
72+
}]
73+
},
74+
{
75+
text: "Install Plugins",
76+
icon: "plugin",
77+
link: "install-plugins"
78+
}]
79+
}
80+
81+
export function generate_v2_0_0_sidebar() {
282
return [
383

484
{

‎docs/src/.vuepress/theme.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { slimsearchPlugin } from "@vuepress/plugin-slimsearch";
22
import { hopeTheme } from "vuepress-theme-hope";
33
import { generate_v1_latest_sidebar, generate_v1_gt_eq_1_7_0_sidebar, generate_v1_gt_eq_1_5_0_sidebar, generate_v1_gt_eq_1_0_0_sidebar } from "./sidebar/operations-v1";
4-
import { generate_v2_latest_sidebar } from "./sidebar/operations-v2";
4+
import { generate_v2_0_0_sidebar, generate_v2_latest_sidebar } from "./sidebar/operations-v2";
55

66
export default hopeTheme({
77
author: {
@@ -131,7 +131,7 @@ export default hopeTheme({
131131
"/operations/latest/": generate_v2_latest_sidebar(),
132132
"/operations/next/": [],
133133
"/operations/v2.0.1/": generate_v2_latest_sidebar(),
134-
"/operations/v2.0.0/": generate_v2_latest_sidebar(),
134+
"/operations/v2.0.0/": generate_v2_0_0_sidebar(),
135135
"/operations/v1.9.0/": generate_v1_latest_sidebar(),
136136
"/operations/v1.8.0/": generate_v1_gt_eq_1_7_0_sidebar(),
137137
"/operations/v1.7.1/": generate_v1_gt_eq_1_7_0_sidebar(),

‎docs/src/operations/v2.0.1/upgrade-from-2.md‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
---
2+
title: Upgrade from DSF 2.0.0
3+
icon: update
4+
---
5+
6+
::: info DSF 2.0.1
7+
This is one of the first **released versions** of the Data Sharing Framework (DSF) 2.0.
8+
Please **do not use this version in production environments**.
9+
10+
We kindly invite **all DSF administrators** to test this release on their **staging or test instances** and share their feedback with us through the usual [communication channels](/community/communication#contact-the-team).
11+
12+
Thank you for helping us improve the DSF!
13+
:::
14+
15+
Upgrading the DSF from 2.0.0 to 2.0.1 involves modifying the version the docker-compose.yml files and recreating the containers.
16+
17+
18+
DSF 2 was designed to run DSF 1 (APIv1) process plugins, but due to stricter validation rules in DSF 2 we strongly recommend using the latest compatible plugin versions. Updates within the same major and minor version (e.g., from 1.2.3.4 to 1.2.9.9) are generally safe. An overview of the recommended MII/NUM versions can be found [here](./install-plugins.md).
19+
20+
## Modify DSF FHIR Server Setup
21+
1. Preparation / Backup
22+
* We recommend to create a backup of the `/opt/fhir` directory before proceeding with the upgrade.
23+
For example using: `sudo cp -rp /opt/fhir /opt/fhir_backup_pre_2.0.1_upgrade`
24+
25+
2. Modify the DSF FHIR docker-compose.yml file, replace the version number with 2.0.1.
26+
```diff
27+
version: '3.8'
28+
services:
29+
proxy:
30+
- image: ghcr.io/datasharingframework/fhir_proxy:2.0.0
31+
+ image: ghcr.io/datasharingframework/fhir_proxy:2.0.1
32+
restart: on-failure
33+
...
34+
app:
35+
- image: ghcr.io/datasharingframework/fhir:2.0.0
36+
+ image: ghcr.io/datasharingframework/fhir:2.0.1
37+
restart: on-failure
38+
...
39+
40+
```
41+
42+
43+
44+
3. Upgrade the DSF FHIR containers
45+
From `/opt/fhir` execute
46+
```
47+
docker compose up -d && docker compose logs -f
48+
```
49+
50+
## Modify DSF BPE Server Setup
51+
1. Preparation / Backup
52+
* We recommend to create a backup of the `/opt/bpe` directory before proceeding with the upgrade.
53+
For example using: `sudo cp -rp /opt/bpe /opt/bpe_backup_pre_2.0.1_upgrade`
54+
55+
2. Modify the DSF BPE docker-compose.yml file, replace the version number with 2.0.1.
56+
```diff
57+
version: '3.8'
58+
services:
59+
app:
60+
- image: ghcr.io/datasharingframework/bpe:2.0.0
61+
+ image: ghcr.io/datasharingframework/bpe:2.0.1
62+
restart: on-failure
63+
...
64+
65+
66+
```
67+
68+
3. Upgrade the DSF BPE containers
69+
From `/opt/bpe` execute
70+
```
71+
docker compose up -d && docker compose logs -f
72+
```
73+
74+
5. Verify your upgrade:
75+
* Verify the DSF FHIR server is running in version 2.0.0. The log should contain a message:
76+
`INFO main - BuildInfoReaderImpl.logBuildInfo(137) | Artifact: dsf-fhir-server-jetty, version: 2.0.1, [...]`
77+
* Verify the DSF FHIR server started without errors
78+
* 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)
79+
* Verify the DSF BPE server is running in version 2.0.0. The log should contain a message:
80+
`INFO main - BuildInfoReaderImpl.logBuildInfo(137) | Artifact: dsf-bpe-server-jetty, version: 2.0.1, [...]`
81+
* Verify the DSF BPE server started without errors
82+
* Verify your install with a ping/pong test
83+

0 commit comments

Comments
 (0)