Merge branch 'develop' into feature/monitoring
This commit is contained in:
Martin Lablans
GitHub
commit
6791e9541f
447
README.md
447
README.md
|
|
@ -1,430 +1,175 @@
|
|||
# Bridgehead
|
||||
|
||||
This repository contains all information and tools to deploy a bridgehead. If you have any questions about deploying a bridgehead, please [contact us](mailto:verbis-support@dkfz-heidelberg.de).
|
||||
The Bridgehead is a secure, low-effort solution to connect your research institution to a federated research network. It bundles interoperable, open-source software components into a turnkey package for installation on one of your secure servers. The Bridgehead is pre-configured with sane defaults, centrally monitored and with an absolute minimum of "moving parts" on your side, making it an extremely low-maintenance gateway to data sharing.
|
||||
|
||||
This repository is the starting point for any information and tools you will need to deploy a Bridgehead. If you have questions, please [contact us](mailto:verbis-support@dkfz-heidelberg.de).
|
||||
|
||||
TOC
|
||||
|
||||
1. [About](#about)
|
||||
- [Projects](#projects)
|
||||
- [GBA/BBMRI-ERIC](#gbabbmri-eric)
|
||||
- [CCP(DKTK/C4)](#ccpdktkc4)
|
||||
- [NNGM](#nngm)
|
||||
- [Bridgehead Components](#bridgehead-components)
|
||||
- [Blaze Server](#blaze-serverhttpsgithubcomsamplyblaze)
|
||||
- [Connector](#connector)
|
||||
1. [Requirements](#requirements)
|
||||
- [Hardware](#hardware)
|
||||
- [System](#system-requirements)
|
||||
- [git](#git)
|
||||
- [docker](#dockerhttpsdocsdockercomget-docker)
|
||||
- [systemd](#systemd)
|
||||
2. [Getting Started](#getting-started)
|
||||
- [Quick Start](#quick-start)
|
||||
- [DKTK](#dktkc4)
|
||||
- [C4](#c4)
|
||||
- [GBA/BBMRI-ERIC](#gbabbmri-eric)
|
||||
3. [Configuration](#configuration)
|
||||
4. [Managing your Bridgehead](#managing-your-bridgehead)
|
||||
- [Systemd](#on-a-server)
|
||||
- [Without Systemd](#on-developers-machine)
|
||||
4. [Pitfalls](#pitfalls)
|
||||
5. [Migration-guide](#migration-guide)
|
||||
7. [License](#license)
|
||||
|
||||
|
||||
## About
|
||||
|
||||
TODO: Insert comprehensive feature list of the bridgehead? Why would anyone install it?
|
||||
|
||||
## Projects
|
||||
|
||||
### GBA/BBMRI-ERIC
|
||||
|
||||
The **Sample Locator** is a tool that allows researchers to make searches for samples over a large number of geographically distributed biobanks. Each biobank runs a so-called **Bridgehead** at its site, which makes it visible to the Sample Locator. The Bridgehead is designed to give a high degree of protection to patient data. Additionally, a tool called the [Negotiator][negotiator] puts you in complete control over which samples and which data are delivered to which researcher.
|
||||
|
||||
You will most likely want to make your biobanks visible via the [publicly accessible Sample Locator][sl], but the possibility also exists to install your own Sample Locator for your site or organization, see the GitHub pages for [the server][sl-server-src] and [the GUI][sl-ui-src].
|
||||
|
||||
The Bridgehead has two primary components:
|
||||
* The **Blaze Store**. This is a highly responsive FHIR data store, which you will need to fill with your data via an ETL chain.
|
||||
* The **Connector**. This is the communication portal to the Sample Locator, with specially designed features that make it possible to run it behind a corporate firewall without making any compromises on security.
|
||||
|
||||
### CCP(DKTK/C4)
|
||||
|
||||
TODO:
|
||||
|
||||
### nNGM
|
||||
|
||||
TODO:
|
||||
|
||||
### Bridgehead Components
|
||||
|
||||
#### [Blaze Server](https://github.com/samply/blaze)
|
||||
|
||||
This holds the actual data being searched. This store must be filled by you, generally by running an ETL on your locally stored data to turn it into the standardized FHIR format that we require.
|
||||
|
||||
#### [Connector]
|
||||
|
||||
TODO:
|
||||
- [System](#system)
|
||||
- [Git](#git)
|
||||
- [Docker](#docker)
|
||||
2. [Deployment](#deployment)
|
||||
- [Installation](#installation)
|
||||
- [Register with Samply.Beam](#register-with-samplybeam)
|
||||
- [Starting and stopping your Bridgehead](#starting-and-stopping-your-bridgehead)
|
||||
- [Auto-starting your Bridgehead when the server starts](#auto-starting-your-bridgehead-when-the-server-starts)
|
||||
3. [Additional Services](#additional-Services)
|
||||
- [Monitoring](#monitoring)
|
||||
- [Register with a Directory](#register-with-a-Directory)
|
||||
4. [Site-specific configuration](#site-specific-configuration)
|
||||
- [HTTPS Access](#https-access)
|
||||
- [Locally Managed Secrets](#locally-managed-secrets)
|
||||
- [Git Proxy Configuration](#git-proxy-configuration)
|
||||
- [Docker Daemon Proxy Configuration](#docker-daemon-proxy-configuration)
|
||||
- [Non-Linux OS](#non-linux-os)
|
||||
5. [License](#license)
|
||||
|
||||
## Requirements
|
||||
|
||||
### Hardware
|
||||
|
||||
For running your bridgehead we recommend the follwing Hardware:
|
||||
Hardware requirements strongly depend on the specific use-cases of your network as well as on the data it is going to serve. Most use-cases are well-served with the following configuration:
|
||||
|
||||
- 4 CPU cores
|
||||
- At least 8 GB Ram
|
||||
- 100GB Hard Drive, SSD recommended
|
||||
- 32 GB RAM
|
||||
- 160GB Hard Drive, SSD recommended
|
||||
|
||||
### Software
|
||||
|
||||
### System Requirements
|
||||
You are strongly recommended to install the Bridgehead under a Linux operating system (but see the section [Non-Linux OS](#non-linux-os)). You will need root (administrator) priveleges on this machine in order to perform the deployment. We recommend the newest Ubuntu LTS server release.
|
||||
|
||||
Before starting the installation process, please ensure that following software is available on your system:
|
||||
Ensure the following software (or newer) is installed:
|
||||
|
||||
#### Git
|
||||
- git >= 2.0
|
||||
- docker >= 20.10.1
|
||||
- docker-compose >= 2.xx (`docker-compose` and `docker compose` are both supported).
|
||||
- systemd
|
||||
|
||||
Check if you have at leat git 2.0 installed on the system with:
|
||||
We recommend to install Docker(-compose) from its official sources as described on the [Docker website](https://docs.docker.com).
|
||||
|
||||
``` shell
|
||||
git --version
|
||||
```
|
||||
Note for Ubuntu: Please note that snap versions of Docker are not supported.
|
||||
|
||||
#### [Docker](https://docs.docker.com/get-docker/)
|
||||
### Network
|
||||
|
||||
To check your docker installation, you should execute the docker with --version:
|
||||
Since it needs to carry sensitive patient data, Bridgeheads are intended to be deployed within your institution's secure network and behave well even in networks in strict security settings, e.g. firewall rules. The only connectivity required is an outgoing HTTPS proxy. TLS termination is supported, too (see [below](#tls-terminating-proxies))
|
||||
|
||||
``` shell
|
||||
docker --version
|
||||
```
|
||||
Note for Ubuntu: Please note that the uncomplicated firewall (ufw) is known to conflict with Docker [here](https://github.com/chaifeng/ufw-docker).
|
||||
|
||||
The Version should be higher than "20.10.1". Otherwise you will have problems starting the bridgehead. The next step is to check ``` docker-compose``` with:
|
||||
## Deployment
|
||||
|
||||
``` shell
|
||||
docker-compose --version
|
||||
```
|
||||
|
||||
The recomended version is "2.XX" and higher. If docker-compose was not installed with docker follow these [instructions](https://docs.docker.com/compose/install/#install-compose-as-standalone-binary-on-linux-systems). To futher check your docker and docker-compose installation, please run the following command.
|
||||
|
||||
``` shell
|
||||
docker-compose -f - up <<EOF
|
||||
version: "3.7"
|
||||
services:
|
||||
hello-world:
|
||||
image: hello-world
|
||||
EOF
|
||||
```
|
||||
Docker will now download the "hello-world" docker image and try to execute it. After the download you should see a message starting with "Hello from Docker!".
|
||||
|
||||
> NOTE: If the download of the image fails (e.g with "connection timed out" message), ensure that you have correctly set the proxy for the docker daemon. Refer to ["Docker Daemon Proxy Configuration" in the "Pitfalls" section](#docker-daemon-proxy-configuration)
|
||||
|
||||
#### [systemd](https://systemd.io/)
|
||||
|
||||
You shouldn't need to install it yourself, If systemd is not available on your system you should get another system.
|
||||
To check if systemd is available on your system, please execute
|
||||
|
||||
``` shell
|
||||
systemctl --version
|
||||
```
|
||||
|
||||
If systemd is not installed, you can start the bridgehead. However, for productive use we recomend using systemd.
|
||||
|
||||
---
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Quick Start
|
||||
|
||||
|
||||
If your system passed all checks from ["Requirements" section], you are now ready to download the bridgehead.
|
||||
|
||||
First, clone the repository to the directory "/srv/docker/bridgehead":
|
||||
|
||||
``` shell
|
||||
sudo mkdir -p /srv/docker/;
|
||||
sudo git clone https://github.com/samply/bridgehead.git /srv/docker/bridgehead;
|
||||
```
|
||||
|
||||
It is recomended to create a user for the bridgehead service. This should be done after clone the repository. Since not all linux distros support ```adduser```, we provide an action for the systemcall ```useradd```. You should try the first one, when the systm can't create the user you should try the second one.
|
||||
|
||||
``` shell
|
||||
useradd -M -g docker -N -s /sbin/nologin bridgehead
|
||||
```
|
||||
|
||||
After adding the User you need to change the ownership of the directory to the bridgehead user.
|
||||
|
||||
``` shell
|
||||
chown bridgehead /srv/docker/bridgehead/ -R
|
||||
```
|
||||
Download the configuration repository:
|
||||
|
||||
``` shell
|
||||
sudo git clone https://github.com/samply/bridgehead-config.git -b fix/bbmri-config /etc/bridgehead;
|
||||
```
|
||||
Change ownership:
|
||||
``` shell
|
||||
chown bridgehead /etc/bridgehead/ -R
|
||||
```
|
||||
Modify SITE_ID and SITE_NAME in bbmri.conf
|
||||
RUN:
|
||||
### Base Installation
|
||||
|
||||
First, clone the repository to the directory `/srv/docker/bridgehead`:
|
||||
|
||||
```shell
|
||||
sudo /etc/bridgehead/bridgehead enroll bbmri
|
||||
sudo mkdir -p /srv/docker/
|
||||
sudo git clone https://github.com/samply/bridgehead.git /srv/docker/bridgehead
|
||||
```
|
||||
|
||||
Then, run the installation script:
|
||||
|
||||
```shell
|
||||
sudo /srv/docker/bridgehead/bridgehead start bbmri
|
||||
cd /srv/docker/bridgehead
|
||||
sudo ./bridgehead install <PROJECT>
|
||||
```
|
||||
|
||||
### Configuration
|
||||
... and follow the instructions on the screen. You should then be prompted to do the next step:
|
||||
|
||||
> NOTE: If you are part of the CCP-IT we will provide you another link for the configuration.
|
||||
### Register with Samply.Beam
|
||||
|
||||
Next, you need to configure a set of variables, specific for your site with not so high security concerns. You can clone the configuration template at [GitHub](https://github.com/samply/bridgehead-config). The confiugration of the bridgehead should be located in /etc/bridghead.
|
||||
Many Bridgehead services rely on the secure, performant and flexible messaging middleware called [Samply.Beam](https://github.com/samply/beam). You will need to register ("enroll") with Samply.Beam by creating a cryptographic key pair for your bridgehead:
|
||||
|
||||
``` shell
|
||||
sudo git clone https://github.com/samply/bridgehead-config.git /etc/bridgehead;
|
||||
cd /srv/docker/bridgehead
|
||||
sudo ./bridgehead enroll <PROJECT>
|
||||
```
|
||||
|
||||
After cloning or forking the repository you need to add value to the template. If you are a part of the CCP-IT you will get an already filled out config repo.
|
||||
... and follow the instructions on the screen. You should then be prompted to do the next step:
|
||||
|
||||
### Testing your bridgehead
|
||||
### Starting and stopping your Bridgehead
|
||||
|
||||
We recomend to run first with the start and stop script. If you have trouble starting the bridghead have a look at the troubleshooting section.
|
||||
If you followed the above steps, your Bridgehead should already be configured to autostart (via systemd). If you would like to start/stop manually:
|
||||
|
||||
Now you ready to run a bridgehead instance. The bridgehead scripts checks if your configuration is correct. To check if everything works, execute the following:
|
||||
``` shell
|
||||
/srv/docker/bridgehead/bridgehead start <Project>
|
||||
To start, run
|
||||
|
||||
```shell
|
||||
sudo systemctl start bridgehead@<PROJECT>.service
|
||||
```
|
||||
|
||||
You should now be able to access the landing page on your system, e.g "https://<your-host>/".
|
||||
To stop, run
|
||||
|
||||
To shutdown the bridgehead just run.
|
||||
``` shell
|
||||
/srv/docker/bridgehead/bridgehead stop <Project>
|
||||
```shell
|
||||
sudo systemctl stop bridgehead@<PROJECT>.service
|
||||
```
|
||||
|
||||
### Local Datamanagement Security
|
||||
To enable/disable autostart, run
|
||||
|
||||
For a server, we highly recommend that you install the system units for managing the bridgehead, provided by us. You can do this by executing the [bridgehead](./bridgehead) script:
|
||||
``` shell
|
||||
sudo /srv/docker/bridgehead/bridgehead install <Project>
|
||||
```shell
|
||||
sudo systemctl [enable|disable] bridgehead@<PROJECT>.service
|
||||
```
|
||||
|
||||
This will install the systemd units to run and update the bridghead. Also, this will generate a user and password for accessing the LDM. This will be shown only the first time you install the bridgehead.
|
||||
|
||||
### Basic Auth
|
||||
|
||||
For Data protection we use basic authentification for some services. To access those services you need an username and password combination.
|
||||
Caution: If you start the bridgehead without the authentification, then those services are not accessible.
|
||||
We generate such a combination at the first install (`/etc/bridgehead/<Project>.local.conf`).
|
||||
|
||||
## Configuration
|
||||
|
||||
#### systemd
|
||||
|
||||
|
||||
## Site-specific configuration
|
||||
|
||||
### HTTPS Access
|
||||
|
||||
We advise to use https for all service of your bridgehead. HTTPS is enabled on default. For starting the bridghead you need a ssl certificate. You can either create it yourself or get a signed one. You need to drop the certificates in /certs.
|
||||
Even within your internal network, the Bridgehead enforces HTTPS for all services. During the installation, a self-signed, long-lived certificate was created for you. To increase security, you can simply replace the files under `/etc/bridgehead/traefik-tls` with ones from established certification authorities such as [Let's Encrypt](https://letsencrypt.org) or [DFN-AAI](https://www.aai.dfn.de).
|
||||
|
||||
The bridgehead create one autotmatic on the first start. However, it will be unsigned and we recomend to get a signed one.
|
||||
### TLS terminating proxies
|
||||
|
||||
All of the Bridgehead's outgoing connections are secured by transport encryption (TLS) and a Bridgehead will refuse to connect if certificate verification fails. If your local forward proxy server performs TLS termination, please place its CA certificate in `/etc/bridgehead/trusted-ca-certs` as a `.pem` file, e.g. `/etc/bridgehead/trusted-ca-certs/mylocalca.pem`. Then, all Bridgehead components will pick up this certificate and trust it for outgoing connections.
|
||||
|
||||
### Locally Managed Secrets
|
||||
### File structure
|
||||
|
||||
This section describes the secrets you need to configure locally through the configuration
|
||||
- `/srv/docker/bridgehead` contains this git repository with the shell scripts and *project-specific configuration*. In here, all files are identical for all sites. You should not make any changes here.
|
||||
- `/etc/bridgehead` contains your *site-specific configuration* synchronized from your site-specific git repository as part of the [base installation](#base-installation). To change anything here, please consult your git repository (find out its URL via `git -C /etc/bridgehead remote -v`).
|
||||
- `/etc/bridgehead/<PROJECT>.conf` is your main site-specific configuration, all bundled into one concise config file. Do not change it here but via the central git repository.
|
||||
- `/etc/bridgehead/<PROJECT>.local.conf` contains site-specific parameters to be known to your Bridgehead only, e.g. local access credentials. The file is ignored via git, and you may edit it here via a text editor.
|
||||
- `/etc/bridgehead/traefik-tls` contains your Bridgehead's reverse proxies TLS certificates for [HTTPS access](#https-access).
|
||||
- `/etc/bridgehead/pki` contains your Bridgehead's private key (e.g., but not limited to Samply.Beam), generated as part of the [Samply.Beam enrollment](#register-with-samplybeam).
|
||||
- `/etc/bridgehead/trusted-ca-certs` contains third-party certificates to be trusted by the Bridgehead. For example, you want to place the certificates of your [TLS-terminating proxy](#network) here.
|
||||
|
||||
| Name | Recommended Value | Description |
|
||||
|--------------------------------------|---------------------------------------------------------------------------------------------------| ----------- |
|
||||
| HTTP_PROXY_USER | | Your local http proxy user |
|
||||
| HOSTIP | Compute with: `docker run --rm --add-host=host.docker.internal:host-gateway ubuntu cat /etc/hosts | grep 'host.docker.internal' | awk '{print $1}'` | The ip from which docker containers can reach your host system. |
|
||||
| HOST | Compute with: `hostname` |The hostname from which all components will eventually be available|
|
||||
| HTTP_PROXY_PASSWORD | |Your local http proxy user's password|
|
||||
| HTTPS_PROXY_USER | |Your local https proxy user|
|
||||
| HTTPS_PROXY_PASSWORD || Your local https proxy user's password |
|
||||
| CONNECTOR_POSTGRES_PASS | Random String |The password for your project specific connector.|
|
||||
| STORE_POSTGRES_PASS | Random String |The password for your local datamanagements database (only relevant in c4)|
|
||||
| ML_DB_PASS | Random String |The password for your local patientlist database|
|
||||
| MAGICPL_API_KEY | Random String |The apiKey used by the local datamanagement to create pseudonymes.|
|
||||
| MAGICPL_MAINZELLISTE_API_KEY | Random String |The apiKey used by the local id-manager to communicate with the local patientlist|
|
||||
| MAGICPL_API_KEY_CONNECTOR | Random String |The apiKey used by the connector to communicate with the local patientlist|
|
||||
| MAGICPL_MAINZELLISTE_CENTRAL_API_KEY | You need to ask the central patientlists admin for this. |The apiKey for your machine to communicate with the central patientlist|
|
||||
| MAGICPL_CENTRAL_API_KEY | You need to ask the central controlnumbergenerator admin for this. |The apiKey for your machine to communicate with the central controlnumbergenerator|
|
||||
| MAGICPL_OIDC_CLIENT_ID || The client id used for your machine, to connect with the central authentication service |
|
||||
| MAGICPL_OIDC_CLIENT_SECRET || The client secret used for your machine, to connect with the central authentication service |
|
||||
Your Bridgehead's actual data is not stored in the above directories, but in named docker volumes, see `docker volume ls` and `docker volume inspect <volume_name>`.
|
||||
|
||||
### Cooperatively Managed Secrets
|
||||
## Things you should know
|
||||
|
||||
> TODO: Describe secrets from site-config
|
||||
### Auto-Updates
|
||||
|
||||
## Managing your Bridgehead
|
||||
Your Bridgehead will automatically and regularly check for updates. Whenever something has been updates (e.g., one of the git repositories or one of the docker images), your Bridgehead is automatically restarted. This should happen automatically and does not need any configuration.
|
||||
|
||||
> TODO: Rewrite this section (restart, stop, uninstall, manual updates)
|
||||
If you would like to understand what happens exactly and when, please check the systemd units deployed during the [installation](#base-installation) via `systemctl cat bridgehead-update@<PROJECT>.service` and `systemctl cat bridgehead-update@<PROJECT.timer`.
|
||||
|
||||
### On a Server
|
||||
### Monitoring
|
||||
|
||||
#### Start
|
||||
To keep all Bridgeheads up and working and detect any errors before a user does, a central monitoring
|
||||
|
||||
This will start a not running bridgehead system unit:
|
||||
``` shell
|
||||
sudo systemctl start bridgehead@<dktk/c4/gbn>
|
||||
```
|
||||
- Your Bridgehead itself will report relevant system events, such as successful/failed updates, restarts, performance metrics or version numbers.
|
||||
- Your Bridgehead is also monitored from the outside by your network's central components. For example, the federated search will regularly perform a black-box test by sending an empty query to your Bridgehead and checking if the results make sense.
|
||||
|
||||
#### Stop
|
||||
In all monitoring cases, obviously no sensitive information is transmitted, in particular not any patient-related data. Aggregated data, e.g. total amount of datasets, may be transmitted for diagnostic purposes.
|
||||
|
||||
This will stop a running bridgehead system unit:
|
||||
``` shell
|
||||
sudo systemctl stop bridgehead@<dktk/c4/gbn>
|
||||
```
|
||||
|
||||
#### Update
|
||||
|
||||
This will update bridgehead system unit:
|
||||
``` shell
|
||||
sudo systemctl start bridgehead-update@<dktk/c4/gbn>
|
||||
```
|
||||
|
||||
#### Remove the Bridgehead System Units
|
||||
|
||||
If, for some reason you want to remove the installed bridgehead units, we added a command to [bridgehead](./bridgehead):
|
||||
``` shell
|
||||
sudo /srv/docker/bridgehead/bridgehead uninstall <project>
|
||||
```
|
||||
|
||||
### On Developers Machine
|
||||
|
||||
For developers, we provide additional scripts for starting and stopping the specif bridgehead:
|
||||
|
||||
#### Start or stop
|
||||
|
||||
This command starts a specified bridgehead. Choose between "dktk", "c4" and "gbn".
|
||||
``` shell
|
||||
/srv/docker/bridgehead/bridgehead start <dktk/c4/gbn>
|
||||
```
|
||||
|
||||
#### Stop
|
||||
|
||||
This command stops a specified bridgehead. Choose between "dktk", "c4" and "gbn".
|
||||
``` shell
|
||||
/srv/docker/bridgehead/bridgehead stop <dktk/c4/gbn>
|
||||
```
|
||||
|
||||
#### Update
|
||||
|
||||
This shell script updates the configuration for all bridgeheads installed on your system.
|
||||
``` shell
|
||||
/srv/docker/bridgehead/bridgehead update
|
||||
```
|
||||
> NOTE: If you want to regularly update your developing instance, you can create a CRON job that executes this script.
|
||||
|
||||
## Migration Guide
|
||||
|
||||
> TODO: How to transfer from windows/gbn
|
||||
|
||||
## Pitfalls
|
||||
|
||||
### [Git Proxy Configuration](https://gist.github.com/evantoli/f8c23a37eb3558ab8765)
|
||||
|
||||
Unlike most other tools, git doesn't use the default proxy variables "http_proxy" and "https_proxy". To make git use a proxy, you will need to adjust the global git configuration:
|
||||
|
||||
``` shell
|
||||
sudo git config --global http.proxy http://<your-proxy-host>:<your-proxy-port>;
|
||||
sudo git config --global https.proxy http://<your-proxy-host>:<your-proxy-port>;
|
||||
```
|
||||
> NOTE: Some proxies may require user and password authentication. You can adjust the settings like this: "http://<your-proxy-user>:<your-proxy-user-password>@<your-proxy-host>:<your-proxy-port>".
|
||||
> NOTE: It is also possible that a proxy requires https protocol, so you can replace this to.
|
||||
|
||||
You can check that the updated configuration with
|
||||
|
||||
``` shell
|
||||
sudo git config --global --list;
|
||||
```
|
||||
## Troubleshooting
|
||||
|
||||
### Docker Daemon Proxy Configuration
|
||||
|
||||
Docker has a background daemon, responsible for downloading images and starting them. To configure the proxy for this daemon, use the systemctl command:
|
||||
Docker has a background daemon, responsible for downloading images and starting them. Sometimes, proxy configuration from your system won't carry over and it will fail to download images. In that case, configure the proxy for this daemon as described in the [official documentation](https://docs.docker.com).
|
||||
|
||||
``` shell
|
||||
sudo systemctl edit docker
|
||||
```
|
||||
### Non-Linux OS
|
||||
|
||||
This will open your default editor allowing you to edit the docker system units configuration. Insert the following lines in the editor, replace <your-proxy-host> and <your-proxy-port> with the corresponding values for your machine and save the file:
|
||||
``` conf
|
||||
[Service]
|
||||
Environment=HTTP_PROXY=http://<your-proxy-host>:<your-proxy-port>
|
||||
Environment=HTTPS_PROXY=http://<your-proxy-host>:<your-proxy-port>
|
||||
Environment=FTP_PROXY=http://<your-proxy-host>:<your-proxy-port>
|
||||
```
|
||||
> NOTE: Some proxies may require user and password authentication. You can adjust the settings like this: "http://<your-proxy-user>:<your-proxy-user-password>@<your-proxy-host>:<your-proxy-port>".
|
||||
> NOTE: It is also possible that a proxy requires https protocol, so you can replace this to.
|
||||
The installation procedures described above have only been tested under Linux.
|
||||
|
||||
The file should now be at the location "/etc/systemd/system/docker.service.d/override.conf". You can proof check with
|
||||
``` shell
|
||||
cat /etc/systemd/system/docker.service.d/override.conf;
|
||||
```
|
||||
Below are some suggestions for getting the installation to work on other operating systems. Note that we are not able to provide support for these routes!
|
||||
|
||||
To make the configuration effective, you need to tell systemd to reload the configuration and restart the docker service:
|
||||
We believe that it is likely that installation would also work with FreeBSD and MacOS.
|
||||
|
||||
``` shell
|
||||
sudo systemctl daemon-reload;
|
||||
sudo systemctl restart docker;
|
||||
```
|
||||
Under Windows, you have 2 options:
|
||||
|
||||
## After the Installtion
|
||||
- Virtual machine
|
||||
- WSL
|
||||
|
||||
After starting your bridgehead, visit the landing page under the hostname. If you singed your own ssl certificate, there is probable an error message. However, you can accept it as exception.
|
||||
|
||||
On this page, there are all important links to each component, central and local.
|
||||
|
||||
### Connector Administration
|
||||
|
||||
The Connector administration panel allows you to set many of the parameters regulating your Bridgehead. Most especially, it is the place where you can register your site with the Sample Locator. To access this page, proceed as follows:
|
||||
|
||||
* Open the Connector page: https://<hostname>/<project>-connector/
|
||||
* In the "Local components" box, click the "Samply Share" button.
|
||||
* A new page will be opened, where you will need to log in using the administrator credentials (admin/adminpass by default).
|
||||
* After log in, you will be taken to the administration dashboard, allowing you to configure the Connector.
|
||||
* If this is the first time you have logged in as an administrator, you are strongly recommended to set a more secure password! You can use the "Users" button on the dashboard to do this.
|
||||
|
||||
### GBA/BBMRI-ERIC
|
||||
|
||||
#### Register with a Directory
|
||||
|
||||
The [Directory][directory] is a BBMRI project that aims to catalog all biobanks in Europe and beyond. Each biobank is given its own unique ID and the Directory maintains counts of the number of donors and the number of samples held at each biobank. You are strongly encouraged to register with the Directory, because this opens the door to further services, such as the [Negotiator][negotiator].
|
||||
|
||||
Generally, you should register with the BBMRI national node for the country where your biobank is based. You can find a list of contacts for the national nodes [here](http://www.bbmri-eric.eu/national-nodes/). If your country is not in this list, or you have any questions, please contact the [BBMRI helpdesk](mailto:directory@helpdesk.bbmri-eric.eu). If your biobank is for COVID samples, you can also take advantage of an accelerated registration process [here](https://docs.google.com/forms/d/e/1FAIpQLSdIFfxADikGUf1GA0M16J0HQfc2NHJ55M_E47TXahju5BlFIQ).
|
||||
|
||||
Your national node will give you detailed instructions for registering, but for your information, here are the basic steps:
|
||||
|
||||
* Log in to the Directory for your country.
|
||||
* Add your biobank and enter its details, including contact information for a person involved in running the biobank.
|
||||
* You will need to create at least one collection.
|
||||
* Note the biobank ID and the collection ID that you have created - these will be needed when you register with the Locator (see below).
|
||||
|
||||
#### Register with a Locator
|
||||
|
||||
* Go to the registration page http://localhost:8082/admin/broker_list.xhtml.
|
||||
* To register with a Locator, enter the following values in the three fields under "Join new Searchbroker":
|
||||
* "Address": Depends on which Locator you want to register with:
|
||||
* `https://locator.bbmri-eric.eu/broker/`: BBMRI Locator production service (European).
|
||||
* `http://147.251.124.125:8088/broker/`: BBMRI Locator test service (European).
|
||||
* `https://samplelocator.bbmri.de/broker/`: GBA Sample Locator production service (German).
|
||||
* `https://samplelocator.test.bbmri.de/broker/`: GBA Sample Locator test service (German).
|
||||
* "Your email address": this is the email to which the registration token will be returned.
|
||||
* "Automatic reply": Set this to be `Total Size`
|
||||
* Click "Join" to start the registration process.
|
||||
* You should now have a list containing exactly one broker. You will notice that the "Status" box is empty.
|
||||
* Send an email to `feedback@germanbiobanknode.de` and let us know which of our Sample Locators you would like to register to. Please include the biobank ID and the collection ID from your Directory registration, if you have these available.
|
||||
* We will send you a registration token per email.
|
||||
* You will then re-open the Connector and enter the token into the "Status" box.
|
||||
* You should send us an email to let us know that you have done this.
|
||||
* We will then complete the registration process
|
||||
* We will email you to let you know that your biobank is now visible in the Sample Locator.
|
||||
|
||||
If you are a Sample Locator administrator, you will need to understand the [registration process](./SampleLocatorRegistration.md). Normal bridgehead admins do not need to worry about this.
|
||||
We have tested the installation procedure with an Ubuntu 22.04 guest system running on a VMware virtual machine. That worked flawlessly.
|
||||
|
||||
Installation under WSL ought to work, but we have not tested this.
|
||||
|
||||
## License
|
||||
|
||||
|
|
|
|||
|
|
@ -93,16 +93,16 @@ services:
|
|||
APP_0_ID: spot
|
||||
APP_0_KEY: ${SPOT_BEAM_SECRET_SHORT}
|
||||
PRIVKEY_FILE: /run/secrets/proxy.pem
|
||||
RUST_LOG: debug
|
||||
ALL_PROXY: http://forward_proxy:3128
|
||||
TLS_CA_CERTIFICATES_DIR: /conf/trusted-ca-certs
|
||||
ROOTCERT_FILE: /conf/root.crt.pem
|
||||
secrets:
|
||||
- proxy.pem
|
||||
depends_on:
|
||||
- "forward_proxy"
|
||||
volumes:
|
||||
- /etc/bridgehead/trusted-ca-certs:/conf/trusted-ca-certs:ro
|
||||
|
||||
- ./root.crt.pem:/conf/root.crt.pem:ro
|
||||
|
||||
volumes:
|
||||
blaze-data:
|
||||
|
|
|
|||
|
|
@ -0,0 +1,20 @@
|
|||
-----BEGIN CERTIFICATE-----
|
||||
MIIDNTCCAh2gAwIBAgIUMy/n0zFRihhVR3aAD54LumzeYdwwDQYJKoZIhvcNAQEL
|
||||
BQAwFjEUMBIGA1UEAxMLQnJva2VyLVJvb3QwHhcNMjIxMDI1MDczNTA4WhcNMzIx
|
||||
MDIyMDczNTM3WjAWMRQwEgYDVQQDEwtCcm9rZXItUm9vdDCCASIwDQYJKoZIhvcN
|
||||
AQEBBQADggEPADCCAQoCggEBAL3qWliHIlIT1Qlsyq/NKJ1uj6/AF0STNg5NTNpb
|
||||
Xqe5rmUqs6jmQepputGStBVe5TthFw56whISv9FqD5s1PZUGyFikW1pJUnF7ZYRf
|
||||
MfrJHRi1vUnD3Gw36FCot+i6BAxfw/rdp9hoqFZ6erRkULLaYZ5S2cDHN0DWc18V
|
||||
3VgZ66ah8QXSx7ERRNa/eWRkHrPIYhyVSoKuyZfvbVgsYZADSlviCgIHPrGLerLr
|
||||
ylNUyuTxJ5RKStOwPn7A+Jp7nRT+MRh9BphA7s6NuK9h+eVe1DiLbIETWyCEfN3Y
|
||||
INpunatn3QDhqOIfNcuBArjsAj7mg8l5KNba8nUP4v0EJYECAwEAAaN7MHkwDgYD
|
||||
VR0PAQH/BAQDAgEGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFMvc5Fizz1vO
|
||||
MEG3MIsy7UY69ZNIMB8GA1UdIwQYMBaAFMvc5Fizz1vOMEG3MIsy7UY69ZNIMBYG
|
||||
A1UdEQQPMA2CC0Jyb2tlci1Sb290MA0GCSqGSIb3DQEBCwUAA4IBAQBb8a5su820
|
||||
h8JStJC+KpvXmDrGkwx9bHlEZMgQQejIrwPLEbA32KBvNxdoUxF9q1Y773MKdqbc
|
||||
cCJwzQXE/NPZ13hCGrEIXs8DgH52GhEB5592k5/bRNcAvUwbZSXPPiT0rgq/eUOt
|
||||
BYhgN0ov7h1MC5L6CYB/rQwqck7JPlmrXTkh2gix4/dEdBRzsHsn/xlo8ay5QYHG
|
||||
rx2Adit76eZu/MJoJNzl1r8MPxLqyAie3KcIU54A+UMozLrWEQP/TyOyWZdjUjJt
|
||||
cBYgkKJTjwdRhc+ehI3kFo7b/a/Z/jl9szKsAPHozMixSi8lGnsYwN80oqeRvT7h
|
||||
wcMUK+igv3/K
|
||||
-----END CERTIFICATE-----
|
||||
52
bridgehead
52
bridgehead
|
|
@ -29,9 +29,6 @@ case "$PROJECT" in
|
|||
ccp)
|
||||
#nothing extra to do
|
||||
;;
|
||||
nngm)
|
||||
#nothing extra to do
|
||||
;;
|
||||
bbmri)
|
||||
#nothing extra to do
|
||||
;;
|
||||
|
|
@ -41,28 +38,30 @@ case "$PROJECT" in
|
|||
;;
|
||||
esac
|
||||
|
||||
# Load variables from /etc/bridgehead and /srv/docker/bridgehead
|
||||
set -a
|
||||
source /etc/bridgehead/$PROJECT.conf || fail_and_report 1 "/etc/bridgehead/$PROJECT.conf not found"
|
||||
if [ -e /etc/bridgehead/$PROJECT.local.conf ]; then
|
||||
log INFO "Applying /etc/bridgehead/$PROJECT.local.conf"
|
||||
source /etc/bridgehead/$PROJECT.local.conf || fail_and_report 1 "Found /etc/bridgehead/$PROJECT.local.conf but failed to import"
|
||||
fi
|
||||
fetchVarsFromVaultByFile /etc/bridgehead/$PROJECT.conf || fail_and_report 1 "Unable to fetchVarsFromVaultByFile"
|
||||
[ -e ./$PROJECT/vars ] && source ./$PROJECT/vars
|
||||
set +a
|
||||
loadVars() {
|
||||
# Load variables from /etc/bridgehead and /srv/docker/bridgehead
|
||||
set -a
|
||||
source /etc/bridgehead/$PROJECT.conf || fail_and_report 1 "/etc/bridgehead/$PROJECT.conf not found"
|
||||
if [ -e /etc/bridgehead/$PROJECT.local.conf ]; then
|
||||
log INFO "Applying /etc/bridgehead/$PROJECT.local.conf"
|
||||
source /etc/bridgehead/$PROJECT.local.conf || fail_and_report 1 "Found /etc/bridgehead/$PROJECT.local.conf but failed to import"
|
||||
fi
|
||||
fetchVarsFromVaultByFile /etc/bridgehead/$PROJECT.conf || fail_and_report 1 "Unable to fetchVarsFromVaultByFile"
|
||||
[ -e ./$PROJECT/vars ] && source ./$PROJECT/vars
|
||||
set +a
|
||||
|
||||
OVERRIDE=${OVERRIDE:=""}
|
||||
if [ -f "$PROJECT/docker-compose.override.yml" ]; then
|
||||
log INFO "Applying $PROJECT/docker-compose.override.yml"
|
||||
OVERRIDE+=" -f ./$PROJECT/docker-compose.override.yml"
|
||||
fi
|
||||
|
||||
detectCompose
|
||||
setHostname
|
||||
OVERRIDE=${OVERRIDE:=""}
|
||||
if [ -f "$PROJECT/docker-compose.override.yml" ]; then
|
||||
log INFO "Applying $PROJECT/docker-compose.override.yml"
|
||||
OVERRIDE+=" -f ./$PROJECT/docker-compose.override.yml"
|
||||
fi
|
||||
detectCompose
|
||||
setHostname
|
||||
}
|
||||
|
||||
case "$ACTION" in
|
||||
start)
|
||||
loadVars
|
||||
hc_send log "Bridgehead $PROJECT startup: Checking requirements ..."
|
||||
checkRequirements
|
||||
hc_send log "Bridgehead $PROJECT startup: Requirements checked out. Now starting bridgehead ..."
|
||||
|
|
@ -70,20 +69,25 @@ case "$ACTION" in
|
|||
exec $COMPOSE -f ./$PROJECT/docker-compose.yml $OVERRIDE up --abort-on-container-exit
|
||||
;;
|
||||
stop)
|
||||
loadVars
|
||||
exec $COMPOSE -f ./$PROJECT/docker-compose.yml $OVERRIDE down
|
||||
;;
|
||||
update)
|
||||
loadVars
|
||||
exec ./lib/update-bridgehead.sh $PROJECT
|
||||
;;
|
||||
install)
|
||||
exec ./lib/setup-bridgehead-units.sh $PROJECT
|
||||
source ./lib/prepare-system.sh
|
||||
loadVars
|
||||
exec ./lib/install-bridgehead.sh $PROJECT
|
||||
;;
|
||||
uninstall)
|
||||
exec ./lib/remove-bridgehead-units.sh $PROJECT
|
||||
exec ./lib/uninstall-bridgehead.sh $PROJECT
|
||||
;;
|
||||
enroll)
|
||||
loadVars
|
||||
if [ -e $PRIVATEKEYFILENAME ]; then
|
||||
echo "Private key already exists at $PRIVATEKEYFILENAME. Please delete first to proceed."
|
||||
log ERROR "Private key already exists at $PRIVATEKEYFILENAME. Please delete first to proceed."
|
||||
exit 1
|
||||
fi
|
||||
docker run --rm -ti -v /etc/bridgehead/pki:/etc/bridgehead/pki samply/beam-enroll:latest --output-file $PRIVATEKEYFILENAME --proxy-id $PROXY_ID --admin-email $SUPPORT_EMAIL
|
||||
|
|
|
|||
|
|
@ -97,15 +97,17 @@ services:
|
|||
APP_2_ID: monitoring
|
||||
APP_2_KEY: ${MONITORING_BEAM_SECRET_SHORT}
|
||||
PRIVKEY_FILE: /run/secrets/proxy.pem
|
||||
RUST_LOG: debug
|
||||
ALL_PROXY: http://forward_proxy:3128
|
||||
TLS_CA_CERTIFICATES_DIR: /conf/trusted-ca-certs
|
||||
ROOTCERT_FILE: /conf/root.crt.pem
|
||||
secrets:
|
||||
- proxy.pem
|
||||
depends_on:
|
||||
- "forward_proxy"
|
||||
volumes:
|
||||
- /etc/bridgehead/trusted-ca-certs:/conf/trusted-ca-certs:ro
|
||||
- ./root.crt.pem:/conf/root.crt.pem:ro
|
||||
|
||||
monitoring:
|
||||
image: "samply/bridgehead-monitoring:main"
|
||||
container_name: bridgehead-monitoring
|
||||
|
|
|
|||
|
|
@ -0,0 +1,20 @@
|
|||
-----BEGIN CERTIFICATE-----
|
||||
MIIDNTCCAh2gAwIBAgIUMeGRSrNPhRdQ1tU7uK5+lUa4f38wDQYJKoZIhvcNAQEL
|
||||
BQAwFjEUMBIGA1UEAxMLQnJva2VyLVJvb3QwHhcNMjIwOTI5MTQxMjU1WhcNMzIw
|
||||
OTI2MTQxMzI1WjAWMRQwEgYDVQQDEwtCcm9rZXItUm9vdDCCASIwDQYJKoZIhvcN
|
||||
AQEBBQADggEPADCCAQoCggEBAMYyroOUeb27mYzClOrjCmgIceLalsFA0aVCh5mZ
|
||||
KtP8+1U3oq/7exP30gXiJojxW7xoerfyQY9s0Sz5YYbxYbuskFOYEtyAILB/pxgd
|
||||
+k+J3tlZKolpfmo7WT5tZiHxH/zjrtAYGnuB2xPHRMCWh/tHYrELgXQuilNol24y
|
||||
GBa1plTlARy0aKEDUHp87WLhD2qH7B8sFlLgo0+gunE1UtR2HMSPF45w3VXszyG6
|
||||
fJNrAj0yPnKy3Dm1BMO3jDO2e0A9lCQ71a4j4TeKePfCk1xCArSu6PpiwiacKplF
|
||||
c6CRR6KrWVm2g+8Y2hFcOBG/Py2xusm3PWbpylGq6vtFRkkCAwEAAaN7MHkwDgYD
|
||||
VR0PAQH/BAQDAgEGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFEFxD6BQwQO5
|
||||
xsJ+3cvZypsnh6dDMB8GA1UdIwQYMBaAFEFxD6BQwQO5xsJ+3cvZypsnh6dDMBYG
|
||||
A1UdEQQPMA2CC0Jyb2tlci1Sb290MA0GCSqGSIb3DQEBCwUAA4IBAQB5zTeIhV/3
|
||||
3Am6O144EFtnIeaZ2w0D6aEHqHAZp50vJv3+uQfOliCOzgw7VDxI4Zz2JALjlR/i
|
||||
uOYHsu3YIRMIOmPOjqrdDJa6auB0ufL4oUPfCRln7Fh0f3JVlz3BUoHsSDt949p4
|
||||
g0nnsciL2JHuzlqjn7Jyt3L7dAHrlFKulCcuidG5D3cqXrRCbF83f+k3TC/HRiNd
|
||||
25oMi7I4MP/SOCdfQGUGIsHIf/0hSm3pNjDOrC/XuI/8gh2f5io+Y8V+hMwMBcm4
|
||||
JbH8bdyBB+EIhsNbTwf2MWntD5bmg47sf7hh23aNvKXI67Li1pTI2t1CqiGnFR0U
|
||||
fCEpeaEAHs0k
|
||||
-----END CERTIFICATE-----
|
||||
|
|
@ -1,7 +1,5 @@
|
|||
#!/bin/bash -e
|
||||
|
||||
source lib/log.sh
|
||||
|
||||
detectCompose() {
|
||||
if [[ "$(docker compose version 2>/dev/null)" == *"Docker Compose version"* ]]; then
|
||||
COMPOSE="docker compose"
|
||||
|
|
@ -37,11 +35,11 @@ checkOwner(){
|
|||
|
||||
printUsage() {
|
||||
echo "Usage: bridgehead start|stop|update|install|uninstall|enroll PROJECTNAME"
|
||||
echo "PROJECTNAME should be one of ccp|nngm|bbmri"
|
||||
echo "PROJECTNAME should be one of ccp|bbmri"
|
||||
}
|
||||
|
||||
checkRequirements() {
|
||||
if ! lib/prerequisites.sh; then
|
||||
if ! lib/prerequisites.sh $@; then
|
||||
log "ERROR" "Validating Prerequisites failed, please fix the error(s) above this line."
|
||||
fail_and_report 1 "Validating prerequisites failed."
|
||||
else
|
||||
|
|
@ -120,8 +118,10 @@ fixPermissions() {
|
|||
source lib/monitoring.sh
|
||||
|
||||
report_error() {
|
||||
log ERROR "$2"
|
||||
hc_send $1 "$2"
|
||||
CODE=$1
|
||||
shift
|
||||
log ERROR "$@"
|
||||
hc_send $CODE "$@"
|
||||
}
|
||||
|
||||
fail_and_report() {
|
||||
|
|
@ -136,6 +136,28 @@ setHostname() {
|
|||
fi
|
||||
}
|
||||
|
||||
# from: https://gist.github.com/sj26/88e1c6584397bb7c13bd11108a579746
|
||||
# ex. use: retry 5 /bin/false
|
||||
function retry {
|
||||
local retries=$1
|
||||
shift
|
||||
|
||||
local count=0
|
||||
until "$@"; do
|
||||
exit=$?
|
||||
wait=$((2 ** $count))
|
||||
count=$(($count + 1))
|
||||
if [ $count -lt $retries ]; then
|
||||
echo "Retry $count/$retries exited with code $exit, retrying in $wait seconds..."
|
||||
sleep $wait
|
||||
else
|
||||
echo "Retry $count/$retries exited with code $exit, giving up."
|
||||
return $exit
|
||||
fi
|
||||
done
|
||||
return 0
|
||||
}
|
||||
|
||||
##Setting Network properties
|
||||
# currently not needed
|
||||
#export HOSTIP=$(MSYS_NO_PATHCONV=1 docker run --rm --add-host=host.docker.internal:host-gateway ubuntu cat /etc/hosts | grep 'host.docker.internal' | awk '{print $1}');
|
||||
|
|
|
|||
|
|
@ -9,14 +9,9 @@ if [ $# -eq 0 ]; then
|
|||
exit 1
|
||||
fi
|
||||
|
||||
if [ $1 != "ccp" ] && [ $1 != "nngm" ] && [ $1 != "bbmri" ]; then
|
||||
log "ERROR" "Please provide a supported project like ccp, bbmri or nngm"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
export PROJECT=$1
|
||||
|
||||
checkRequirements
|
||||
checkRequirements noprivkey
|
||||
|
||||
log "INFO" "Allowing the bridgehead user to start/stop the bridgehead."
|
||||
|
||||
|
|
@ -33,7 +28,7 @@ Cmnd_Alias BRIDGEHEAD${PROJECT^^} = \\
|
|||
bridgehead ALL= NOPASSWD: BRIDGEHEAD${PROJECT^^}
|
||||
EOF
|
||||
|
||||
# TODO: Determine wether this should be located in setup-bridgehead (triggered through bridgehead install) or in update bridgehead (triggered every hour)
|
||||
# TODO: Determine whether this should be located in setup-bridgehead (triggered through bridgehead install) or in update bridgehead (triggered every hour)
|
||||
if [ -z "$LDM_PASSWORD" ]; then
|
||||
log "INFO" "Now generating a password for the local data management. Please save the password for your ETL process!"
|
||||
generated_passwd="$(cat /proc/sys/kernel/random/uuid | sed 's/[-]//g' | head -c 32)"
|
||||
|
|
@ -42,7 +37,7 @@ if [ -z "$LDM_PASSWORD" ]; then
|
|||
echo -e "## Local Data Management Basic Authentication\n# User: $PROJECT\nLDM_PASSWORD=$generated_passwd" >> /etc/bridgehead/${PROJECT}.local.conf;
|
||||
fi
|
||||
|
||||
log "INFO" "Register system units for bridgehead and bridgehead-update"
|
||||
log "INFO" "Registering system units for bridgehead and bridgehead-update"
|
||||
cp -v \
|
||||
lib/systemd/bridgehead\@.service \
|
||||
lib/systemd/bridgehead-update\@.service \
|
||||
|
|
@ -61,4 +56,11 @@ systemctl enable bridgehead@"${PROJECT}".service
|
|||
log "INFO" "Enabling auto-updates for bridgehead@${PROJECT}.service ..."
|
||||
systemctl enable --now bridgehead-update@"${PROJECT}".timer
|
||||
|
||||
log "INFO" "\nSuccess - now start your bridgehead by running\n systemctl start bridgehead@${PROJECT}.service\n or by rebooting your machine."
|
||||
STR="\n\n systemctl start bridgehead@${PROJECT}.service\n\nor by rebooting your machine."
|
||||
if [ -e /etc/bridgehead/pki/${SITE_ID}.priv.pem ]; then
|
||||
STR="Success. Next, start your bridgehead by running$STR"
|
||||
else
|
||||
STR="Success. Next, enroll into the $PROJECT broker by creating a cryptographic certificate. To do so, run\n\n /srv/docker/bridgehead/bridgehead enroll $PROJECT\n\nThen, you may start the bridgehead by running$STR"
|
||||
fi
|
||||
|
||||
log "INFO" "$STR"
|
||||
|
|
@ -1,5 +1,7 @@
|
|||
#!/bin/bash
|
||||
|
||||
log() {
|
||||
echo -e "$(date +'%Y-%m-%d %T')" "$1:" "$2"
|
||||
SEVERITY="$1"
|
||||
shift
|
||||
echo -e "$(date +'%Y-%m-%d %T')" "$SEVERITY:" "$@"
|
||||
}
|
||||
|
|
|
|||
|
|
@ -14,15 +14,16 @@ UPTIME=
|
|||
USER_AGENT=
|
||||
|
||||
function hc_send(){
|
||||
BASEURL="https://healthchecks.verbis.dkfz.de/ping"
|
||||
if [ -n "$MONITOR_APIKEY" ]; then
|
||||
hc_set_uuid $MONITOR_APIKEY
|
||||
fi
|
||||
|
||||
if [ -n "$HCSERVICE" ]; then
|
||||
HCURL="https://hc-ping.com/$PING_KEY/$HCSERVICE"
|
||||
HCURL="$BASEURL/$PING_KEY/$HCSERVICE"
|
||||
fi
|
||||
if [ -n "$HCUUID" ]; then
|
||||
HCURL="https://hc-ping.com/$HCUUID"
|
||||
HCURL="$BASEURL/$HCUUID"
|
||||
fi
|
||||
if [ ! -n "$HCURL" ]; then
|
||||
log WARN "Did not report Healthcheck: Neither Healthcheck UUID nor service set. Please define MONITOR_APIKEY in /etc/bridgehead."
|
||||
|
|
@ -34,8 +35,13 @@ function hc_send(){
|
|||
fi
|
||||
|
||||
if [ -z "$USER_AGENT" ]; then
|
||||
COMMIT_ETC=$(git -C /etc/bridgehead rev-parse HEAD | cut -c -8)
|
||||
COMMIT_SRV=$(git -C /srv/docker/bridgehead rev-parse HEAD | cut -c -8)
|
||||
if [ "$USER" != "root" ]; then
|
||||
COMMIT_ETC=$(git -C /etc/bridgehead rev-parse HEAD | cut -c -8)
|
||||
COMMIT_SRV=$(git -C /srv/docker/bridgehead rev-parse HEAD | cut -c -8)
|
||||
else
|
||||
COMMIT_ETC=$(su -c 'git -C /etc/bridgehead rev-parse HEAD' bridgehead | cut -c -8)
|
||||
COMMIT_SRV=$(su -c 'git -C /srv/docker/bridgehead rev-parse HEAD' bridgehead | cut -c -8)
|
||||
fi
|
||||
USER_AGENT="srv:$COMMIT_SRV etc:$COMMIT_ETC"
|
||||
fi
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,67 @@
|
|||
#!/bin/bash -e
|
||||
|
||||
source lib/log.sh
|
||||
source lib/functions.sh
|
||||
|
||||
log "INFO" "Preparing your system for bridgehead installation ..."
|
||||
|
||||
# Create the bridgehead user
|
||||
if id bridgehead &>/dev/null; then
|
||||
log "INFO" "Existing user with id $(id -u bridgehead) will be used by the bridgehead system units."
|
||||
else
|
||||
log "INFO" "Now creating a system user to own the bridgehead's files."
|
||||
useradd -M -g docker -N bridgehead || fail_and_report ""
|
||||
fi
|
||||
|
||||
# Clone the OpenSource repository of bridgehead
|
||||
bridgehead_repository_url="https://github.com/samply/bridgehead.git"
|
||||
if [ -d "/srv/docker/bridgehead" ]; then
|
||||
current_owner=$(stat -c '%U' /srv/docker/bridgehead)
|
||||
if [ "$(su -c 'git -C /srv/docker/bridgehead remote get-url origin' $current_owner)" == "$bridgehead_repository_url" ]; then
|
||||
log "INFO" "Bridgehead's open-source repository has been found at /srv/docker/bridgehead"
|
||||
else
|
||||
log "ERROR" "The directory /srv/docker/bridgehead seems to exist, but doesn't contain a clone of $bridgehead_repository_url\nPlease delete the directory and try again."
|
||||
exit 1
|
||||
fi
|
||||
else
|
||||
log "INFO" "Cloning $bridgehead_repository_url to /srv/docker/bridgehead"
|
||||
mkdir -p /srv/docker/
|
||||
git clone bridgehead_repository_url /srv/docker/bridgehead
|
||||
fi
|
||||
|
||||
case "$PROJECT" in
|
||||
ccp)
|
||||
site_configuration_repository_middle="git.verbis.dkfz.de/bridgehead-configurations/bridgehead-config-"
|
||||
;;
|
||||
bbmri)
|
||||
site_configuration_repository_middle="git.verbis.dkfz.de/bbmri-bridgehead-configs/"
|
||||
;;
|
||||
*)
|
||||
log ERROR "Internal error, this should not happen."
|
||||
exit 1
|
||||
;;
|
||||
esac
|
||||
|
||||
# Clone the site-configuration
|
||||
if [ -d /etc/bridgehead ]; then
|
||||
current_owner=$(stat -c '%U' /etc/bridgehead)
|
||||
if [ "$(su -c 'git -C /etc/bridgehead remote get-url origin' $current_owner | grep $site_configuration_repository_middle)" ]; then
|
||||
log "INFO" "Your site config repository in /etc/bridgehead seems to be installed correctly."
|
||||
else
|
||||
log "WARN" "Your site configuration repository in /etc/bridgehead seems to have another origin than git.verbis.dkfz.de. Please check if the repository is correctly cloned!"
|
||||
fi
|
||||
else
|
||||
log "INFO" "Now cloning your site configuration repository for you."
|
||||
read -p "Please enter your site: " site
|
||||
read -s -p "Please enter the bridgehead's access token for your site configuration repository (will not be echoed): " access_token
|
||||
site_configuration_repository_url="https://bytoken:${access_token}@${site_configuration_repository_middle}$(echo $site | tr '[:upper:]' '[:lower:]').git"
|
||||
git clone $site_configuration_repository_url /etc/bridgehead
|
||||
if [ $? -gt 0 ]; then
|
||||
log "ERROR" "Unable to clone your configuration repository. Please obtain correct access data and try again."
|
||||
fi
|
||||
fi
|
||||
|
||||
chown -R bridgehead /etc/bridgehead /srv/docker/bridgehead
|
||||
|
||||
log INFO "System preparation is completed and private key is present."
|
||||
|
||||
|
|
@ -5,11 +5,11 @@ source lib/functions.sh
|
|||
detectCompose
|
||||
|
||||
if ! id "bridgehead" &>/dev/null; then
|
||||
log ERROR "User bridgehead does not exist. Please consult readme for installation."
|
||||
log ERROR "User bridgehead does not exist. Please run bridgehead install $PROJECT"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
checkOwner . bridgehead || exit 1
|
||||
checkOwner /srv/docker/bridgehead bridgehead || exit 1
|
||||
checkOwner /etc/bridgehead bridgehead || exit 1
|
||||
|
||||
## Check if user is a su
|
||||
|
|
@ -62,16 +62,22 @@ if [ -e /etc/bridgehead/vault.conf ]; then
|
|||
fi
|
||||
fi
|
||||
|
||||
log INFO "Checking your beam proxy private key"
|
||||
checkPrivKey() {
|
||||
if [ -e /etc/bridgehead/pki/${SITE_ID}.priv.pem ]; then
|
||||
log INFO "Success - private key found."
|
||||
else
|
||||
log ERROR "Unable to find private key at /etc/bridgehead/pki/${SITE_ID}.priv.pem. To fix, please run\n bridgehead enroll ${PROJECT}\nand follow the instructions."
|
||||
return 1
|
||||
fi
|
||||
log INFO "Success - all prerequisites are met!"
|
||||
hc_send log "Success - all prerequisites are met!"
|
||||
return 0
|
||||
}
|
||||
|
||||
if [ -e /etc/bridgehead/pki/${SITE_ID}.priv.pem ]; then
|
||||
log INFO "Success - private key found."
|
||||
if [[ "$@" =~ "noprivkey" ]]; then
|
||||
log INFO "Skipping check for private key for now."
|
||||
else
|
||||
log ERROR "Unable to find private key at /etc/bridgehead/pki/${SITE_ID}.priv.pem. To fix, please run bridgehead enroll ${PROJECT} and follow the instructions".
|
||||
exit 1
|
||||
checkPrivKey || exit 1
|
||||
fi
|
||||
|
||||
log INFO "Success - all prerequisites are met!"
|
||||
hc_send log "Success - all prerequisites are met!"
|
||||
|
||||
exit 0
|
||||
|
|
|
|||
|
|
@ -7,11 +7,6 @@ if [ $# -eq 0 ]; then
|
|||
exit 1
|
||||
fi
|
||||
|
||||
if [ $1 != "ccp" ] && [ $1 != "nngm" ] && [ $1 != "bbmri" ]; then
|
||||
log "ERROR" "Please provide a supported project like ccp, bbmri or nngm"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
export PROJECT=$1
|
||||
|
||||
#checkRequirements // not needed when uninstalling
|
||||
|
|
@ -38,7 +38,6 @@ for DIR in /etc/bridgehead $(pwd); do
|
|||
log "INFO" "Checking for updates to git repo $DIR ..."
|
||||
OUT="$(git -C $DIR status --porcelain)"
|
||||
if [ -n "$OUT" ]; then
|
||||
log WARN "The working directory $DIR is modified. Changed files: $OUT"
|
||||
report_error log "The working directory $DIR is modified. Changed files: $OUT"
|
||||
fi
|
||||
if [ "$(git -C $DIR config --get credential.helper)" != "$CREDHELPER" ]; then
|
||||
|
|
@ -48,10 +47,10 @@ for DIR in /etc/bridgehead $(pwd); do
|
|||
old_git_hash="$(git -C $DIR rev-parse --verify HEAD)"
|
||||
if [ -z "$HTTP_PROXY_URL" ]; then
|
||||
log "INFO" "Git is using no proxy!"
|
||||
OUT=$(git -C $DIR fetch 2>&1 && git -C $DIR pull 2>&1)
|
||||
OUT=$(retry 5 git -C $DIR fetch 2>&1 && retry 5 git -C $DIR pull 2>&1)
|
||||
else
|
||||
log "INFO" "Git is using proxy ${HTTP_PROXY_URL} from ${CONFFILE}"
|
||||
OUT=$(git -c http.proxy=$HTTP_PROXY_URL -c https.proxy=$HTTPS_PROXY_URL -C $DIR fetch 2>&1 && git -c http.proxy=$HTTP_PROXY_URL -c https.proxy=$HTTPS_PROXY_URL -C $DIR pull 2>&1)
|
||||
OUT=$(retry 5 git -c http.proxy=$HTTP_PROXY_URL -c https.proxy=$HTTPS_PROXY_URL -C $DIR fetch 2>&1 && retry 5 git -c http.proxy=$HTTP_PROXY_URL -c https.proxy=$HTTPS_PROXY_URL -C $DIR pull 2>&1)
|
||||
fi
|
||||
if [ $? -ne 0 ]; then
|
||||
report_error log "Unable to update git $DIR: $OUT"
|
||||
|
|
|
|||
Loading…
Reference in New Issue