aristanetworks/openmgmt

Documentation and examples for using open network management tools such as OpenConfig

Overview

Welcome to the OpenMgmt project. aristanetworks.github.io/openmgmt

This repository contains documentation and examples for using open network management tools with Arista's EOS platforms. These network management protocols include OpenConfig, NETCONF, RESTCONF and others as appropriate. Contributions, corrections and comments are most welcome. Details regarding how you can contribute, can be found in the contribution guide

openmgmt's Issues

create an example using google collector front end

document the use and application for the google collector

add netconf using ncclient and interactive ssh session

Add footer links to GitHub and other things

We can spice up the footer with some useful links.

Add a nicer icon

Maybe just use the openconfig icon or something?
https://www.openconfig.net/img/oc-logo-accent.svg

Add LANZ Streaming example using Arista gnmi or gnmic

Add example to get/subscribe lanz streaming data from switch using gNMI.

gnmic -a <switch>:6030 -u arista -p arista --insecure --gzip --mode=stream subscribe  --path 'eos_native:/LANZ'

add more cli origin examples

Eg
1)

gnmic -a 10.83.13.214:6030 -u cvpadmin -p arista --insecure --gzip set --request-file bgp.yaml
{
  "timestamp": 1628091791855672771,
  "time": "2021-08-04T16:43:11.855672771+01:00",
  "results": [
    {
      "operation": "UPDATE",
      "path": "cli:"
    },
    {
      "operation": "UPDATE",
      "path": "cli:"
    }
  ]
}

cat bgp.yaml
updates:
 - path: "cli:"
   value: router bgp 65101
   encoding: ascii
 - path: "cli:"
   value: neighbor IPv4-UNDERLAY-PEERS maximum-routes 15500
   encoding: ascii

gnmic -a 10.83.13.214:6030 -u cvpadmin -p arista --insecure --gzip --encoding ASCII set --update-path "cli:" --update-value "router bgp 65101" --update-path "cli:" --upda
te-value "neighbor IPv4-UNDERLAY-PEERS maximum-routes 13500"
{
  "timestamp": 1628091405938523430,
  "time": "2021-08-04T16:36:45.93852343+01:00",
  "results": [
    {
      "operation": "UPDATE",
      "path": "cli:"
    },
    {
      "operation": "UPDATE",
      "path": "cli:"
    }
  ]
}

gnmi -addr 10.83.13.214:6030 -username cvpadmin -password arista update origin=cli "" "router bgp 65101
neighbor IPv4-UNDERLAY-PEERS maximum-routes 12500"

Convert octsdb article to md

Use mkdocs code snippet for code examples

Keep code and text separate

add mixed gnmi SubscribeRequest operations

For telemetry applications

add pyangbing

• generate a python class from yang
• use python and json to generate an OC conf
• use gnmic to push this OC conf

add topics to the repo

could you please add some topics to the current list (top right of repo homepage). we dont have permissions :-)
I suggest you add to the current list these ones: ygot, netconf, restconf, grpcurl, pyang, telemetry, streaming, pygnmi, eos, gnmic, gnoi, go .... The limit is 20.

create an example using gnmi-gw

provide an example of using gnmi-gw

convert openconfigbeat to ELK EOSC article to ELK

Add some of the examples from Tech Friday to this repo

Can you pull over some of your labs from TF here?

Add bot for google chat channel

Make repo notifications show up on the chat

Add config example for the new notification timestamp parameter

newer EOS versions will support notification timestamp <send-time | no> to change the timestamp in a gNMI response from the time it was last changed to the time the notification is sent

Add tags for searchability

Add a bunch of tags for the repo

add multi-key examples for restconf

e.g.:

curl -s GET  --insecure --header 'Accept: application/yang-data+json' -u cvpadmin:arastra 'https://192.0.2.100:5900/restconf/data/network-instances/network-instance=default/protocols/protocol=BGP,BGP/bgp/neighbors' | jq

clean stale branches using CI

deleting stale branches with CI and maybe using another contribution workflow

ygot demo: no such file or directory

~/openmgmt/src/ygot$ go run $GOPATH/src/github.com/openconfig/ygot/generator/generator.go -path=yang -output_file=pkg/oc.go -package_name=oc -generate_fakeroot -fakeroot_name=device -compress_paths=true  yang/openconfig-system.yang
stat /src/github.com/openconfig/ygot/generator/generator.go: no such file or directory

I dont have ygot:

~/openmgmt/src/ygot$ ls $GOPATH/src/github.com/openconfig/
gnmi  gnoi

I had to add this

git clone https://github.com/openconfig/ygot.git $GOPATH/src/github.com/openconfig/ygot

to fix it

@burnyd should we update the example with this instruction?

add OC syslog messages

update https://aristanetworks.github.io/openmgmt/examples/ with all existing examples

some are missing: RESTCONF, Ansible ...

convert gnmi reverse EOSC article to md

add grpctunnel examples with gnmic

https://gnmic.kmrd.dev/user_guide/tunnel_server/

update pyang examples

some examples don't seem to work anymore like for instance the bgp example https://aristanetworks.github.io/openmgmt/examples/pyangbind/ requires also openconfig-network-instances.yang in addition to openconfig-bgp.yang for the demo to work

add a check for the use of non-documentation ranges

we should probably have some sort of automated check for IP addresses that aren't in the documentation range.

add a TIG stack using gNMI

• add a docker-compose file for a TIG stack using gNMI
• include some Grafana dashboards
• include some influxDB cli queries (examples)

add restconf using curl and requests

Update examples for Arista gnmi client to use timestamping

delete https://github.com/aristanetworks/openmgmt/blob/main/docs/configuration/index.md

https://github.com/aristanetworks/openmgmt/blob/main/mkdocs.yml doesnt use
https://github.com/aristanetworks/openmgmt/blob/main/docs/configuration/index.md
so we can delete it

add pyang

examples and configurations should use documentation address (RFC5737) ranges

there's widespread use of 1918 address ranges within the documentation. these should be replaced with the IP address ranges allocated for documentation.

• update existing documentation to use documentation ranges
• probably useful to have a check for this as part of PR submissions
• style guide should include this guidance
  • non-documentation ranges within show command output is acceptable
  • configuration/command examples should use documentation ranges.

reference

IPv6 range:

• 2001:DB8::/32

IPv4 ranges:

• 192.0.2.0/24 (TEST-NET-1)
• 198.51.100.0/24 (TEST-NET-2)
• 203.0.113.0/24 (TEST-NET-3)

provide additional documentation re: terminattr flags and their use

Add gNOI examples

Add gNOI examples in go.

Add examples for SSH and SSH-Certs

See AuthorizedPrincipalsCommand

typo in port change cp acl config `sysem` -> `system`

The attached diff, addresses it.

tmp.diff.txt

Add ygot

Add parsing of ygot for a few examples related to adding system information, bgp hostname etc.

add more badges to the README file

add a badge or several badges for status of CI/lint/mkdocs GitHub Pages deployment/...

Shift mkdocs building and deploy to Github actions

Automate the build and deploy

doc update

update the list (some are missing: ygot, ansible ...)
https://github.com/aristanetworks/openmgmt/blob/main/docs/examples/index.md
https://aristanetworks.github.io/openmgmt/examples/

update the README file (moving contributions details in an external contribution guide)

Convert EOSC Prometheus article to md

add gnmi capability rpc examples (gnmic and gnmi arista)

we currently provided examples only for set, get and sub

add a table of contents in the README file

so we see the topics from the README file (+ clickable links)

update https://aristanetworks.github.io/openmgmt/examples/ansible/ with the playbook

here it is https://github.com/aristanetworks/openmgmt/blob/main/src/ansible/capabilities.yaml

add Scrapli Netconf examples

add examples for system/cpus path

system/cpus is available in EOS-4.27.2F+

add more pygnmi examples

• Capabilities RPC
• GET RPC
• SUB RPC
• SET RPC
  • Update
  • Delete

Use documentation address ranges for examples

update example code to use command line args where applicable

much of the example code in the repo uses hardcoded values. while useful in demonstrating the concepts, it does make it a bit more challenging to use these examples quickly or to build off them for tools, etc.

it would be useful to replace the hardcoded options with relevant command-line arguments and flags.

simplify the contribution guide described in the README file