Skip to content

Quick Start

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

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

Package Download Command

Bash
1
/bin/bash -c "$(curl -fsSL func.guance.com/download)" -- --for=GSE
Bash
1
/bin/bash -c "$(curl -fsSL func.guance.com/download)"

GSE Edition and Legacy Edition

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.

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

1. System Requirements

Please ensure that 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 higher original system * (macOS, Windows are not supported) *
  • Open 8088 port (the system defaults to using 8088 port, please ensure firewall, security group configurations allow 8088 inbound access)

Detailed System Requirements

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

2. Installation Deployment

DataFlux Func supports multiple package deployment methods, and users can choose according to their actual situation.

Downloading and Installing Packages

For scenarios deploying on a single host, it is recommended to deploy by downloading the installation package. This method also applies to various environments without public networks or restricted environments.

For Linux, macOS systems, we recommend using 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 func.guance.com/download)" -- --for=GSE
Bash
1
/bin/bash -c "$(curl -fsSL func.guance.com/download)"

Manual Download of Installation Package

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

GSE Edition and Legacy Edition

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 location}/run-portable.sh

After execution, you can use a browser to access http://{server IP address/domain name}:{port} for initialization operations.

Configuration Parameters of the Installation Script

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

Using Helm to Install in k8s

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

3. Initialize the System

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

Wait a moment, and after initialization is complete, it will automatically redirect to the login interface.

setup-page.png

4. Run Instance Functions

The initially installed 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 to run and click "Run".

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

sample-code-result.png

Enter "Manage / Sync API (Legacy: Authorization Link)" to see the list of sync APIs (legacy: authorization links).

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

sync-api-list.png

create-sync-api.png

Enter "Manage / Sync API (Legacy: Authorization Link)" to see the list of sync APIs (legacy: authorization links).

Click "Example", which will display the call instructions. Adjusting the call parameters will automatically generate specific call methods.

sync-api-list-2.png

api-example.png

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