mellanox/ufm-plugin-rest-rdma

ufm-rest-rdma 镜像文档

概述

ufm-rest-rdma是一款通过IB（InfiniBand）向UFM服务器发送REST请求的工具，支持服务器和客户端两种运行模式。作为服务器时，可作为UFM插件部署；作为客户端时，可在与UFM服务器相同fabric的任意主机上运行，实现高效的RDMA网络REST通信。

核心功能与特性

• 双模式支持：同时支持服务器模式（作为UFM插件）和客户端模式（独立运行）
• 高可用性：服务器模式下自动启动ufm_rdma.py，进程退出时自动重启
• 灵活部署：支持UFM Appliance、UFM SA（单机）和HA（高可用）环境部署
• 多种认证方式：支持用户名密码认证、客户端证书认证和令牌认证
• 日志可追溯：服务器日志文件ufm_rest_over_rdma.log位于主机/opt/ufm/files/log目录

使用场景

• UFM服务器插件：在UFM Appliance或UFM SA/HA环境中作为插件部署，提供RDMA REST服务
• 远程客户端：在与UFM服务器相同fabric的主机上运行，通过IB发送REST请求管理UFM资源
• 自动化运维：通过客户端脚本集成到自动化流程，实现UFM资源的远程管理和监控

部署与使用指南

服务器部署

UFM Appliance部署步骤

1. 以admin用户登录UFM Appliance
2. 执行enable进入特权模式
3. 执行config terminal进入配置模式
4. 检查UFM状态：show ufm status，若未运行则启动：ufm start
5. 检查rest-rdma插件状态：show ufm plugin，确保其处于禁用状态
6. 拉取镜像：docker pull mellanox/ufm-plugin-rest-rdma
7. 启用插件：ufm plugin ufm-plugin-rest-rdma add
8. 验证插件状态：ufm plugin show，确认插件已运行

UFM SA/HA部署步骤

1. 安装最新版本UFM
2. 启动UFM服务：/etc/init.d/ufmd start
3. 拉取镜像：docker pull mellanox/ufm-plugin-rest-rdma
4. 启用插件：/opt/ufm/scripts/manage_ufm_plugins.py add -p rest-rdma
5. 验证插件状态：docker ps，确认容器运行

客户端部署

镜像准备

1. 拉取镜像：docker pull mellanox/ufm-plugin-rest-rdma
2. （离线部署）加载本地镜像：docker load < ufm-plugin-rest-rdma_[version].tar.gz

启动客户端容器

bash
docker run -d --network=host --privileged --name=ufm-plugin-rest-rdma --rm -v /tmp/ibdiagnet:/tmp/ibdiagnet mellanox/ufm-plugin-rest-rdma_[version] client

进入容器（如需在容器内执行请求）

bash
docker exec -it ufm-plugin-rest-rdma bash

使用方法

服务器模式

• 服务器模式下，ufm_rdma.py会自动启动，进程退出时自动重启
• 若未自动运行，可手动启动：./ufm_rdma.py -r server（需在容器内执行）

客户端模式

客户端模式支持两种运行方式：容器内执行或宿主机脚本执行

容器内执行

1. 进入容器后，切换到工作目录：cd /opt/ufm/src/ufm-plugin-rest-rdma
2. 查看帮助获取参数：./ufm_rdma.py -h

宿主机脚本执行

1. 从容器复制客户端脚本到宿主机：docker cp ufm-plugin-rest-rdma:/opt/ufm/ufm-plugin-ufm-rest/ufm_rest_rdma_client.sh .
2. 直接在宿主机运行脚本，查看帮助：./ufm_rest_rdma_client.sh -h

使用示例

以下示例均在客户端容器内执行

用户名密码认证

获取UFM版本

bash
./ufm_rdma.py -r client -u admin -p 123456 -t simple -a GET -w ufmRest/app/ufm_version

获取IBdiagnet运行结果

bash
./ufm_rdma.py -r client -u admin -p 123456 -t ibdiagnet -a POST -w ufmRest/reports/ibdiagnetPeriodic -l '{"general": {"name": "IBDiagnet_CMD_1234567890_199_88", "location": "local", "running_mode": "once"}, "command_flags": {"--pc": ""}}'

客户端证书认证

需指定客户端证书路径和UFM服务器主机名：

bash
./ufm_rdma.py -r client -t simple -a GET -w ufmRest/resources/modules -d /path/to/certificate/file/ufm-client.pfx -s ufm.azurehpc.core.azure-test.net

令牌认证

需在请求中传递令牌参数（具体参数见工具帮助文档）。