faucet/gnmi

gNMI - gRPC网络管理接口 Docker镜像

镜像概述和主要用途

本Docker镜像旨在使用Openconfig模型便捷地测试gNMI（gRPC Network Management Interface）协议。gNMI是一种基于gRPC的网络设备管理接口，而Openconfig则提供了标准化的网络设备配置和操作模型。

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

核心功能和特性

• 证书支持：构建镜像时自动生成一套辅助证书，包括自签名CA证书、CA签名的客户端证书和服务器证书，存储于$HOME/certs/目录
• 默认测试目标：运行镜像时自动启动默认gNMI测试目标，包含预定义的模拟配置（JSON格式）
• gNMI操作支持：内置工具可执行gNMI Get、Capabilities等核心操作
• 环境变量配置：支持通过环境变量GNMI_TARGET和GNMI_PORT自定义目标地址和端口

使用场景和适用范围

• gNMI协议兼容性测试
• Openconfig模型验证
• 网络管理接口功能开发与调试
• 自动化测试环境搭建

使用方法和配置说明

构建镜像

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

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

构建过程中会生成以下证书文件并添加到容器内的$HOME/certs/目录：

• 自签名CA证书
• CA签名的客户端证书
• CA签名的服务器证书

运行镜像

基本运行

bash
docker run -ti faucet/gnmi:latest

运行后，容器会启动一个默认的gNMI测试目标，其配置由target_configs/typical_ofsw_config.json定义。启动脚本如下：

bash
#!/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目标地址

执行gNMI Get操作

容器内提供get.sh脚本用于执行gNMI Get操作：

bash
#!/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"

在容器内直接执行：

bash
./get.sh

执行gNMI Capabilities操作

容器内提供capabilities.sh脚本用于获取gNMI目标能力：

bash
#!/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

在容器内直接执行：

bash
./capabilities.sh

自定义目标配置

通过覆盖环境变量GNMI_TARGET和GNMI_PORT，可针对其他gNMI目标执行操作：

bash
GNMI_TARGET=192.168.1.100 GNMI_PORT=50051 ./get.sh

也可直接使用容器内的二进制工具（gnmi_target、gnmi_get、gnmi_capabilities）进行自定义操作。

gNxI工具

本镜像基于https://github.com/google/gnxi%E6%9E%84%E5%BB%BA%EF%BC%8C%E6%8F%90%E4%BE%9BgNMI%E5%8D%8F%E8%AE%AE%E7%9B%B8%E5%85%B3%E7%9A%84%E5%AE%8C%E6%95%B4%E5%B7%A5%E5%85%B7%E9%93%BE%E6%94%AF%E6%8C%81%E3%80%82