Quick Start
DataFlux Func is a Python-based platform for Script Development, management, and execution.
DataFlux Func is pronounced data flux function, and is sometimes abbreviated as DFF within the system.
Installation Package Download Command
| Bash | |
|---|---|
1 | |
0. Before Reading
All shell commands mentioned in this article can be run directly as the root user; non-root users need to add sudo to run them.
This article only covers the most common operation steps. For details on Installation and Deployment, please refer to Deployment and Maintenance / Installation and Deployment / Standalone Deployment
1. System Requirements
Please ensure that the host or cloud host running DataFlux Func meets the following requirements:
- CPU cores >= 2
- Memory capacity >= 4GB
- Disk space >= 20GB
- Network bandwidth >= 10Mbps
- The operating system must be an original system of Ubuntu 16.04 LTS / CentOS 7.2 or above * (macOS and Windows are not supported) *
- Open port
8088(this system uses port8088by default; please ensure that firewall, security group, and other configurations allow inbound access to8088)
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.
Deploying by Downloading the Installation Package
For scenarios where deployment is performed on a single host, it is recommended to download the installation package for deployment. This method is also applicable to various environments without public network access or with restrictions.
For Linux, macOS, and other systems, it is recommended to use the official shell commands to download the installation package. The Script will automatically select and download the x86_64 or aarch64 version based on the current environment:
| Bash | |
|---|---|
1 | |
Manually Download the Installation Package
On Windows, you need to manually download the installation package. Please refer to Deployment and Maintenance / Installation and Deployment / Standalone Deployment / Manual Download
After downloading, run run-portable.sh in the directory containing the installation files to automatically configure and finally start the entire DataFlux Func:
| Bash | |
|---|---|
1 | |
After execution, you can use a browser to access http://{server IP address/domain}:{port} to open the initialization page.
Configuration Parameters of the Installation Script
For the configuration parameters of the installation Script, please refer to Deployment and Maintenance / Installation and Deployment / Standalone Deployment / Installation Options
Installing with Helm in k8s
Please refer to the documentation Deployment and Maintenance / Installation and Deployment / Helm
3. System Initialization
After installing DataFlux Func, the first time you access the system, the initialization page will be displayed. Click the "Save and Initialize Database" button to initialize the database.
After a moment, once the initialization is complete, you will be automatically redirected to the login page.
4. Running the Sample Function
A freshly installed DataFlux Func includes a simple code example.
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 results of the function run and the output of print(...) will be displayed in the output panel below.
5. Creating a Func API
Go to "Management / Func API" to see the Func API list.
Click "New" to create a Func API for a function decorated with @DFF.API(...).
6. Calling a Func API
Go to "Management / Func API" to see the Func API list.
Click "Example" to see the call instructions. Adjusting the call parameters will automatically generate the specific call method.
Access using the indicated call method to obtain the function's return value (i.e., the return value).
