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 Old Edition

0. Pre-reading Tips

All shell commands mentioned in this article can be run directly under the root user, or with sudo for non-root users.

This article only provides the most common operational 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 server running DataFlux Func meets the following conditions:

  • Number of CPU cores >= 2
  • Memory capacity >= 4GB
  • Disk space >= 20GB
  • Network bandwidth >= 10Mbps
  • Operating system is Ubuntu 16.04 LTS / CentOS 7.2 or later clean systems * (macOS and Windows are not supported) *
  • Open port 8088 (the system defaults to using port 8088. Please ensure that firewall, security groups, 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 various methods for installing and deploying packages. Users can choose based on their actual situation.

Downloading and Installing Packages

For scenarios where deployment occurs on a single host, it is recommended to deploy by downloading an installation package. This method also applies to 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 func.guance.com/download)" -- --for=GSE
Bash
1
/bin/bash -c "$(curl -fsSL func.guance.com/download)"

Manual Download of Installation Packages

For Windows, manual download of the installation package is required. Please refer to Deployment and Maintenance / Installation Deployment / Single Machine Deployment / Manual Download

GSE Edition and Old 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 directory}/run-portable.sh

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

Configuration Parameters of the Installation Script

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

Using Helm to Install in k8s

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

3. Initializing the System

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

After a short wait, once initialization is complete, the system will automatically redirect to the login interface.

4. Running Instance 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, you can select the function to run and click "Run".

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

The initial installation of DataFlux Func includes a synchronous API example (Old Version: Authorization Link).

Enter "Manage / Synchronous API (Old Version: Authorization Link)" to view the list of synchronous APIs (Old Version: Authorization Link). Click "Example" to display the invocation method description for this synchronous API (Old Version: Authorization Link).

In the invocation instructions, modifying the invocation parameters will automatically generate the specific invocation method.

Following the suggested invocation method will return the function's return value (i.e., the return value).