Skip to content

Deployment and Maintenance / System Requirements

Before installing DataFlux Func, please ensure that the environment meets the following conditions.

1. System Requirements

The host running DataFlux Func must meet the following conditions:

  • CPU cores >= 2
  • Memory capacity >= 4GB
  • Disk space >= 20GB
  • Network bandwidth >= 10Mbps
  • Operating system: Ubuntu 16.04 LTS / CentOS 7.2 or above, macOS and Windows are not supported
  • Clean system (no operations other than network configuration after installing the operating system)
  • Open port 8088 (the system uses port 8088 by default, ensure that the firewall, security group, etc., allow inbound access to 8088)
  • When using an external MySQL, the MySQL version must be 5.7 or above, enable the innodb_large_prefix parameter, and the database encoding must be utf8mb4
  • When using an external Redis, the Redis version must be 5.0 or above, with at least 1 GB of available memory, non-cluster version

Note on certain cloud platform plugins

Some plugins automatically installed by cloud platforms may consume significant resources, and the system configuration should be appropriately increased.

Detailed OS compatibility

For detailed OS compatibility test results, refer to Tested OS Compatibility

If you wish to install on a Raspberry Pi, refer to the following articles:

2. Software Preparation

This system runs based on Docker Stack, and the installation package includes Docker and will automatically install it during the installation process.

Users can also install Docker and initialize Docker Swarm themselves, then run the installation script. The installation script will skip the Docker installation part if it detects that Docker is already installed.

  • Docker Swarm initialization command: sudo docker swarm init

If the machine has multiple network cards, the initialization command must specify the network card.

  • For machines with multiple network cards, it is recommended to install Docker and initialize Docker Swarm manually.
  • Docker Swarm initialization command with specified network card: sudo docker swarm init --advertise-addr={network card name} --default-addr-pool={default address pool}
  • The list of network cards can be queried using ifconfig or ip addr.
  • Ensure the default address pool does not conflict with the local network subnet.

Snap version of Docker not supported

DataFlux Func does not support running on the Snap version of Docker.

docker swarm init in the automatic installation script

In the automatic installation script, when performing docker swarm init, the --advertise-addr and --default-addr-pool parameters are set to 127.0.0.1 and 10.255.0.0/16 respectively.

Bash
1
docker swarm init --advertise-addr=127.0.0.1 --default-addr-pool=10.255.0.0/16

3. Tested OS Compatibility

This system relies on Docker Swarm, and some older Linux distributions may not support the latest version of Docker, causing the system to fail to install.

For "tested environments":

  • Virtual machines: Official ISO images were used, and DataFlux Func was deployed directly after installation.
  • Alibaba Cloud: ECS public images were used, and DataFlux Func was deployed directly after ECS startup.
  • Raspberry Pi: Official ISO images (ARM 64-bit) were used, and DataFlux Func was deployed directly after startup.

For "tested results":

  • Compatible: Indicates that after installing/creating the host, the installation script can be run directly without any additional operations.
  • Conditionally compatible: Indicates that after installing/creating the host, the installation script cannot be run directly, and additional operations are required before executing the installation script.
  • Incompatible: Indicates that the installation script cannot be executed correctly in this environment, but you can handle it manually using the image file.

Test results

The operating systems listed below were tested on cloud platforms or virtual machines and passed the tests. Systems not listed are not necessarily incompatible.

64-bit system required

DataFlux Func needs to run on a 64-bit system. The official Raspberry Pi OS also needs to be run in ARM 64-bit mode.

Windows and macOS not supported

DataFlux Func does not support Windows and macOS. You can choose to install it on a virtual machine or cloud host.

x86 Architecture

Alibaba Cloud Public Images

Operating System Test Environment Test Version Test Result Notes
Ubuntu 22.04 Alibaba Cloud 5.1.024.0.9
5.0.523.0.6		 Compatible
Ubuntu 20.04 Alibaba Cloud 5.0.523.0.6 Compatible
Ubuntu 18.04 Alibaba Cloud 5.0.523.0.6 Compatible
Ubuntu 16.04 Alibaba Cloud 5.0.523.0.6 Compatible

Original Images

Operating System Test Environment Test Version Test Result Notes
Ubuntu 20.04 LTS VirtualBox 2.x20.10.8 Compatible
Ubuntu 18.04 LTS VirtualBox 2.x20.10.8 Compatible
Ubuntu 16.04 LTS VirtualBox 2.x20.10.8 Compatible
Ubuntu 14.04 LTS VirtualBox 2.x20.10.8 Incompatible Due to Docker's new feature requirements, the latest Docker cannot be used.

Alibaba Cloud Public Images

Operating System Test Environment Test Version Test Result Notes
CentOS 8.5 Alibaba Cloud 2.x20.10.8 Compatible
CentOS 8.4 Alibaba Cloud 2.x20.10.8 Compatible
CentOS 8.3 Alibaba Cloud 2.x20.10.8 Compatible
CentOS 8.2 Alibaba Cloud 2.x20.10.8 Compatible
CentOS 8.1 Alibaba Cloud 2.x20.10.8 Compatible
CentOS 8.0 Alibaba Cloud 2.x20.10.8 Compatible
CentOS 7.9 Alibaba Cloud 2.x20.10.8 Compatible
CentOS 7.8 Alibaba Cloud 2.x20.10.8 Compatible
CentOS 7.7 Alibaba Cloud 2.x20.10.8 Compatible
CentOS 7.6 Alibaba Cloud 2.x20.10.8 Compatible
CentOS 7.5 Alibaba Cloud 2.x20.10.8 Compatible
CentOS 7.4 Alibaba Cloud 2.x20.10.8 Compatible
CentOS 7.3 Alibaba Cloud 2.x20.10.8 Compatible
CentOS 7.2 Alibaba Cloud 2.x20.10.8 Conditionally compatible The original CentOS 7.2 image version is too low to use overlay2, and defaults to the non-union file system vfs, which may cause excessive disk usage.
However, the CentOS 7.2 public image on Alibaba Cloud has an upgraded kernel and can use overlay2 normally.
CentOS 6.10 Alibaba Cloud 2.x20.10.8 Incompatible Due to Docker's new feature requirements, the latest Docker cannot be used.

Original Images

Operating System Test Environment Test Version Test Result Notes
CentOS 7.9 VirtualBox 5.0.523.0.6 Compatible Image from Alibaba Cloud Open Source Mirror Site / CentOS 7.9.2009 / CentOS-7-x86_64-Minimal-2009.iso

Alibaba Cloud Public Images

Operating System Test Version Test Result Notes
Debian 10.2 "buster" Alibaba Cloud 2.x20.10.8 Compatible
Debian 9.6 "stretch" Alibaba Cloud 2.x20.10.8 Compatible
Debian 8.11 "jessie" Alibaba Cloud 2.x20.10.8 Compatible

Alibaba Cloud Public Images

Operating System Test Environment Test Version Test Result Notes
AlmaLinux 9.0 64-bit Alibaba Cloud 2.x20.10.8 Compatible
AlmaLinux 8.6 64-bit Alibaba Cloud 2.x20.10.8 Compatible
AlmaLinux 8.5 64-bit Alibaba Cloud 2.x20.10.8 Compatible

Alibaba Cloud Public Images

Operating System Test Environment Test Version Test Result Notes
Fedora 35 64-bit Alibaba Cloud 2.x20.10.8 Compatible
Fedora 34 64-bit Alibaba Cloud 2.x20.10.8 Compatible
Fedora 33 64-bit Alibaba Cloud 2.x20.10.8 Compatible

Alibaba Cloud Public Images

Operating System Test Environment Test Version Test Result Notes
OpenSUSE 15.4 64-bit Alibaba Cloud 2.x20.10.8 Conditionally compatible Docker needs to be installed and Docker Swarm configured beforehand.
For details, refer to SUSE / Docker Open Source Engine Installation

Alibaba Cloud Public Images

Operating System Test Environment Test Version Test Result Notes
SUSE Linux Enterprise Server 15 SP3 64-bit Alibaba Cloud 2.x20.10.8 Conditionally compatible Docker needs to be installed and Docker Swarm configured beforehand.
For details, refer to SUSE / Docker Open Source Engine Installation

Alibaba Cloud Public Images

Operating System Test Environment Test Version Test Result Notes
Rocky Linux 9.5 64-bit Alibaba Cloud 6.2.824.0.9 Compatible
Rocky Linux 8.6 64-bit Alibaba Cloud 2.x20.10.8 Compatible
Rocky Linux 8.5 64-bit Alibaba Cloud 2.x20.10.8 Compatible

ARM Architecture

Alibaba Cloud Public Images

Operating System Test Environment Test Version Test Result Notes
Ubuntu 22.04 Alibaba Cloud 5.0.523.0.6 Compatible
Ubuntu 20.04 Alibaba Cloud 5.0.523.0.6 Compatible
Ubuntu 18.04 Alibaba Cloud 2.x20.10.8 Compatible

Official Raspberry Pi Ubuntu Images

Operating System Test Environment Test Version Test Result Notes
Ubuntu 20.04 LTS Raspberry Pi
4B 8GB version		 2.x20.10.8 Compatible For details, refer to Maintenance and Deployment / Installation Guide / Raspberry Pi Ubuntu Deployment

Alibaba Cloud Public Images

Operating System Test Environment Test Version Test Result Notes
CentOS 8.3 Alibaba Cloud 2.x20.10.8 Incompatible Redis reports Unsupported system page size error and cannot start.
For details, refer to Troubleshooting / Containers Not Running / Redis Unsupported System Page Size
CentOS 7.9 Alibaba Cloud 2.x20.10.8 Incompatible Redis reports Unsupported system page size error and cannot start.
For details, refer to Troubleshooting / Containers Not Running / Redis Unsupported System Page Size

Alibaba Cloud Public Images

Operating System Test Environment Test Version Test Result Notes
Debian 10.9 "buster" Alibaba Cloud 2.x20.10.8 Compatible

Original Images

Operating System Test Environment Test Version Test Result Notes
Raspberry Pi OS (Debain 10 "buster") Raspberry Pi
4B 8GB version		 2.x20.10.8 Conditionally compatible Raspberry Pi needs to be in arm64_bit mode.
For details, refer to Maintenance and Deployment / Installation Guide / Raspberry Pi Official OS Deployment

4. Browser Compatibility

This system is a web application, and some browsers may have compatibility issues and cannot be used.

Browser Test Result
Chrome Compatible
Safari Compatible
Firefox Compatible
Microsoft Edge (webkit) Compatible
Opera Compatible
Maxthon Browser Compatible
Sogou Browser Compatible
QQ Browser Compatible
360 Extreme Browser (Extreme Mode, Chrome Mode) Compatible
360 Extreme Browser (Compatibility Mode, IE Mode) Incompatible
Internet Explorer Incompatible

X. Appendix

Kernel Version Too Low to Use Overlay

The Overlay storage engine requires Linux 4.0+ kernel, or RHEL/CentOS 3.10.0-514+ version, see:

OpenSUSE / SUSE Linux Docker Installation Commands Excerpt

Ensure you are familiar with OpenSUSE / SUSE Linux and understand the meaning of the following code before proceeding

Bash
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
# Only for SUSE Linux Enterprise Server
SUSEConnect -p sle-module-containers/15.0/x86_64 -r ''

# Install Docker
zypper install docker
systemctl enable docker.service
systemctl start docker.service

# Configure Docker Swarm
docker swarm init --advertise-addr=127.0.0.1 --default-addr-pool=10.255.0.0/16

# Run the installation script
bash run-portable.sh