intel/opae-nlb-demo

OPAE nlb 示例应用镜像文档

1. 镜像概述

OPAE nlb 示例应用镜像基于 Open Programmable Acceleration Engine (OPAE) 原生环回适配器（nlb）加速功能单元（AFU）构建，主要用于展示 Intel FPGA 设备插件功能及基于 OPAE 的 FPGA 编程方法。该镜像包含预编译的示例应用，可帮助用户快速理解 FPGA 设备在容器环境中的集成与使用方式。

2. 核心功能与特性

2.1 核心功能

• 演示 Intel FPGA 设备插件在容器环境中的基本功能，包括设备发现、资源分配与访问控制。
• 提供基于 OPAE 框架的 FPGA 编程示例，展示 AFU（加速功能单元）的加载与交互流程。
• 通过 nlb AFU 实现 FPGA 原生环回通信，验证设备数据通路与性能。

2.2 主要特性

• 轻量级镜像，集成必要的 OPAE 运行时依赖与示例应用。
• 与 Intel FPGA 设备插件（Kubernetes 生态）兼容，支持容器化部署与资源调度。
• 提供可复现的 FPGA 编程流程，降低 FPGA 应用开发入门门槛。

3. 使用场景与适用范围

3.1 适用场景

• 开发者学习：供 FPGA 应用开发者学习基于 OPAE 的编程模型及设备插件集成方法。
• 测试验证：在实验室环境中验证 FPGA 设备插件功能、AFU 加载流程及环回通信性能。
• 技术评估：评估 Intel FPGA 设备在容器化环境中的可行性与性能表现。

3.2 适用人群

• FPGA 应用开发者、嵌入式系统工程师。
• Kubernetes 设备插件开发与维护人员。
• 需评估 FPGA 加速技术的技术架构师。

4. 使用方法与配置说明

4.1 前置条件

• 宿主环境需配备 Intel FPGA 设备（如 Arria 10、Stratix 10 等），并已安装 Intel FPGA 设备驱动与 OPAE 运行时（参考 https://opae.github.io/%EF%BC%89%E3%80%82
• 若在 Kubernetes 环境中使用，需先部署 Intel FPGA 设备插件（参考 https://github.com/intel/intel-device-plugins-for-kubernetes%EF%BC%89%E3%80%82

4.2 基本使用（Docker 命令行）

4.2.1 本地容器运行

通过 docker run 命令启动容器，需挂载 FPGA 设备路径并配置设备访问权限：

bash
docker run --rm -it \
  --device /dev/intel-fpga-port.0 \  # 挂载 FPGA 设备端口（根据实际设备调整）
  --device /dev/intel-fpga-fme.0 \   # 挂载 FPGA 管理设备（根据实际设备调整）
  -v /opt/opae/nlb:/opt/nlb \        # 挂载本地 AFU 配置文件（可选）
  intel/opae-nlb-samples:latest      # 镜像名称（示例，需替换为实际镜像标签）

4.2.2 运行示例应用

容器启动后，可执行内置示例应用（如 nlb3、nlb0 等，具体取决于镜像版本）：

bash
# 运行 nlb3 环回测试应用
./nlb3 --mode=loopback --iterations=1000

4.3 Kubernetes 环境部署（示例）

通过 Kubernetes Pod 部署示例应用，需指定 FPGA 设备资源：

yaml
# fpga-nlb-sample.yaml
apiVersion: v1
kind: Pod
metadata:
  name: fpga-nlb-sample
spec:
  containers:
  - name: nlb-app
    image: intel/opae-nlb-samples:latest
    command: ["./nlb3", "--mode=loopback", "--iterations=1000"]
    resources:
      limits:
        intel.com/fpga-arria10-nlb3: 1  # 请求 1 个 FPGA 设备（资源名称需与设备插件配置匹配）

部署命令：

bash
kubectl apply -f fpga-nlb-sample.yaml

4.4 配置参数说明

4.4.1 环境变量

4.4.2 设备挂载

4.5 注意事项

• FPGA 设备路径（如 /dev/intel-fpga-port.0）需根据宿主环境实际设备调整，可通过 ls /dev/intel-fpga-* 查看。
• 示例应用的具体名称（如 nlb3）可能因镜像版本而异，建议通过 ls / 查看容器内可执行文件。

5. 参考资料

• https://github.com/intel/intel-device-plugins-for-kubernetes
• https://opae.github.io/
• Intel FPGA 开发者社区