Server Installation
Host system
You will need some kind of server to run the platform on.Minimum specs:OS: Ubuntu 20.04/22.04, Ubuntu Server 20.04/22.04 or AlmaLinux 9.3
CPU: 8 cores (recommended 16+)
RAM: 64GB+ (recommended 128GB+)
Storage for application-data (fast-dir): 100GB (recommended >200GB)
Storage for imaging-data (slow-dir): depends on your needs
Access to a container registry (online) or a prebuild installer and tarball (offline)
Before proceeding with further installation steps, make sure you have access either to container registry or image tarball and microk8s installer installer visit Build Kaapana.
Hint
Accessing container Registry or Tarball with Pre-built ContainersIf you are interested in exploring our platform, we encourage you to get in touch with us (Contact). Should you choose to do so, we will gladly offer you two options for accessing it. You can either receive credentials for our container registry or receive a tarball that includes the necessary containers. With these options, you can directly deploy the platform without the need to go through the building process.To provide the services in Kaapana, the corresponding containers are needed. These can be looked at as normal binaries of Kaapana and therefore only need to be built if you do not have access to already built containers via a container registry or a tarball.
Server Config
Port Configuration
In the default configuration the following ports are opened for incoming traffic on the system
Port |
Protocol |
Description |
---|---|---|
80 |
HTTP |
Redirect to HTTPS port 443 |
443 |
HTTPS |
Web Interface of the Platform (Interaction, File Upload, APIs) |
11112 |
DIMSE |
DICOM C-STORE SCP to send images to the platform |
Attention
Proxy
If you need to configure a proxy in your institution to access the internet, you can do this as follows:
Open /etc/environment on your deployment server:
nano /etc/environment
Insert the proxy variables for the proxy in your institution
http_proxy="your.proxy.url:port" https_proxy="your.proxy.url:port" HTTP_PROXY="your.proxy.url:port" HTTPS_PROXY="your.proxy.url:port"
Logout
logout
and login againYour network connection is working if you can reach the dkfz website or any other website:
curl www.dkfz-heidelberg.de
Custom DNS Server
You can configure a custom DNS
my.custom.dns
by executing:
sed -i 's/DNS=""/DNS="my.custom.dns"/' ./kaapana/server-installation/server_installation.sh
If not set manually, the DNS will be configured according to system information.
Installation of Server Dependencies
This part describes the preparation of the host system for Kaapana. Besides a few required software packages, mainly Microk8s is installed, to setup Kubernetes.
Hint
nvidia-smi
command is working as expected!Before the example platform “Kaapana-platform” can be deployed, all dependencies must be installed on the server. To do this, you can use the server-installation-script.
Hint
server_installation.sh
script from Github.Copy the script to your target-system (server)
Script location:
kaapana/server-installation/
Script location:kaapana/build/microk8s-offline-installer/
The directory is created in Build Kaapana.Copy the whole directory, as it contains installers for microk8s and helm.Make it executable:
chmod +x server_installation.sh
Execute the server installation script:
sudo ./server_installation.sh
Use--offline
flag.sudo ./server_installation.sh --offline
Note
On Almalinux it is recommended to set -E flag to preserve user’s environmental variables.sudo -E ./server_installation.sh
Reboot the system
sudo reboot
(optional) Enable GPU support for Microk8s
sudo ./server_installation.sh -gpu
Hint
sudo ./server_installation.sh --uninstall