Skip to content

Commit 0d1f098

Browse files
committed
extended documentation how to build startup kits with VPN credentials
1 parent 2b84145 commit 0d1f098

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

assets/readme/README.operator.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,18 +19,21 @@ For example, add the following line (replace `<IP>` with the server's actual IP
1919
<IP> dl3.tud.de dl3
2020
```
2121

22+
TODO describe this in participant REAME if needed
23+
2224
## Create Startup Kits
2325

2426
### Via Script (recommended)
2527

2628
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
2833
3. Startup kits are generated to `workspace/<name configured in the .yml>/prod_00/`
2934
4. Deploy startup kits to the respective server/client operators
3035
5. Push the Docker image to the registry
3136

32-
TODO describe what needs to be done for productive VPN credentials (that must remain a local resource and not be committed)
33-
3437
### Via the Dashboard (not recommended)
3538

3639
Build the Docker image as described above.
@@ -81,7 +84,7 @@ passwords somewhere, they are only displayed once (or you can download them agai
8184

8285
## Starting a Swarm Training
8386

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.)
8588
2. Start the *server* startup kit using the respective `startup/docker.sh` script with the option to start the server
8689
3. Provide the *client* startup kits to the swarm participants (be aware that email providers or other channels may
8790
prevent encrypted archives)

0 commit comments

Comments
 (0)