DE EN EN (Google)

Requirements

Software under Debian and Ubuntu

Docker at least in version 1.11.

Versions with the newer version scheme (e.g. 17.03) are all recent enough.

The Community Edition (CE) is quite sufficient. We recommend the “stable” channel and assume the default architecture x86_64.

If we are installing the easydb for you then we will also install Docker ourselves. But please make sure that the requirements for Docker are met.

Here is a link to the installation guide for Docker under e.g. Debian.

Software under Red Hat Enterprise Linux 8.1

podman (docker replacement)

For details, e.g. the dnsname plugin for podman, see our installation guide.

Operating system

Linux kernel-version 3.17 is a minimum requirement. We recommend at least Debian 9, Ubuntu 16.04, RHEL 8.1.

The selection of the operating system depends on Docker. There are, however, the following exceptions:

We do not make separate tests for “Docker for Windows” or Docker on Mac OSX and have not measured the amount of performance degradation by the additional virtualization.

Are you interested in directly downloading a recommended operating system?

  1. Go to http://cdimage.debian.org/debian-cd/current/amd64/iso-cd
  2. Download the file that starts with debian-1 and ends with -amd64-netinst.iso.

 

Hardware

CPU & RAM

4 processor cores,

16 GB of RAM,

Example calculation:

easydb5 has 1234567 Records

So you have to calculate the following:

CPU: 1234567 / 250000 = 4,9 --> 5
RAM: 1234567 / 250000 = 4,9 --> 5

CPU: 5   +  4 =  9 Cores
RAM: 5*4 + 16 = 36 GB RAM

Please keep in mind that this is only a guideline and the number of resources needed depends on many factors.

Docker may have further requirements, e.g. 64 bit processor cores. These are mentioned in the Docker installation guide.

Storage

Storage space:

Storage Requirements Assets Preview Versions SQL DB Elasticsearch DB
 Small example 60 GB 20 GB 1,5 GB 0,07 GB
 Large example 15,000 GB 15,000 GB 224 GB 180 GB
 Rule of thumb 100% of assets 100% of assets 2% of assets 2% of assets
(… continued) easydb software (docker) SQL dumps temporary files
Small example 18 GB 0,3 GB 0 GB
Large example 54 GB 53 GB 32 GB
Rule of thumb 60 GB 1% of assets 50 GB

Network Storage

If you use network storage then we recommend the NFS protocol. CIFS can also work, but we have seen performance problems on some Windows servers without remedy and even data corruption - thus we do not support CIFS/SMB. Also NFS on a Windows server has been observed to have poor performance compared to Linux servers.

At most, put assets, previews and database dumps on network storage.

Filesystem Layout

Assumptions: 1000 GB assets, base directory (“data store”) is /srv/easydb

Example “separated by storage type without getting too much into details”:

storage space directory candidate for …
90 GB /
100 GB /srv/easydb fast storage
2000 GB /srv/easydb/eas/lib/assets network storage

Probably only the latter two storage types need to grow, if you add more assets later.

Example “maximum separation”:

storage space directory candidate for …
30 GB /
1 GB /boot
60 GB /var/lib/docker fast storage (low priority)
50 GB /srv/easydb/eas/tmp fast storage (low priority)
20 GB /srv/easydb/elasticsearch/var fast storage (high priority)
20 GB /srv/easydb/pgsql/var fast storage (high priority)
10 GB /srv/easydb/pgsql/backup network storage
2000 GB /srv/easydb/eas/lib/assets network storage

 

Network

The domain name (“URL”) of the easydb should be known during installation, so that it can be configured right away. It can be changed later and more addresses can be added later. One domain name is the primary, however, and is used for image URLs. If you use https at all then the primary domain must also have https.

easydb needs a domain or subdomain of its own. Or an IP address.

For example “https://media.example.com” or “http://1.2.3.4” but not “https://example.com/media”.

The “/media” part of the URL is called “path”. A static path is not supported by easydb, instead it generates a multitude of paths itself dynamically during use.

The easydb also communicates with its users via e-mail.

 

Firewall

Among firewall software, we only know of one that is compatible with docker’s firewall rules: shorewall with at least version 5.2.1.1

Therefore if there has to be a firewall on your easydb host, we only support this one.

Connections during installation

Specifically, if we are installing on one of your servers, the following connections should be allowed.

If these are not possible, we still have at least two alternative approaches: You can install on your server; or we install on our servers (which then needs a hosting contract).

Connections to the server

For installation, maintenance and monitoring we need SSH access to the server.

Our approach is:

SSH is encrypted, secure and state of the art, even as a permanently open port.

We recommend that we test SSH access a few working days prior to the installation, whereby we also check the prerequisites of the server.

We will be using the automation software “ansible” for installation, which is built upon SSH. Almost all SSH-connections are suited for ansible, but if in doubt about a certian SSH-jumphost installation, you (or we) can test it by connecting with ansible.

The installation takes several minutes or a few hours in case of complications.

Access via SSH or SSH + OpenVPN

The graphic below compares two supported access paths:

Connections from the server to the Internet

This information applies during installation and normal operation (for updates).

Proxy

If you want the easydb host to reach the Internet by a proxy, then configure this proxy for …


Integration

Further integration into your network is quite possible, but this is not treated as part of the installation. We recommend installation as a first step.

Examples for further integration:


Advanced

Concrete steps of installation of easydb 5.