faucet/gnmi-pi

gNMI - gRPC网络管理接口

镜像概述和主要用途

该Docker镜像用于使用Openconfig模型测试gNMI（gRPC网络管理接口）协议，提供证书生成、默认测试目标及相关工具，方便进行gNMI协议的功能验证和调试。

• 参考https://github.com/openconfig/reference/tree/master/rpc/gnmi
• 参考Openconfig文档

核心功能和特性

• 自动生成辅助证书集，包括：
  • 自签名CA证书
  • CA签名的客户端证书
  • CA签名的服务器证书
• 内置默认测试gNMI目标，包含JSON格式的模拟配置
• 提供gNMI工具集，支持Get、Capabilities等操作

使用场景和适用范围

• gNMI协议兼容性测试
• Openconfig模型功能验证
• 网络管理接口开发调试
• gNMI客户端与服务端交互测试

构建镜像

从gnmi目录执行以下命令构建镜像：

bash
docker build -t faucet/gnmi -f Dockerfile .

构建过程中会生成辅助证书集，并保存至$HOME/certs/目录。

运行镜像

基本运行

bash
docker run -ti faucet/gnmi:latest

运行容器时，会启动默认测试gNMI目标，其配置由JSON文件定义。启动脚本如下：

bash
root@090fe3d66fe7:~# cat run_target.sh
#!/bin/sh
gnmi_target \
  -bind_address :$GNMI_PORT \
  -key $HOME/certs/server.key \
  -cert $HOME/certs/server.crt \
  -ca $HOME/certs/ca.crt \
  -alsologtostderr \
  -config target_configs/typical_ofsw_config.json

环境变量

容器默认环境变量：

• GNMI_PORT=32123：gNMI服务端口
• GNMI_TARGET=localhost：目标地址

执行gNMI Get操作

bash
root@090fe3d66fe7:~# cat get.sh
#!/bin/sh
gnmi_get \
  -target_addr $GNMI_TARGET:$GNMI_PORT \
  -key $HOME/certs/client.key \
  -cert $HOME/certs/client.crt \
  -ca $HOME/certs/ca.crt \
  -target_name server.com \
  -alsologtostderr \
  -xpath "/system/openflow/agent/config/datapath-id" \
  -xpath "/system/openflow/controllers/controller[name=main]/connections/connection[aux-id=0]/config/address"

执行gNMI Capabilities操作

bash
root@090fe3d66fe7:~# cat capabilities.sh
#!/bin/sh
gnmi_capabilities \
  -target_addr $GNMI_TARGET:$GNMI_PORT \
  -key $HOME/certs/client.key \
  -cert $HOME/certs/client.crt \
  -ca $HOME/certs/ca.crt \
  -target_name server.com \
  -alsologtostderr

自定义目标

可通过覆盖GNMI_TARGET和GNMI_PORT环境变量来测试其他gNMI目标，或直接使用二进制工具进行操作。

gNxI工具

相关工具参考：https://github.com/google/gnxi