跳轉到

快速開始

DataFlux Func 是一個基於 Python 的指令碼開發、管理、執行平臺。

DataFlux Func 讀作 data flux function,系統內有時會縮寫為 DFF

安裝包下載命令

Bash
1
/bin/bash -c "$(curl -fsSL docs.dataflux-func.com/download)"

0. 閱讀前提示

本文所有涉及到的 shell 命令,在 root 使用者下可直接執行,非 root 使用者下需要新增 sudo 執行

本文僅提供最常見的操作步驟,詳細安裝部署請參考 部署和維護 / 安裝部署 / 單機部署

1. 系統要求

請確保執行 DataFlux Func 的主機或雲主機需要滿足以下條件:

  • CPU 核心數 >= 2
  • 記憶體容量 >= 4GB
  • 磁碟空間 >= 20GB
  • 網路頻寬 >= 10Mbps
  • 作業系統為 Ubuntu 16.04 LTS / CentOS 7.2 以上原版系統 (不支援 macOS、Windows)
  • 開放 8088 埠(本系統預設使用 8088 埠,請確保防火牆、安全組等配置允許 8088 入方向訪問)

詳細系統要求

有關更詳細的系統要求,請參考 部署和維護 / 系統要求

2. 安裝部署

DataFlux Func 支援多種安裝包部署方式,使用者可以根據自己實際情況進行選擇。

下載安裝包部署

對於在單臺主機上部署的場景,推薦下載安裝包進行部署。同時,本方式也適用於各種無公網、受限環境。

對於 Linux、macOS 等系統,推薦使用官方提供的 shell 命令下載安裝包,指令碼會自動根據當前環境選擇下載 x86_64aarch64 架構版本:

Bash
1
/bin/bash -c "$(curl -fsSL docs.dataflux-func.com/download)"

手工下載安裝包

Windows 需要手工下載安裝包,請參考 部署和維護 / 安裝部署 / 單機部署 / 手工下載

下載完成後,執行安裝檔案所在目錄下的 run-portable.sh,即可自動配置並最終啟動整個 DataFlux Func:

Bash
1
sudo /bin/bash {安裝檔案所在目錄}/run-portable.sh

執行完成後,可以使用瀏覽器訪問 http://{伺服器 IP 地址/域名}:{埠} 進行初始化操作介面。

安裝指令碼的配置引數

有關安裝指令碼的配置引數,請參考 部署和維護 / 安裝部署 / 單機部署 / 安裝選項

使用 Helm 在 k8s 中安裝

請參考文件 部署和維護 / 安裝部署 / Helm

3. 初始化系統

安裝 DataFlux Func 後首次訪問系統,會展示初始化介面,點選「儲存並初始化資料庫」按鈕即可初始化資料庫。

稍等片刻,初始化完成後即自動跳轉到登入介面。

setup-page.png

4. 執行例項函式

初始安裝的 DataFlux Func 包含了一個簡單的程式碼示例。

點選「編輯」按鈕,可以進入編輯模式,修改程式碼。

sample-code.png

在編輯模式,可以選擇需要執行的函式,點選「執行」。

函式執行的結果,print(...) 輸出都會展示在下方的輸出欄中。

sample-code-result.png

5. 建立函式 API

進入「管理 / 函式 API」,可看到函式 API 列表。

點選「新建」,可以為被 @DFF.API(...) 裝飾的函式建立函式 API。

func-api-list.png

create-func-api.png

6. 呼叫函式 API

進入「管理 / 函式 API」,可看到函式 API 列表。

點選「示例」,會展示呼叫說明。調整呼叫引數會自動生成具體的呼叫方式。

func-api-list-2.png

func-api-example.png

根據提示的呼叫方式訪問,即可獲得函式返回值(即 return 值)