Skip to content

Latest commit

 

History

History
189 lines (131 loc) · 6.78 KB

how_to_develop.md

File metadata and controls

189 lines (131 loc) · 6.78 KB
Raw

Fluid开发文档

环境需求

  • Git
  • Golang (version >= 1.16)
  • Docker (version >= 19.03)
  • Kubernetes (version >= 1.18)
  • GNU Make

对于Golang的安装与配置，请参考此处。

对于Docker的安装与配置，请参考此处。

Fluid需要使用make命令进行项目构建，使用以下命令安装make：

  • Linux
    • sudo apt-get install build-essential

项目构建

获取项目源码

$ export GOPATH=$(go env GOPATH)

$ mkdir $GOPATH/src/github.com/fluid-cloudnative

$ cd $GOPATH/src/github.com/fluid-cloudnative 

$ git clone https://github.com/fluid-cloudnative/fluid.git

$ cd fluid

注意：本文在非Go Module模式下完成Fluid的编译、运行和调试。

有关Go module可以参阅 Golang 官方文档 获取更多信息。

安装controller-gen

首先，运行以下命令下载Fluid项目所需的代码生成工具controller-gen。

$ make controller-gen

检查controller-gen是否成功安装：

$ controller-gen --version 
Version: v0.8.0

注意: controller-gen默认将下载到$GOPATH/bin路径下，请确保$GOPATH/bin已被添加在开发环境的$PATH环境变量中

二进制程序编译

Fluid项目根目录下的Makefile文件已经包含了项目开发中的编译、构建、部署等基本逻辑

# 构建Fluid各控制器组件、Fluid Webhook组件和Fluid CSI插件二进制程序
$ make build

构建得到的二进制程序位于Fluid项目./bin目录下。

Fluid组件镜像构建&推送

  1. 设置需要推送的私有镜像仓库（将以下<docker-registry>和<my-repo>替换为实际地址）

    export IMG_REPO=<docker-registry>/<my-repo>

  2. 输入镜像仓库访问凭证：

    $ sudo docker login <docker-registry>

  3. 构建全部Fluid组件镜像然后推送到仓库:

    $ make docker-push-all

    如果仅需要构建并推送特定Fluid组件的镜像（e.g. alluxio-runtime-controller镜像，fluid-webhook镜像）等，请参考./Makefile找到对应的Makefile target执行（e.g. make docker-push-alluxioruntime-controller，make docker-push-webhook等）

单元测试、运行和调试

单元测试

运行以下命令，执行Fluid项目单元测试：

make test

如果您在macOS等非linux系统开发，运行测试时若提示exec format error，则需要检查运行测试命令时是否设置了与开发环境不一致的GOOS环境变量，可通过go env -w GOOS=darwin进行覆盖。

本地运行Fluid控制器组件

Fluid控制器组件支持本地运行或调试。Fluid控制器组件包括Dataset Controller、各Runtime Controller以及Application Controller。在本地运行控制器组件前，需要在本地环境提前配置kubeconfig（通过KUBECONFIG环境变量配置或通过$HOME/.kube/config文件配置），并能正常访问一个Kubernetes集群。

Fluid Webhook组件或Fluid CSI插件无法在本地运行与Kubernetes集群交互。运行此类组件需要首先进行镜像构建，手动替换charts/fluid/fluid/values.yaml的对应镜像地址后，使用helm部署到Kubernetes集群后运行。

Runtime Controller依赖于helm以及相关Helm Charts以正常工作。因此在运行Runtime Controller前，执行如下命令进行环境配置：

  1. 在本地创建helm命令的软链接程序
$ ln -s $(which helm) /usr/local/bin/ddc-helm
  1. 在本地创建相关Charts的软链接目录
$ ln -s $GOPATH/src/github.com/fluid-cloudnative/fluid/charts $HOME/charts
  1. 以Alluxio Runtime Controller为例，使用以下命令在本地运行该组件：
# 配置AlluxioRuntime相关环境变量参数
$ export ALLUXIO_RUNTIME_IMAGE_ENV="alluxio/alluxio-dev:2.9.0"
$ export ALLUXIO_FUSE_IMAGE_ENV="alluxio/alluxio-dev:2.9.0
$ export DEFAULT_INIT_IMAGE_ENV="fluidcloudnative/init-users:v0.8.0-5bb4677"
$ export MOUNT_ROOT="/runtime-mnt"
$ export HOME="$HOME"

# 打开development调试模式，打开leader-election，启动alluxioruntime-controller
$ ./bin/alluxioruntime-controller start --development=true --enable-leader-election

调试Fluid组件

Fluid控制器组件支持本地运行或调试。Fluid控制器组件包括Dataset Controller、各Runtime Controller以及Application Controller。在本地运行控制器组件前，需要在本地环境提前配置kubeconfig（通过KUBECONFIG环境变量配置或通过$HOME/.kube/config文件配置），并能正常访问一个Kubernetes集群。

Fluid Webhook组件或Fluid CSI插件无法在本地运行与Kubernetes集群交互。调试此类组件需要首先进行镜像构建，手动替换charts/fluid/fluid/values.yaml的对应镜像地址后，使用helm部署到Kubernetes集群后运行，并通过dlv远程调试进行此类组件的调试。

本地命令行调试

确保环境中已经安装了go-delve，具体安装过程可以参考go-delve安装手册

$ dlv debug cmd/alluxio/main.go

本地VSCode调试

如果使用VSCode作为开发环境，可直接安装VSCode的Go插件并进行本地调试。以调试Alluxio Runtime Controller为例，可在./.vscode/launch.json中定义如下Go代码调试任务：

{
    "version": "0.2.0",
    "configurations": [
       {
            "name": "Alluxio Runtime Controller",
            "type": "go",
            "request": "launch",
            "mode": "debug",
            "program": "cmd/alluxio/main.go",
            "args": ["start", "--development=true", "--enable-leader-election"],
            "env": {
                "KUBECONFIG": "<path>/<to>/<kubeconfig>",
                "ALLUXIO_RUNTIME_IMAGE_ENV": "alluxio/alluxio-dev:2.9.0",
                "ALLUXIO_FUSE_IMAGE_ENV": "alluxio/alluxio-dev:2.9.0",
                "DEFAULT_INIT_IMAGE_ENV": "fluidcloudnative/init-users:v0.8.0-5bb4677",
                "MOUNT_ROOT": "/runtime-mnt",
                "HOME": "<HOME_PATH>"
            }
        },
    ]
}

远程调试

针对Fluid Webhook和Fluid CSI插件等组件，通常情况下更为常用的方式是远程调试，确保本机和组件镜像中均已正确安装了go-delve

在远程主机上:

$ dlv debug --headless --listen ":12345" --log --api-version=2 cmd/alluxio/main.go

这将使得远程主机的调试程序监听指定的端口(e.g. 12345)

在本机上:

$ dlv connect "<remote-addr>:12345" --api-version=2

注意：要进行远程调试，请确保远程主机指定的端口未被占用并且已经对远程主机的防火墙进行了适当的配置