You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: assets/readme/README.operator.md
+7-4Lines changed: 7 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,18 +19,21 @@ For example, add the following line (replace `<IP>` with the server's actual IP
19
19
<IP> dl3.tud.de dl3
20
20
```
21
21
22
+
TODO describe this in participant REAME if needed
23
+
22
24
## Create Startup Kits
23
25
24
26
### Via Script (recommended)
25
27
26
28
1. Use, e.g., the file `application/provision/project_MEVIS_test.yml`, adapt as needed (network protocol etc.)
27
-
2. Call `buildDockerImageAndStartupKits.sh -p /path/to/project_configuration.yml` to build the Docker image and the startup kits
29
+
2. Call `buildDockerImageAndStartupKits.sh -p /path/to/project_configuration.yml -c /path/to/directory/with/VPN/credentials` to build the Docker image and the startup kits
30
+
- swarm nodes (admin, server, clients) are configured in `project_configuration.yml`
31
+
- the directory with VPN credentials should contain one `.ovpn` file per node
32
+
- use `-c tests/local_vpn/client_configs/` to build startup kits for the integration tests
28
33
3. Startup kits are generated to `workspace/<name configured in the .yml>/prod_00/`
29
34
4. Deploy startup kits to the respective server/client operators
30
35
5. Push the Docker image to the registry
31
36
32
-
TODO describe what needs to be done for productive VPN credentials (that must remain a local resource and not be committed)
33
-
34
37
### Via the Dashboard (not recommended)
35
38
36
39
Build the Docker image as described above.
@@ -81,7 +84,7 @@ passwords somewhere, they are only displayed once (or you can download them agai
81
84
82
85
## Starting a Swarm Training
83
86
84
-
1. Connect the *server* host to the VPN as described above.
87
+
1. Connect the *server* host to the VPN as described above. (TODO update documentation, this step is not needed if the Docker container handles the VPN connection.)
85
88
2. Start the *server* startup kit using the respective `startup/docker.sh` script with the option to start the server
86
89
3. Provide the *client* startup kits to the swarm participants (be aware that email providers or other channels may
0 commit comments