Skip to content

Quick Start

DataFlux Func is a platform for the development, management, and execution of Python-based scripts.

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

Installation Package Download Command

Bash
1
/bin/bash -c "$(curl -fsSL <<< site_domain >>>/download)" -- --for=GSE
Bash
1
/bin/bash -c "$(curl -fsSL <<< site_domain >>>/download)"

GSE Edition and Old Editions

0. Pre-reading Tips

All shell commands mentioned in this article can be run directly under the root user; for non-root users, add sudo before running.

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

1. System Requirements

Ensure that the host or cloud server running DataFlux Func meets the following conditions:

  • CPU cores >= 2
  • Memory capacity >= 4GB
  • Disk space >= 20GB
  • Network bandwidth >= 10Mbps
  • Operating system must be Ubuntu 16.04 LTS / CentOS 7.2 or higher original systems * (macOS and Windows are not supported) *
  • Open 8088 port (this system defaults to using 8088 port. Ensure firewall, security groups, etc., allow inbound access on 8088)

Detailed System Requirements

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

2. Installation and Deployment

DataFlux Func supports multiple installation package deployment methods, allowing users to choose based on their actual situation.

Download Installation Package Deployment

For scenarios where deployment occurs on a single host, it is recommended to deploy via downloading the installation package. This method is also suitable for various environments without public networks or restricted environments.

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

Bash
1
/bin/bash -c "$(curl -fsSL <<< site_domain >>>/download)" -- --for=GSE
Bash
1
/bin/bash -c "$(curl -fsSL <<< site_domain >>>/download)"

Manual Download of Installation Package

Windows requires manual download of the installation package. Refer to Deployment and Maintenance / Installation Deployment / Single Machine Deployment / Manual Download

GSE Edition and Old Editions

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

Bash
1
sudo /bin/bash {installation file directory}/run-portable.sh

Once executed, you can access the initialization interface via a browser at http://{server IP address/domain}:{port}.

Configuration Parameters for the Installation Script

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

Use Helm to Install in k8s

Refer to the documentation Deployment and Maintenance / Installation Deployment / Helm

3. Initialize System

The first time you access the system after installing DataFlux Func, an initialization interface will appear. Click the "Save and Initialize Database" button to initialize the database.

Wait a moment, and after initialization is complete, you will be automatically redirected to the login interface.

setup-page.png

4. Run Instance Functions

The initial installation of DataFlux Func includes a simple code example.

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

sample-code.png

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

The results of the function's execution, including print(...) outputs, will be displayed in the output bar below.

sample-code-result.png

Navigate to "Manage / Sync API (Old Version: Authorization Link)" to view the list of sync APIs (old version: authorization links).

Click "Create" to create a sync API for functions decorated with @DFF.API(...).

sync-api-list.png

create-sync-api.png

Navigate to "Manage / Sync API (Old Version: Authorization Link)" to view the list of sync APIs (old version: authorization links).

Click "Example" to display the invocation instructions. Adjusting the call parameters will generate specific invocation methods.

sync-api-list-2.png

api-example.png

Access according to the prompted invocation method to obtain the return value of the function (i.e., the return value).