FAUCET is an OpenFlow controller for multi table OpenFlow 1.3 switches, that implements layer 2 switching, VLANs, ACLs, and layer 3 IPv4 and IPv6 routing.
anarkiwi Merge pull request #2494 from anarkiwi/master
Disable 8021X success test until fix for conflict with ACL change det…
Latest commit 726a9c3 Sep 23, 2018
Permalink
Failed to load latest commit information.
adapters Merge pull request #2104 from cglewis/master Jun 21, 2018
clib OTT check that new config has been written. Sep 23, 2018
debian revert - revert dot1x tests with chewie v0.0.5 (radius & statehandlers) Sep 3, 2018
docker Recursively include requirements.txt in test-requirements.txt. Aug 27, 2018
docs Update sphinx from 1.7.9 to 1.8.0 Sep 16, 2018
etc Remove proactive_learn which is now the default. Aug 20, 2018
faucet pylint. Sep 23, 2018
git-hook Fix unit test wrapper to run from base dir for PBR. Jul 29, 2018
hooks Add hook for docker cloud to allow cross compiling. May 28, 2018
raspbian-image Faucet raspbian image with gitlab CI Jul 24, 2018
tests Disable 8021X success test until fix for conflict with ACL change det… Sep 23, 2018
travis Set locale to keep python read() happy. Aug 23, 2018
vm Switch VM build from python packages to debian packages. May 28, 2018
.dockerignore Add documentation builds to test suite. Feb 26, 2018
.gitignore pytype workarounds. Jun 11, 2018
.gitlab-ci.yml Yakkety and zesty are EOL. Aug 27, 2018
.pyup.yml Provide initial configuration for pyup. Feb 8, 2018
.travis.yml Attempt more shards to reduce worst case straggler runtime. Sep 23, 2018
AUTHORS Add Bob Lantz. Jul 16, 2018
CONTRIBUTING.rst Convert our documentation to Sphinx. Dec 2, 2017
Dockerfile.faucet Attempt to tame our Dockerfile problem. May 28, 2018
Dockerfile.faucet.pi Attempt to tame our Dockerfile problem. May 28, 2018
Dockerfile.fuzz-config Fuzzers don't need python2. Jul 16, 2018
Dockerfile.fuzz-packet Fuzzers don't need python2. Jul 16, 2018
Dockerfile.gauge Attempt to tame our Dockerfile problem. May 28, 2018
Dockerfile.gauge.pi Attempt to tame our Dockerfile problem. May 28, 2018
Dockerfile.tests Docker tests can use external cache (e.g from Travis). Jun 8, 2018
LICENSE It's been 2018 for a while, reflect this in copyright notices. Jun 17, 2018
Makefile Update Makefile to reflect new codebase. Sep 19, 2018
README.rst Bump version for release. Sep 17, 2018
docker-compose-pi.yaml Use newer grafana and prometheus versions. Sep 17, 2018
docker-compose.yaml Use newer grafana and prometheus versions. Sep 17, 2018
fuzz-requirements.txt Add py-AFL-fuzz config testing. Dec 4, 2017
hw_switch_config.yaml mv hw_switch_config.yaml to higher level to make it available to mult… Apr 19, 2018
requirements.txt Revert "unit test with chewie" Sep 17, 2018
run-travis-test.sh Dump logs for failed tests. Sep 17, 2018
setup.cfg Preversion 1.8.22. Sep 18, 2018
setup.py Adding debian packaging support to faucet Mar 14, 2018
test-requirements.txt Update pytype from 2018.8.10 to 2018.9.7.1 Sep 9, 2018

README.rst

Faucet

Version: 1.8.21
https://travis-ci.com/faucetsdn/faucet.svg?branch=master

FAUCET is an OpenFlow controller for multi table OpenFlow 1.3 switches, that implements layer 2 switching, VLANs, ACLs, and layer 3 IPv4 and IPv6 routing, static and via BGP. It is based on Waikato University's Valve and the Ryu OpenFlow Controller. FAUCET's design and background is described in ACM Queue.

It supports:

  • OpenFlow v1.3 (multi table) switches (including optional table features), hardware and software
  • Multiple datapaths and distributed switching under a single controller
  • VLANs, mixed tagged/untagged ports
  • ACLs matching layer 2 and layer 3 fields
  • IPv4 and IPv6 routing, static and via BGP
  • Policy based forwarding to offload to external NFV applications (Eg 802.1x via hostapd, DHCP to isc DHCPD)
  • Port and flow statistics via InfluxDB/Grafana
  • Controller health and statistics via Prometheus
  • Unit and systems tests run under Travis based on mininet and OVS

Hardware and software switch support

Detailed guides for some switches are available on readthedocs.

FAUCET has been tested against the following switches (see also SUPPORTED_HARDWARE in faucet/valve.py):

Faucet's design principle is to be as hardware agnostic as possible and not require Table Type Patterns. This means that Faucet expects the hardware Open Flow Agent (OFA) to hide implementation details, including which tables are best for certain matches or whether there is special support for multicast - Faucet expects the OFA to leverage the right hardware transparently.

If you are a hardware vendor wanting to support FAUCET, you need to support all the matches in faucet/faucet_pipeline.py and pass all tests.

Installation

Please see the installation guide.

Configuration

Please see the configuration guide for documentation regarding the general configuration of faucet and the recipe book for configuration snippets for common use cases.

Development and testing

Please see the developer guide.

Support

We run a number of mailing lists for communication between users and developers of Faucet, as well as a low traffic mailing list for announcements of new versions:

Faucet blog by Josh Bailey available at http://faucet-sdn.blogspot.co.nz.

To create a issue, use GitHub Issues.

Faucet deployment around the world

Faucet deployment map