Installation & Deployment¶
There are currently two ways to install the Enterprise Server: online and offline. We highly recommend using the online installation when possible.
The Enterprise server supports deployments to multiple different platforms. We recommend deploying directly to a host you control with Docker, but we also support a few different cloud container engines as well.
Danger
Deploying with Kubernetes is not officially tested or supported. You may be able to get it working by translating the service definition template file with a tool like kompose (after manually filling in all the environment-specific settings from config.env), but manage_server does not understand Kubernetes resource files and will not be able to operate on your deployment.
We do have plans to officially support a basic Kubernetes deployment going forward. If this is something your organization needs, please contact support at enterprise@vector35.com.
Requirements¶
Host System¶
If you aren't using a container orchestration platform (ECS, ACI, GKE), the system you host the Enterprise server on must:
- Meet the minimum requirements for your chosen container engine
- See this page for Docker system requirements. We support Docker Engineversion 20.10.0+ and provide images for both x86_64 and ARM64.
- If using Podman instead, we support version 4.9+
- Linux hosts must have a
glibcof 2.29+ to run the management interface (manage_server). This means we do not support versions of Red Hat below 9, versions of Ubuntu below 19.04, versions of Debian below 11, or other systems that do not have access to a newer version ofglibc.
Generally speaking, this should just require something like the following on a recent Ubuntu install:
sudo apt update && \
sudo apt install -y containerd docker.io docker-compose-v2
...or this, on a recent Red Hat install:
sudo dnf update && \
sudo dnf install podman
We officially test Enterprise Server deployments on the latest two LTS versions of Ubuntu (currently 22.04 and 24.04) and the latest LTS version of Red Hat (currently 10.1). We highly recommend you use an up-to-date, Debian-based host. Red Hat is often more difficult to support because of SELinux and Podman restrictions, but we do support it.
Resources¶
The Enterprise server itself is fairly lightweight on resource usage. We expect the following to be sufficient for most use-cases:
- Minimum: 2 CPU cores, 4 GB of memory, 20 GB of disk space, 100 Mb/s network connection
- Recommended: 4+ CPU cores, 8+ GB of memory, 200+ GB of disk space, 1+ Gb/s network connection
Warning
Disk space and network connection requirements will vary heavily based on usage. Some of our customers have required upwards of 2-4 TB of space for large datasets or for smaller datasets over long periods of time. If you have chosen your initial deployment poorly, don't worry! Backup and restore provides an easy way to migrate your data.
Platform-Specific Install Guides¶
Once you've chosen how you want to host the Enterprise server and ensured you meet the requirements, you can continue to the installation guide for your chosen deployment: