https://github.com/hellt/gnmi-map

gNMI service map
https://github.com/hellt/gnmi-map

gnmi grpc network-automation openconfig telemetry

Last synced: about 1 year ago
JSON representation

gNMI service map

• Host: GitHub
• URL: https://github.com/hellt/gnmi-map
• Owner: hellt
• Created: 2020-06-08T18:40:06.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2020-07-07T07:48:31.000Z (over 5 years ago)
• Last Synced: 2025-03-18T22:21:55.370Z (about 1 year ago)
• Topics: gnmi, grpc, network-automation, openconfig, telemetry
• Homepage: https://netdevops.me/2020/gnmi-map/
• Size: 105 KB
• Stars: 32
• Watchers: 5
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

          
# gNMI Map

[![map](https://gitlab.com/rdodin/pics/-/wikis/uploads/6a9d18f9cb2240656aad5d224aa757df/rsz_image.png)](https://gitlab.com/rdodin/pics/-/wikis/uploads/d275425d2b66601be213c6722dadd4d6/gnmi_0.7.0_map.pdf)

gNMI Map provides a visual representation of the [gNMI](https://github.com/openconfig/reference/blob/master/rpc/gnmi/gnmi-specification.md) service.

It contains all the RPCs, messages and custom types defined in the [gnmi.proto](https://github.com/openconfig/gnmi/blob/master/proto/gnmi/gnmi.proto) file mapped as a block diagram with inter-message relationship.

gNMI Map makes it easy to understand the composition of the gNMI service as well as it provides the relevant links to the documentation and proto references.



## Usage

The map can be downloaded from this repository or viewed right in a browser. The maps for the following gNMI service versions have been created so far:

* **gNMI 0.7.0** - [view](https://gitlab.com/rdodin/pics/-/wikis/uploads/d275425d2b66601be213c6722dadd4d6/gnmi_0.7.0_map.pdf) / [download](https://github.com/hellt/gnmi-map/raw/master/gnmi_0.7.0_map.pdf)

## OS X Preview app issue

Mac OS X default PDF reader app - Preview - messes with the link fragments (`http://url.com/page#fragment`), therefore the links won't work in this app (see [1](https://discussions.apple.com/thread/251041261), [2](https://discussions.apple.com/thread/250919338)).