Quick Start
DataFlux Func is a Python-based script development, management, and execution platform.
DataFlux Func is pronounced as data flux function, and may sometimes be abbreviated as DFF within the system.
Installation Package Download Command
| Bash | |
|---|---|
1 | |
0. Pre-reading Notes
All shell commands mentioned in this article can be run directly as the root user; non-root users need to add sudo when running.
This article provides only the most common operation steps. For detailed installation and deployment instructions, please refer to Deployment and Maintenance / Installation 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 system (macOS and Windows are not supported)
- Port
8088must be open (this system uses port8088by default; ensure firewall, security group configurations allow inbound access on port8088)
Detailed System Requirements
For more detailed system requirements, please refer to Deployment and Maintenance / System Requirements
2. Installation and Deployment
DataFlux Func supports multiple package deployment methods. Users can choose according to their actual situation.
Deploy by Downloading Installation Package
For scenarios deploying on a single host, it is recommended to deploy by downloading the installation package. This method also suits environments without public internet access or with restricted access.
For systems like Linux and macOS, it is recommended to use the official shell command to download the installation package. The script will automatically select and download either the x86_64 or aarch64 architecture version based on the current environment:
| Bash | |
|---|---|
1 | |
Manual Installation Package Download
Windows requires manual installation package download. Please refer to Deployment and Maintenance / Installation Deployment / Manual Download
After downloading, run run-portable.sh located in the directory where the installation file resides to automatically configure and eventually start the entire DataFlux Func:
| Bash | |
|---|---|
1 | |
After execution, you can access the initialization interface using a web browser at http://{server IP address/domain}:{port}.
Configuration Parameters for the Installation Script
For details about the installation script's configuration parameters, please refer to Deployment and Maintenance / Installation Deployment / Installation Options
Installing via Helm in Kubernetes (k8s)
Please refer to the documentation Deployment and Maintenance / Installation Deployment / Helm
3. Initialize the System
When accessing the system for the first time after installing DataFlux Func, an initialization interface will appear. Click the 'Save and Initialize Database' button to initialize the database.
Wait a moment; once initialization completes, you will be automatically redirected to the login page.
4. Running Sample Functions
The initially installed DataFlux Func includes a simple code example.
Click the 'Edit' button to enter edit mode and modify the code.
In edit mode, select the desired function to run and click 'Run'.
The results of the function execution, including any print(...) output, will be displayed in the output area below.
5. Creating Sync API (Legacy: Authorization Link)
Go to 'Management / Sync API (Legacy: Authorization Link)' to see the list of Sync APIs (Legacy: Authorization Links).
Click 'Create' to generate a Sync API for functions decorated with @DFF.API(...).
6. Invoking Sync API (Legacy: Authorization Link)
Go to 'Management / Sync API (Legacy: Authorization Link)' to view the list of Sync APIs (Legacy: Authorization Links).
Click 'Example' to display invocation instructions. Adjusting the invocation parameters will automatically generate specific invocation methods.
Access according to the indicated invocation method to obtain the function return value (i.e., the return value).
