Quick Start

DataFlux Func is a script development, management, and execution platform based on Python.

DataFlux Func is pronounced as data flux function, and is sometimes abbreviated as DFF within the system.

Download Command for Installation Package

/bin/bash -c "$(curl -fsSL docs.dataflux-func.com/download)"

0. Pre-reading Note

All shell commands mentioned in this article can be run directly under the root user. For non-root users, please add sudo to run them.

This article only provides the most common operation steps. For detailed installation and deployment, please refer to Deployment and Maintenance / Installation / Standalone Deployment

1. System Requirements

Please ensure the host or cloud host running DataFlux Func meets the following conditions:

• CPU cores >= 2
• Memory capacity >= 4GB
• Disk space >= 20GB
• Network bandwidth >= 10Mbps
• Operating system is Ubuntu 16.04 LTS / CentOS 7.2 or above original version (macOS, Windows are not supported)
• Open port 8088 (This system uses port 8088 by default. Please ensure firewall, security group, and other configurations allow inbound access to 8088)

Detailed System Requirements

For more detailed system requirements, please refer to Deployment and Maintenance / System Requirements

2. Installation and Deployment

DataFlux Func supports multiple installation package deployment methods. Users can choose according to their actual situation.

Download Installation Package for Deployment

For deployment on a single host, it is recommended to download the installation package for deployment. This method is also suitable for various environments without public network access or restricted environments.

For Linux, macOS, and other systems, it is recommended to use the official shell command to download the installation package. The script will automatically select the x86_64 or aarch64 architecture version based on the current environment:

/bin/bash -c "$(curl -fsSL docs.dataflux-func.com/download)"

Manually Download Installation Package

Windows requires manual download of the installation package. Please refer to Deployment and Maintenance / Installation / Standalone Deployment / Manual Download

After downloading, run run-portable.sh in the directory where the installation file is located. This will automatically configure and finally start the entire DataFlux Func:

sudo /bin/bash {Installation file directory}/run-portable.sh

After execution is complete, you can use a browser to access http://{server IP address/domain name}:{port} to reach the initialization operation interface.

Configuration Parameters for the Installation Script

For configuration parameters of the installation script, please refer to Deployment and Maintenance / Installation / Standalone Deployment / Installation Options

Install using Helm in k8s

Please refer to the document Deployment and Maintenance / Installation / Helm

3. System Initialization

After installing DataFlux Func, the initialization interface will be displayed upon first access. Click the "Save and Initialize Database" button to initialize the database.

Wait a moment. After initialization is complete, it will automatically jump to the login interface.

4. Run the Sample Function

The initially installed DataFlux Func includes a simple code sample.

Click the "Edit" button to enter edit mode and modify the code.

In edit mode, you can select the function you want to run and click "Run".

The function's running results and print(...) output will be displayed in the output bar below.

5. Create a Func API

Go to "Manage / Func API" to see the list of Func APIs.

Click "Create" to create a Func API for a function decorated with @DFF.API(...).

6. Call the Func API

Go to "Manage / Func API" to see the list of Func APIs.

Click "Example" to display calling instructions. Adjusting the calling parameters will automatically generate specific calling methods.

Access it according to the prompted calling method to get the function's return value (i.e., the return value).