├── .gitattributes ├── code-of-conduct.md ├── contributing.json ├── contributing.md └── readme.md /.gitattributes: -------------------------------------------------------------------------------- 1 | * text=auto 2 | readme.md merge=union 3 | -------------------------------------------------------------------------------- /code-of-conduct.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | In the interest of fostering an open and welcoming environment, we as 6 | contributors and maintainers pledge to making participation in our project and 7 | our community a harassment-free experience for everyone, regardless of age, body 8 | size, disability, ethnicity, gender identity and expression, level of experience, 9 | nationality, personal appearance, race, religion, or sexual identity and 10 | orientation. 11 | 12 | ## Our Standards 13 | 14 | Examples of behavior that contributes to creating a positive environment 15 | include: 16 | 17 | * Using welcoming and inclusive language 18 | * Being respectful of differing viewpoints and experiences 19 | * Gracefully accepting constructive criticism 20 | * Focusing on what is best for the community 21 | * Showing empathy towards other community members 22 | 23 | Examples of unacceptable behavior by participants include: 24 | 25 | * The use of sexualized language or imagery and unwelcome sexual attention or 26 | advances 27 | * Trolling, insulting/derogatory comments, and personal or political attacks 28 | * Public or private harassment 29 | * Publishing others' private information, such as a physical or electronic 30 | address, without explicit permission 31 | * Other conduct which could reasonably be considered inappropriate in a 32 | professional setting 33 | 34 | ## Our Responsibilities 35 | 36 | Project maintainers are responsible for clarifying the standards of acceptable 37 | behavior and are expected to take appropriate and fair corrective action in 38 | response to any instances of unacceptable behavior. 39 | 40 | Project maintainers have the right and responsibility to remove, edit, or 41 | reject comments, commits, code, wiki edits, issues, and other contributions 42 | that are not aligned to this Code of Conduct, or to ban temporarily or 43 | permanently any contributor for other behaviors that they deem inappropriate, 44 | threatening, offensive, or harmful. 45 | 46 | ## Scope 47 | 48 | This Code of Conduct applies both within project spaces and in public spaces 49 | when an individual is representing the project or its community. Examples of 50 | representing a project or community include using an official project e-mail 51 | address, posting via an official social media account, or acting as an appointed 52 | representative at an online or offline event. Representation of a project may be 53 | further defined and clarified by project maintainers. 54 | 55 | ## Enforcement 56 | 57 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 58 | reported by contacting the project team at brandonhim@live.com. All 59 | complaints will be reviewed and investigated and will result in a response that 60 | is deemed necessary and appropriate to the circumstances. The project team is 61 | obligated to maintain confidentiality with regard to the reporter of an incident. 62 | Further details of specific enforcement policies may be posted separately. 63 | 64 | Project maintainers who do not follow or enforce the Code of Conduct in good 65 | faith may face temporary or permanent repercussions as determined by other 66 | members of the project's leadership. 67 | 68 | ## Attribution 69 | 70 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, 71 | available at [http://contributor-covenant.org/version/1/4][version] 72 | 73 | [homepage]: http://contributor-covenant.org 74 | [version]: http://contributor-covenant.org/version/1/4/ 75 | -------------------------------------------------------------------------------- /contributing.json: -------------------------------------------------------------------------------- 1 | // https://gitmagic.io/rules 2 | { 3 | "commit": { 4 | "subject_cannot_be_empty": true, 5 | "subject_must_be_longer_than": 4 6 | }, 7 | "pull_request": { 8 | "subject_cannot_be_empty": true, 9 | "subject_must_be_longer_than": 4, 10 | "body_cannot_be_empty": true, 11 | }, 12 | "issue": { 13 | "subject_cannot_be_empty": true, 14 | "subject_must_be_longer_than": 4, 15 | } 16 | } 17 | -------------------------------------------------------------------------------- /contributing.md: -------------------------------------------------------------------------------- 1 | # Contribution Guidelines 2 | 3 | Please note that this project is released with a 4 | [Contributor Code of Conduct](code-of-conduct.md). By participating in this 5 | project you agree to abide by its terms. 6 | 7 | --- 8 | 9 | Ensure your pull request adheres to the following guidelines: 10 | 11 | - Make sure you take care of this 12 | - And this as well 13 | - And don't forget to check this 14 | 15 | Thank you for your suggestions! 16 | 17 | 18 | ## Updating your PR 19 | 20 | A lot of times, making a PR adhere to the standards above can be difficult. 21 | If the maintainers notice anything that we'd like changed, we'll ask you to 22 | edit your PR before we merge it. There's no need to open a new PR, just edit 23 | the existing one. If you're not sure how to do that, 24 | [here is a guide](https://github.com/RichardLitt/docs/blob/master/amending-a-commit-guide.md) 25 | on the different ways you can update your PR so that we can merge it. 26 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | # Awesome Network Programmability [![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/sindresorhus/awesome) 2 | 3 | > A curated list of resources and packages for networking programmability and automation 4 | 5 | 6 | ## Table of Contents 7 | 8 | - [Utilities](#utilities) 9 | - [Automation](#automation) 10 | - [Monitoring](#monitoring) 11 | - [Dashboard](#dashboard) 12 | - [Utility](#utility) 13 | - [Traffic Condition Simulation](#traffic-condition-simulation) 14 | - [Traffic Simulation](#traffic-simulation) 15 | - [Solution](#solution) 16 | - [Utility](#utility) 17 | - [Libraries](#libraries) 18 | - [General Programmability](#general-programmability) 19 | - [Python](#python) 20 | - [Examples](#examples) 21 | - [Resources](#resources) 22 | - [Books](#books) 23 | 24 | ## Utilities 25 | 26 | ### Automation 27 | - [Ansible](https://docs.ansible.com) 28 | An agentless automation tooling that can perform a variety of automation functions against a wide variety of devices and operating systems. 29 | 30 | - [Puppet](https://docs.puppet.com) 31 | An agent-based automation tooling that can perform a variety of automation functions against a wide variety of devices and operating systems. 32 | 33 | - [Chef](https://docs.chef.io/chef_overview.html) 34 | Agent-based automation tooling that focuses on the concept of "Infrastructure as Code." 35 | 36 | - [Salt](https://docs.saltstack.com/en/latest/) 37 | Agent-based automation tooling. Support for networking devices appears to be on the backseat, but has modules that provide some functionality like [via NSO](https://docs.saltstack.com/en/latest/ref/proxy/all/salt.proxy.cisconso.html). 38 | 39 | ### Monitoring 40 | 41 | - [Stanford Network Monitoring Tools](https://www.slac.stanford.edu/xorg/nmtf/nmtf-tools.html) 42 | An unbelievably comprehensive list of network monitoring tools. If you want to look at everything, look here. 43 | 44 | #### Dashboard 45 | - [Observium](http://www.observium.org) 46 | "Observium is a low-maintenance auto-discovering network monitoring platform supporting a wide range of device types, platforms and operating systems ..." 47 | 48 | #### Utility 49 | - [Joy](https://github.com/cisco/joy) 50 | "A package for capturing and analyzing network flow data and intraflow data, for network research, forensics, and security monitoring." 51 | 52 | - [pmacct](http://www.pmacct.net) 53 | "A small set of multi-purpose passive network monitoring tools. It can account, classify, aggregate, replicate and export forwarding-plane data, ie. IPv4 and IPv6 traffic; collect and correlate control-plane data via BGP and BMP; collect infrastructure data via streaming network telemetry." 54 | 55 | - [ToDD](https://github.com/toddproject/todd) 56 | "ToDD is an extensible framework for providing natively distributed testing on demand." 57 | 58 | - [pipeline](https://github.com/cisco/bigmuddy-network-telemetry-pipeline) 59 | "... an all-batteries-included utility which consumes IOS-XR telemetry streams directly from the router or indirectly from a publish/subscribe bus." 60 | Supports IOS-XR specifically. 61 | 62 | ### Network Condition Simulation 63 | 64 | - [ATC](http://facebook.github.io/augmented-traffic-control/) (Augmented Traffic Control) 65 | "A tool to simulate network conditions." "Developers can use ATC to test their application across varying network conditions, easily emulating high speed, mobile, and even severely impaired networks." 66 | Developed by Facebook. 67 | Supports Linux. 68 | 69 | - [Comcast](https://github.com/tylertreat/Comcast) 70 | "Simulating [varying] network connections so you can build better systems." 71 | Supports Linux and MacOS[X]. 72 | 73 | - [netem](https://wiki.linuxfoundation.org/networking/netem) 74 | "netem provides Network Emulation functionality for testing protocols by emulating the properties of wide area networks. The current version emulates variable delay, loss, duplication and re-ordering." 75 | Supports Linux. 76 | 77 | - [dummynet](http://info.iet.unipi.it/~luigi/dummynet/) 78 | "traffic shaper, bandwidth manager and delay emulator" 79 | Supports \*BSD and MacOS[X]. 80 | Note for MacOS, ```ipfw``` was deprecated in OSX 10.10 and replaced with ```pfctl```. Documentation is few and far between. ```dnctl``` is utilized to control dummynet on MacOS. YMMV. 81 | 82 | - [tc](http://tldp.org/HOWTO/Traffic-Control-HOWTO/intro.html) (Linux Traffic Control) 83 | A comprehensive overview of traffic control capabilities on Linux systems. 84 | 85 | ### Traffic Simulation 86 | 87 | #### Solution 88 | 89 | - [Ostinato](http://ostinato.org/) 90 | "Ostinato is a packet crafter, network traffic generator and analyzer with a friendly GUI." 91 | 92 | - [IxChariot](https://www.ixiacom.com/products/ixchariot) 93 | "Instant performance assessment of complex networks in pre and post deployment." 94 | 95 | #### Utility 96 | 97 | - [scapy](http://secdev.org/projects/scapy/) 98 | "... a powerful interactive packet manipulation program. It is able to forge or decode packets of a wide number of protocols, send them on the wire, capture them, match requests and replies, and much more." 99 | 100 | ## Libraries 101 | 102 | ### General Programmability 103 | 104 | - [YDK](https://developer.cisco.com/site/ydk/) 105 | Model-driven APIs for simplified programmability of your network device. Generates APIs based off of YANG models that can be used programmatically. 106 | 107 | ### Python 108 | 109 | - [Napalm](https://github.com/napalm-automation/napalm) 110 | Network Automation and Programmability Abstraction Layer with Multivendor support 111 | 112 | - [Paramiko](http://www.paramiko.org/) 113 | Implementation of SSHv2 protocol, providing both client and server functionality. 114 | 115 | - [Netmiko](https://github.com/ktbyers/netmiko) 116 | Multi-vendor library to simplify Paramiko SSH connections to network devices. 117 | 118 | - [Trigger](https://github.com/trigger/trigger) 119 | "... a robust network automation toolkit written in Python that was designed for interfacing with network devices." 120 | 121 | - [CiscoConfigParse](http://www.pennington.net/py/ciscoconfparse/) 122 | This library examines an IOS-style config and breaks it into a set of linked parent / child relationships for auditing, modifying, and/or building new configurations. 123 | 124 | - [Jinja2](http://jinja.pocoo.org/docs/2.9/) 125 | Templating language for Python and excellent library to use for generating network device configuration from templates. 126 | 127 | - [beka](https://github.com/samrussell/beka) 128 | A Python BGP Speaker. 129 | 130 | ### Examples 131 | - [Cisco gRPC Connection Libraries](https://github.com/cisco-grpc-connection-libs) 132 | Example repositories on how to use gRPC in Python, NodeJS, etc. for the IOS-XR end node. 133 | 134 | - [Solenoid](https://github.com/ios-xr/Solenoid) 135 | App that injects routes directly into Cisco's IOS-XR RIB table 136 | 137 | ## Resources 138 | 139 | ### Books 140 | - [Programmability and Automation with Cisco Open NX-OS](http://www.cisco.com/c/dam/en/us/td/docs/switches/datacenter/nexus9000/sw/open_nxos/programmability/guide/Programmability_Open_NX-OS.pdf) 141 | Understand how to utilize network programmability for NXOS *(Programmability Fundamentals, Model Driven Programming, Configuration Automation)* 142 | 143 | - [Beej's Guide to Network Programming](http://beej.us/guide/bgnet/) 144 | Arguably one of the simplest and best guides to using network sockets in C. Since it's in C you get to understand a lot of concepts that might otherwise be glossed over in higher level languages. Also has basic, boilerplate examples. 145 | 146 | - [Network Programmability and Automation](http://shop.oreilly.com/product/0636920042082.do) 147 | Good foundation for Network Engineers looking to be more comfortable with the standard tools of network automation. The book is in early release on Safari Online, and should be released later in 2017. 148 | 149 | ## Contribute 150 | 151 | Contributions welcome! Read the [contribution guidelines](contributing.md) first. 152 | 153 | 154 | ## License 155 | 156 | [![CC0](http://mirrors.creativecommons.org/presskit/buttons/88x31/svg/cc-zero.svg)](http://creativecommons.org/publicdomain/zero/1.0) 157 | 158 | To the extent possible under law, Cisco's Innovation Edge Team has waived all copyright and 159 | related or neighboring rights to this work. 160 | --------------------------------------------------------------------------------