快速开始¶

DataFlux Func 是一个基于 Python 的脚本开发、管理、执行平台。

DataFlux Func读作data flux function，系统内有时会缩写为DFF。

前身为观测云下属的一个函数计算组件，目前已成为可独立运行的系统。

携带版下载命令¶

/bin/bash -c "$(curl -fsSL t.guance.com/func-portable-download)"

0. 阅读前提示¶

注意：本文所有涉及到的 shell 命令，在 root 用户下可直接运行，非 root 用户下需要添加 sudo 运行

注意：本文仅提供最常见的操作步骤，详细安装部署请参考「维护手册」

1. 系统及环境要求¶

安装 DataFlux Func 之前，请务必确认环境已经满足以下条件。

1.1 系统要求¶

运行 DataFlux Func 的主机需要满足以下条件：

CPU 核心数 >= 2
内存容量 >= 4GB
磁盘空间 >= 20GB
网络带宽 >= 10Mbps
操作系统为 Ubuntu 16.04 LTS/CentOS 7.2 以上
纯净系统（安装完操作系统后，除了配置网络外没有进行过其他操作）
开放8088端口（本系统默认使用8088端口，请确保防火墙、安全组等配置允许8088入方向访问）
使用外部 MySQL 时，MySQL 版本必须为 5.7 以上
使用外部 Redis 时，Redis 版本必须为 4.0 以上

注意：DataFlux Func 不支持 macOS、Windows，您可以选择在虚拟机、云主机中安装 DataFlux Func

注意：DataFlux Func 不支持集群版 Redis，有高可用需要请选择主从版

注意：如果在阿里云 ECS 上安装 DataFlux Func，并且开启了阿里云盾插件。由于云盾本身占用资源较多，所以系统配置应适当提高

详细操作系统兼容性实测结果，可参考「维护手册 - 已实测操作系统兼容性」

如希望在树莓派上安装，请参考以下文章：

1.2 软件准备¶

本系统基于 Docker Stack 运行，因此要求操作系统可以正常使用 Docker 和 Docker Stack

安装脚本本身已经自带了 Docker 的安装包并会在安装时自动安装。用户也可以自行安装 Docker 并初始化 Docker Swarm，然后运行安装脚本，安装脚本在发现 Docker 已经安装后会自动跳过这部分处理。

Docker Swarm 初始化命令为：sudo docker swarm init

如果本机存在多个网卡，需要在上述初始化命令中指定网卡

存在多网卡的建议用户自行安装 Docker 并初始化 Docker Swarm
Docker Swarm 指定网卡的初始化命令为：sudo docker swarm init --advertise-addr={网卡名} --default-addr-pool={默认地址池}
本机网卡列表可以通过ifconfig或者ip addr查询

注意：自动安装脚本在进行docker swarm init时，--advertise-addr参数会指定为127.0.0.1，--default-addr-pool参数会指定为10.255.0.0/16

注意：DataFlux Func 不支持在 snap 版 Docker 上运行

2. 使用「携带版」离线安装¶

DataFlux Func 支持将所需安装文件下载后，通过 U 盘等移动设备带入无公网环境安装的「携带版」。

下载的「携带版」本身附带了自动安装脚本，执行即可进行安装（详情见下文）

2.1 一键命令下载「携带版」安装文件¶

对于 Linux、macOS 等系统，推荐使用官方提供的 shell 命令下载「携带版」。

运行以下命令，即可自动下载 DataFlux Func 携带版的所需安装文件，下载脚本会自动根据当前环境选择下载x86_64或aarch64架构版本：

注意：安装前请确认系统要求和服务器配置

/bin/bash -c "$(curl -fsSL t.guance.com/func-portable-download)"

命令执行完成后，所有安装文件都保存在自动创建的dataflux-func-portable-{架构}-{版本号}目录下。

对于需要将 DataFlux Func 安装到无公网的服务器时，可以先在本机下载，之后将整个目录通过 U 盘等移动存储设备，或scp工具等复制到目标机器中
对于需要将 DataFlux Func 安装到可以访问公网的服务器，直接在服务器上下载即可

2.2 手工下载「携带版」安装文件¶

对于不便使用 shell 命令的系统，可手工下载所需安装文件。

如需要手工下载，以下是所有的文件列表：

#	内容	文件名	x86_64 架构	aarch64 架构
1	Docker 二进制程序	`docker-20.10.8.tgz`	下载	下载
2	DataFlux Func 镜像	`dataflux-func.tar.gz`	下载	下载
3	MySQL/MariaDB 镜像	`mysql.tar.gz`	下载	下载
4	Redis 镜像	`redis.tar.gz`	下载	下载
5	Docker 服务配置文件	`docker.service`	下载	下载
6	DataFluxFunc 安装脚本	`run-portable.sh`	下载	下载
7	Docker Stack 配置文件模板	`docker-stack.example.yaml`	下载	下载
8	镜像列表	`image-list`	下载	下载
9	版本信息	`version`	下载	下载

手工下载所有安装文件后，放入同一个目录下即可。

注意：如有更新，【重新下载所有文件】。请勿自行猜测哪些文件有变动，哪些没有变动

注意：手工下载时，如使用浏览器等下载时，请注意不要下载到缓存的旧内容！！

2.3 使用自动安装脚本执行安装¶

运行安装文件所在目录下的run-portable.sh，即可自动配置并最终启动整个 DataFlux Func：

注意：安装前请确认系统要求和服务器配置

注意：DataFlux Func 不支持 Mac，请拷贝到 Linux 系统下再运行安装

cd {安装文件所在目录}
sudo /bin/bash run-portable.sh

# 或者
sudo /bin/bash {安装文件所在目录}/run-portable.sh

系统默认使用8088端口，如需要安装时指定端口号，可以加上--port {端口号}参数：

sudo /bin/bash run-portable.sh --port 9000

更多配置参数见下文「安装选项」或「维护手册」-「安装选项」

使用自动安装脚本可以实现几分钟内快速安装运行，自动配置的内容如下：

运行 MySQL、Redis、DataFlux Func（包含 Server，Worker，Beat）
自动创建并将所有数据保存于/usr/local/dataflux-func/目录下（包括 MySQL 数据、Redis 数据、DataFlux Func 配置、日志等文件）
随机生成 MySQL root用户密码、系统 Secret，并保存于 DataFlux Func 配置文件中
Redis 不设密码
MySQL、Redis 不提供外部访问

执行完成后，可以使用浏览器访问http://{服务器 IP 地址/域名}:{端口}进行初始化操作界面。

注意：如果运行环境性能较差，应当使用docker ps命令确认所有组件成功启动后，方可访问（见以下列表）

dataflux-func_mysql
dataflux-func_redis
dataflux-func_server
dataflux-func_worker-0
dataflux-func_worker-1-6
dataflux-func_worker-7
dataflux-func_worker-8-9
dataflux-func_beat

3. 安装选项¶

自动安装脚本支持一些安装选项，用于适应不同的安装需求

3.1 「携带版」指定安装选项¶

安装「携带版」时，只需要在自动安装命令后添加--{参数}[ 参数配置（如有）]，即可指定安装选项

如，指定端口号为 9000：

sudo /bin/bash run-portable.sh --port 9000

3.2 可用安装选项¶

具体参数详情见下文

--mini：安装迷你版¶

针对低配置环境下，需要节约资源时的安装模式。

开启后：

仅启动单个 Worker 监听所有队列
遇到重负载任务更容易导致队列阻塞和卡顿
系统任务和函数任务共享处理队列，相互会受到影响
系统要求降低为：
- CPU 核心数 >= 1
- 内存容量 >= 2GB
如不使用内置的 MySQL、Redis，系统要求可以进一步降低

--port {端口号}：指定监听端口号¶

DataFlux Func 默认使用8088端口访问，如果此端口被其他程序占用，可以选择其他端口，如：9000。

--install-dir {安装目录}：指定安装目录¶

需要安装到与默认路径/usr/local/dataflux-func不同的路径下时，可指定此参数

--no-mysql：禁用内置 MySQL¶

需要使用已有的 MySQL 数据库时，可指定此参数，禁止在本机启动 MySQL。

注意：启用此选项后，需要在安装完成后的配置页面指定正确的 MySQL 连接信息

--no-redis：禁用内置 Redis¶

需要使用已有的 Redis 数据库时，可指定此参数，禁止在本机启动 Redis。

注意：启用此选项后，需要在安装完成后的配置页面指定正确的 Redis 连接信息

4. 使用 Helm 在 k8s 中安装¶

请参考文档部署和维护手册 - 通过 Helm 在 k8s 中部署