vpp-agent的REST API使用及其原理

最新推荐文章于 2024-06-02 09:59:47 发布
最新推荐文章于 2024-06-02 09:59:47 发布
阅读量948 收藏 1
点赞数
分类专栏： vpp-agent vpp 文章标签： json java 网络
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/clearlxj/article/details/126596352
版权

启动程序

REST API 启动程序：vpp-agent/cmd/vpp-agent/main.go
API 文档：https://docs.ligato.io/en/latest/api/api-vpp-agent/

启动端口为9191，暂未找到修改点

监听的socket文件为/run/vpp/api.sock，暂未找到修改点

测试vpp配置文件如下：

unix {
    cli-listen /run/vpp/cli.sock
    cli-no-pager
    full-coredump
    log /home/data/vpp/vpp.log
    runtime-dir /home/data/vpp
    pidfile /home/data/vpp/agentvpp1.pid
}
plugins {
    plugin dpdk_plugin.so {
        disable
    }
}
socksvr {
    socket-name /run/vpp/api.sock
}
statseg {
    socket-name /run/vpp/stats.sock
    per-node-counters on
}

Api 介绍

VPP Agent 实现了两个 API：

NB API：外部客户端与 VPP Agent 进行交互的接口，客户端可以完成 VPP configuration management。

SB API：VPP Agent 与 VPP Data Plane 进行交互的接口。完成 VPP Data Plane 的 Events、Notifications 和 Configuration Dumps 操作。

通过 VPP Agent 提供的 REST plugin 我们可以完成以下两类操作：

NB configuration management

SB VPP configuration dumps

NB Configuration

NB Configuration 用于完成对 VPP Data Plane 的查询、配置、验证等操作。

PUT /configuration?replace
GET /configuration
GET /info/configuration/jsonschema
POST /configuration/validate
PUT /configuration

例如：

cat loop-bd.yaml

vppConfig:
  interfaces:
  - name: loop1
    type: SOFTWARE_LOOPBACK
    enabled: true
    ipAddresses:
    - 192.168.1.1/24
  bridgeDomains:
  - name: bd1
    forward: true
    learn: true
    interfaces:
    - name: loop1

curl -X PUT -H "Content-Type: application/yaml" --data-binary @loop-bd.yaml http://localhost:9191/configuration

SB Dumps

SB Dumps 仅用于获取 VPP Data Plane 的运行时配置信息。详细见 API 文档。

Execute VPP CLI commands through a REST API

VPP Agent REST Plugin 还支持通过 REST API 来执行 VPP CLI 指令，例如：

curl -X POST 'http://localhost:9191/vpp/command?Content-Type=application/json' \
-H 'Content-Type: application/json' \
-d '{"vppclicommand":"show version"}'

"vpp v21.10.1-release built by root on 4f6ead0c141f at 2021-11-17T14:25:30\n"

Proto文件

vpp-agent/proto/ligato

Vpp插件相关功能的proto文件存放在vpp-agent/proto/ligato/vpp

Linux插件相关功能的proto文件存放在vpp-agent/proto/ligato/linux

REST API文件

url文件：vpp-agent/plugins/restapi/resturl/urls.go

处理url的代码：vpp-agent/plugins/restapi/resturl/handlers.go

BinApi 文件

vpp-agent/plugins/vpp/binapi/

在Interface插件二次开发接口

使用2110版本的vpp调用的接口是2106的接口

定义url：vpp-agent/plugins/restapi/resturl/urls.go

const (
    ...
	// zhkj开发
	ZHKJ_CreateLoopback = "/zhkj/vpp/v2/interafces/loopback"
)

注册url：vpp-agent/plugins/restapi/resturl/plugin_restapi.go

// Fill index item lists
func getIndexPageItems() map[string][]indexItem {
	idxMap := map[string][]indexItem{
		...
		"Interface plugin": {
            ...
			// zhkj开发
			{Name: "zhkj create loopback interface", Path: resturl.ZHKJ_CreateLoopback},
		},
        ...
    }
	return idxMap
}


// Create permission groups (tracer, telemetry, dump - optionally add more in the future). Used only if
// REST security is enabled in plugin
func getPermissionsGroups() []*access.PermissionGroup {
	...
	dumpPg := &access.PermissionGroup{
		Name: "dump",
		Permissions: []*access.PermissionGroup_Permissions{
			...
			// zhkj 开发
			newPermission(resturl.ZHKJ_CreateLoopback, POST),
		},
	}

	return []*access.PermissionGroup{infoPg, tracerPg, telemetryPg, dumpPg,
		nbConfigValidationPg, nbConfigReadPg, nbConfigWritePg}
}

url调用处理（测试）：vpp-agent/plugins/restapi/resturl/handlers.go

// Registers interface REST handlers
func (p *Plugin) registerInterfaceHandlers() {
	...
	// zhkj 开发 POST create loopback interface
	p.registerHTTPHandler(resturl.ZHKJ_CreateLoopback, POST, func() (interface{}, error) {
		return "zhkj gogogogo", nil
	})
}

调用测试一：

lxj@lxj:~/vpp$ curl -X POST http://localhost:9191/zhkj/vpp/v2/interafces/loopback
"zhkj gogogogo"

url调用处理：vpp-agent/plugins/restapi/resturl/handlers.go

// Registers interface REST handlers
func (p *Plugin) registerInterfaceHandlers() {
	...
	// zhkj 开发 POST create loopback interface
	p.registerHTTPHandler(resturl.ZHKJ_CreateLoopback, POST, func() (interface{}, error) {
		return "success", p.ifHandler.CreateLoopbackByZhkj(context.TODO())
	})
}

在接口中声明方法：vpp-agent/plugins/vpp/ifplugin/vppcalls/interface_hander_api.go

type InterfaceVppRead interface {
	...
	// zhkj 开发 创建loopback
	CreateLoopbackByZhkj(ctx context.Context) error
}

在所有版本下实现方法：vpp-agent/plugins/vpp/ifplugin/vppcalls/vpp2106/dump_interface_vppcalls.go

// zhkj 开发
func (h *InterfaceVppHandler) CreateLoopbackByZhkj(ctx context.Context) error {
	// Dump all

	fmt.Println("2106 CreateLoopback By Zhkj")

	// 一条消息的
	reqCtx := h.callsChannel.SendRequest(&vpp_ifs.CreateLoopback{})

	reply := &vpp_ifs.CreateLoopbackReply{}
	fmt.Println(reply, reply.Retval, reply.SwIfIndex)
	
	err := reqCtx.ReceiveReply(reply)
	if err != nil {
		return err
	}

	// 多条消息的
	// reqCtx := h.callsChannel.SendMultiRequest(&vpp_ifs.CreateLoopback{})
	// for {
	// 	reply := &vpp_ifs.CreateLoopbackReply{}
	// 	over, err := reqCtx.ReceiveReply(reply)

	// 	fmt.Println(reply, reply.Retval, reply.SwIfIndex)

	// 	if over {
	// 		break
	// 	}
	// 	if err != nil {
	// 		return err
	// 	}
	// }

	return nil
}

如果之后确定是哪个版本，可以将其他版本删了

NB API的调用过程

vpp-agent/plugins/kvscheduler/*.go

txn_process的processTransaction方法

processTransaction 分 6 步处理事务：
 1. 预处理：事务参数被初始化，重试操作从过时的操作中过滤出来，并且为了重新同步，图形被刷新
 2. 排序：使用启发式的预排序操作以获得最短的平均图游走
 3. 模拟：模拟事务而不实际执行任何创建/删除/更新操作以获得“执行计划”
 4. 预记录：在执行前记录事务参数+计划，以保存一些信息，以防执行过程中发生崩溃
 5. 执行：执行事务，收集错误
 6. Recording：记录最终确定的事务（log + in-memory）
 7. 后处理：为失败的操作安排重试，将值状态更新传播给订阅者，并将error/nil返回给阻塞提交的调用者
 8. 交易统计更新

执行过程，以以下yaml为例

vppConfig:
  interfaces:
  - name: "loop1"
    type: SOFTWARE_LOOPBACK
    enabled: true
    ipAddresses:
    - 192.168.1.1/24
  bridgeDomains:
    - name: bd1
      forward: true
      learn: true
      interfaces:
        - name: loop1

以上yaml数据将会先转为json再转为kv结构

- key: config/vpp/l2/v2/bridge-domain/bd1
  val: { name:"bd1" forward:true learn:true interfaces:{name:"loop1"} }
- key: config/vpp/v2/interfaces/loop1
  val: { name:"loop1" type:SOFTWARE_LOOPBACK enabled:true ip_addresses:"192.168.1.1/24" }

其具体执行过程为：

[BEGIN] execute transaction (seqNum=1)
  [BEGIN] applyValue (key = config/vpp/l2/v2/bridge-domain/bd1)
    [BEGIN] applyCreate (key = config/vpp/l2/v2/bridge-domain/bd1)
      -> change value state from NONEXISTENT to CONFIGURED
      [BEGIN] runDepUpdates (key = config/vpp/l2/v2/bridge-domain/bd1)
      [END] runDepUpdates (key = config/vpp/l2/v2/bridge-domain/bd1)
      [BEGIN] applyDerived (key = config/vpp/l2/v2/bridge-domain/bd1)
        [BEGIN] applyValue (key = vpp/bd/bd1/interface/loop1)
          [BEGIN] applyCreate (key = vpp/bd/bd1/interface/loop1)
            -> change value state from NONEXISTENT to PENDING
          [END] applyCreate (key = vpp/bd/bd1/interface/loop1)
        [END] applyValue (key = vpp/bd/bd1/interface/loop1)
      [END] applyDerived (key = config/vpp/l2/v2/bridge-domain/bd1)
    [END] applyCreate (key = config/vpp/l2/v2/bridge-domain/bd1)
  [END] applyValue (key = config/vpp/l2/v2/bridge-domain/bd1)
  [BEGIN] applyValue (key = config/vpp/v2/interfaces/loop1)
    [BEGIN] applyCreate (key = config/vpp/v2/interfaces/loop1)
      -> change value state from NONEXISTENT to CONFIGURED
      [BEGIN] runDepUpdates (key = config/vpp/v2/interfaces/loop1)
        [BEGIN] applyValue (key = vpp/bd/bd1/interface/loop1)
          [BEGIN] applyCreate (key = vpp/bd/bd1/interface/loop1)
            -> change value state from PENDING to CONFIGURED
            [BEGIN] runDepUpdates (key = vpp/bd/bd1/interface/loop1)
            [END] runDepUpdates (key = vpp/bd/bd1/interface/loop1)
          [END] applyCreate (key = vpp/bd/bd1/interface/loop1)
        [END] applyValue (key = vpp/bd/bd1/interface/loop1)
      [END] runDepUpdates (key = config/vpp/v2/interfaces/loop1)
      [BEGIN] applyDerived (key = config/vpp/v2/interfaces/loop1)
        [BEGIN] applyValue (key = vpp/interface/loop1/address/static/192.168.1.1/24)
          [BEGIN] applyCreate (key = vpp/interface/loop1/address/static/192.168.1.1/24)
            -> change value state from NONEXISTENT to PENDING
          [END] applyCreate (key = vpp/interface/loop1/address/static/192.168.1.1/24)
        [END] applyValue (key = vpp/interface/loop1/address/static/192.168.1.1/24)
        [BEGIN] applyValue (key = vpp/interface/loop1/has-IP-address)
          [BEGIN] applyCreate (key = vpp/interface/loop1/has-IP-address)
            -> change value state from NONEXISTENT to PENDING
          [END] applyCreate (key = vpp/interface/loop1/has-IP-address)
        [END] applyValue (key = vpp/interface/loop1/has-IP-address)
        [BEGIN] applyValue (key = vpp/interface/loop1/vrf/0/ip-version/v4)
          [BEGIN] applyCreate (key = vpp/interface/loop1/vrf/0/ip-version/v4)
            -> change value state from NONEXISTENT to CONFIGURED
            [BEGIN] runDepUpdates (key = vpp/interface/loop1/vrf/0/ip-version/v4)
              [BEGIN] applyValue (key = vpp/interface/loop1/address/static/192.168.1.1/24)
                [BEGIN] applyCreate (key = vpp/interface/loop1/address/static/192.168.1.1/24)
                  -> change value state from PENDING to CONFIGURED
                  [BEGIN] runDepUpdates (key = vpp/interface/loop1/address/static/192.168.1.1/24)
                    [BEGIN] applyValue (key = vpp/interface/loop1/has-IP-address)
                      [BEGIN] applyCreate (key = vpp/interface/loop1/has-IP-address)
                        -> change value state from PENDING to CONFIGURED
                        [BEGIN] runDepUpdates (key = vpp/interface/loop1/has-IP-address)
                        [END] runDepUpdates (key = vpp/interface/loop1/has-IP-address)
                      [END] applyCreate (key = vpp/interface/loop1/has-IP-address)
                    [END] applyValue (key = vpp/interface/loop1/has-IP-address)
                  [END] runDepUpdates (key = vpp/interface/loop1/address/static/192.168.1.1/24)
                [END] applyCreate (key = vpp/interface/loop1/address/static/192.168.1.1/24)
              [END] applyValue (key = vpp/interface/loop1/address/static/192.168.1.1/24)
            [END] runDepUpdates (key = vpp/interface/loop1/vrf/0/ip-version/v4)
          [END] applyCreate (key = vpp/interface/loop1/vrf/0/ip-version/v4)
        [END] applyValue (key = vpp/interface/loop1/vrf/0/ip-version/v4)
      [END] applyDerived (key = config/vpp/v2/interfaces/loop1)
    [END] applyCreate (key = config/vpp/v2/interfaces/loop1)
  [END] applyValue (key = config/vpp/v2/interfaces/loop1)
[END] execute transaction (seqNum=1)

具体步骤为：
1. CREATE:
	- key: config/vpp/l2/v2/bridge-domain/bd1
	- value: { name:"bd1" forward:true learn:true interfaces:{name:"loop1"} } 
2. CREATE:
	- key: config/vpp/v2/interfaces/loop1
	- value: { name:"loop1" type:SOFTWARE_LOOPBACK enabled:true ip_addresses:"192.168.1.1/24" } 
3. CREATE [DERIVED]:
	- key: vpp/bd/bd1/interface/loop1
	- value: { name:"loop1" } 
4. CREATE [DERIVED]:
	- key: vpp/interface/loop1/vrf/0/ip-version/v4
	- value: <EMPTY> 
5. CREATE [DERIVED]:
	- key: vpp/interface/loop1/address/static/192.168.1.1/24
	- value: <EMPTY> 
6. CREATE [DERIVED]:
	- key: vpp/interface/loop1/has-IP-address
	- value: <EMPTY>

以第一个创建config/vpp/l2/v2/bridge-domain/bd1为例，执行调用函数过程为：

PUT /configuration
Plugin.configurationUpdateHandler (将yaml数据转成json之后，根据json中字段转成k-v结构)
Plugin.dispatcher.PushData
txn.Commit             (将配置提交到事务队列中)

preRecordTransaction   (从事务队列中拿出执行)
Scheduler.executeTransaction
Scheduler.applyValue
Scheduler.applyCreate 
Scheduler.registry.GetDescriptorForKey          (key是config/vpp/l2/v2/bridge-domain/bd1，获取到的desriptor名字是 vpp-bridge-domain，本方法在plugins/kvsheduler/internal/registry/registry_impl.go中)
descriptorHandler.create
BridgeDomainDescriptor.Create
BridgeDomainVppHandler.AddBridgeDomain
BridgeDomainVppHandler.callsChannel.SendRequest(req).ReceiveReply(reply) (实际也是调用GoVpp)
魔笛Love
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
VPP-API（Golang）
我要出家当道士
11-29 1316
VPP-API的使用demo
govpp分析
gbbfum的博客
01-17 1628
介绍 govpp是使用go语言开发的与vpp通信交互的一套程序接口。go vpp提供了同步阻塞和异步非阻塞的2种接口。go vpp和vpp可以基于共享内存或者域套接字的方式通信。 分析 通过域套接字通信结构图： ...
探索高效网络处理新境界：GoVPP——面向Go语言的VPP交互库
最新发布
gitblog_00039的博客
06-02 616
探索高效网络处理新境界：GoVPP——面向Go语言的VPP交互库 项目地址:https://gitcode.com/FDio/govpp 在高速发展的网络技术领域，一款强大而灵活的工具对于开发者来说至关重要。今天，我们来深入了解一个开源项目——GoVPP，它为Go程序员打开了与Vector Packet Processing (VPP)平台直接对话的大门，从而解锁更高效的网络数据处理能力。 项目介...
VPP-Agent执行
turbock的博客
10-24 1472
./vpp-agent -etcd-config=/root/go/src/github.com/ligato/vpp-agent/examples/localclient_with_etcd/etcd.conf 或 ./vpp-agent -config-dir=/etc/vpp-agent -microservice-label="00000011" 环境变量配置： export...
VPP Agent 简介
mr1jie的博客
08-15 2282
文章目录VPP Agent OverviewVPP Agent 功能VPP Agent FeaturesVPP 配置和管理重新同步插件概念说明CN-InfraPlugins配置插件GoVPPMuxOrchestratorRest APITelemetryKVScheduler默认提供的 VPP 核心功能插件Linux 插件CN-Infra 提供的 PluginVPP-Agent-ctl VPP Agent Overview VPP Agent 是为 VPP 基于云原生虚拟网元、 GO 语言实现的控制面/管理
简单实现使用API通信的vpp管理进程（C语言）
天寒寒的博客
02-23 3057
所幸，vpp 还提供了 API 供管理程序调用。这个 API 是基于共享内存实现的消息，管理程序可以异步的非阻塞的处理相关消息。通过这些 API，我们就可以实现在不同的进程上去管理 vpp，而且可以实现非常高的吞吐量。
关于vpp agent的处理北向和南向的理解
anzhuangguai的专栏
06-16 367
1 vpp agent处理acl的时候，采用格式/etcd/path/acl/acl-label下发2 vpp处理acl的时候，采用格式acl add srcip 1234 dstip 2341在返回结果里会生成一个id3 如何将label和id统一起来？4 有两种方法，方法一，是将vpp的处理acl的接口多增加一个label。这样做的有一个nat44-ed中的DNAT是这样处理的。方法二，是不修改vpp的代码，在vpp-agent里面做文章。详细描述如下，5描述符（descriptor）里包括了获取，更新
vpp_api:用于VoxPoppuli的Rest API
05-10
VoxPoppuli的REST API，也称为vpp_api，是一种用JavaScript编写的接口，它允许开发者通过HTTP请求与VoxPoppuli平台进行交互，实现数据的获取、创建、更新和删除等操作。在软件开发中，REST（Representational State ...
vpp-api-python-18.01.1-1.x86_64.rpm
12-23
官方离线安装包，测试可用。使用rpm -ivh [rpm完整包名] 进行安装
vpp-api-python-18.01.2-1.x86_64.rpm
12-23
官方离线安装包，测试可用。使用rpm -ivh [rpm完整包名] 进行安装
vpp-wrt-admin:vpp-wrt后端模块
05-18
这会将 vpp-wrt-admin 模块及其所有依赖项下载到你的项目中的 `node_modules` 目录下。 ### 运行 安装完成后，你可以通过 npm 来启动 vpp-wrt-admin。在项目根目录下执行： ```bash npm run start ``` 这将启动 ...
vpp-api-python-17.10-1.x86_64.rpm
12-23
官方离线安装包，测试可用。使用rpm -ivh [rpm完整包名] 进行安装
用户级协议和框架：DPDK、SPDK和VPP的业务场景和发展趋势
统信软件的博客
09-12 1767
在当今数字化世界中，网络通信和存储技术一直是不可或缺的要素，特别是在云计算、边缘计算和物联网等领域。传统的内核级别协议和框架在某些场景下已经显得不够灵活和高效。为了满足更高的性能、更低的延迟和更大的可扩展性需求，用户级别的协议和框架开始崭露头角。
vpp api （1）-- trace 方法
xulu_1990的博客
05-23 738
Cisco vpp api trace命令使用
VPP-如何使用C-API
mrtyxr的博客
03-16 832
1）所有API函数都被在C 头文件中描述2）所有VPP API间的交互通过直接的C函数调用。
vpp-agent插件开发指南
anzhuangguai的专栏
06-13 594
Hello World - Ligato Docs以我开发的cnat为例，1 协议定义cnat.proto协议定义后使用protoc来自动生成go的protobuf原语2 模型定义用于etcd访问获取，例如root@tfw:~# ETCDCTL_API=3 etcdctl get --prefix /vnf-agent/vpp1/config/vpp/nat/v2/nat44-global /vnf-agent/vpp1/config/vpp/nat/v2/nat44-global {"forwarding
Ligato/vpp agent介绍和使用
weixin_44764814的博客
11-21 2370
Ligato/vpp agent介绍和使用 介绍 Ligato 是一个 Golang 框架，用于开发 APP 控制和管理云原生网络功能（cloud native virtual network function, CNF）。 现在云提供商逐步转型以云原生的方式来开发、部署、管理应用。应用被实现为微服务，打包为容器的方式，并以 Pod 的方式动态部署到物理或虚拟机上。 Kubernetes调度并编排容器的启停、部署、扩展、容错等，自动管理应用和服务的生命周期。 网络在云原生的环境中发挥这非常重要的作用，很多
vpp+vpp-agent+etcd环境搭建和测试
windStudyer的专栏
03-07 1765
注：先安装go，因为etcd和vpp-agent都需要使用go开发的，所以需要go环境的支持 go安装过程如下： (1)官网下载对应链接： 链接：https://golang.google.cn/dl/ centos7下使用：wgethttps://dl.google.com/go/go1.13.linux-amd64.tar.gz（前提先有wget命令） wget安装：yum -y install wget (2)解压到/usr/local/目录下： tar -xvf go1.12.lin.
VPP Agent USER GUIDE
mr1jie的博客
08-15 424
文章目录Getting Started容器部署部署 docker拉取 vpp-agent 镜像拉取 etcd 镜像 和启动 etcd启动 vpp-agent 和 vpp编译部署安装 go拉取代码编译最新稳定版本设置配置启动 Getting Started 容器部署 部署 docker $ curl -fsSL https://get.docker.com | bash -s docker --mirror Aliyun 拉取 vpp-agent 镜像 镜像包含 vpp-agent 和 vpp $ dock
dbm-vpp-vrms-watts
09-20
在电学中，DBM、VPP、VRMS和Watts都是用来描述电信号的基本参数。 DBM（分贝毫瓦）是用来表示电功率的单位，它是通过对数比例单位来测量信号的相对功率水平。DBM常用于衡量声音和无线信号的强度。在一些无线通讯设备中，信号强度常常以DBM来表示，例如手机信号强度。 VPP（峰峰值）是电信号的峰值与峰值之间的差值，通常用来表示信号的振幅。VPP是一种测量信号幅度的方式，特别适用于交流信号。例如，在示波器上，可以通过峰峰值来评估信号的幅度。 VRMS（有效值）是交流电信号（如正弦波）的有效电平值，它描述了信号的平均功率。VRMS是通过对信号进行平方根处理，然后再取平均值来计算的。在交流电路中，VRMS可用于计算电流和电压的功率，也常用于评估电源的稳定性。 Watts（瓦）是功率的单位，表示电流通过电路时产生的功率。瓦特是衡量电流和电压之间的关系的值，用于描述电路的能量转换。在家庭电路和工业设备中，瓦特常用于衡量功耗、电能消耗以及设备的功率需求。 综上所述，DBM、VPP、VRMS和Watts是电信号中常用的参数单位，用于描述功率、幅度和能量转换等方面。每个单位都有其独特的应用场景和测量方法，对于电学工程师和无线通信领域的专业人员来说，了解和理解这些参数是非常重要的。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值