Faucet Documentation

User Documentation

• Introduction to Faucet
  • What is Faucet?
  • What is Gauge?
  • Why Faucet?
  • Release Notes
  • Getting Help
• Tutorials
  • Installing faucet for the first time
  • ACL tutorial
  • VLAN Tutorial
  • Routing Tutorial
  • NFV Services Tutorial
• Installation
  • Common Installation Tasks
  • Installation using APT
  • Installation with Docker
  • Installation with pip
  • Installing on Raspberry Pi
  • Virtual Machine Image
• Docker
  • Installing docker
  • Initial configuration
  • Official builds
  • Additional Arguments
  • Docker compose
• Configuration
  • Verifying configuration
  • Configuration examples
  • Applying configuration updates
  • Configuration in separate files
  • Configuration options
  • Environment variables
• Configuration Recipe Book
  • Forwarding
  • Routing
  • Policy
• Vendor-specific Documentation
  • Faucet on Allied Telesis products
  • Faucet on HPE-Aruba Switches
  • Faucet on Lagopus
  • Faucet on ZodiacFX
  • Faucet on ZodiacGX
  • Faucet on NoviFlow
  • Faucet on Cisco Switches (Beta)
  • Faucet on OVS with DPDK
  • Faucet Testing with OVS on Hardware
• External Resources
  • Online Tutorials
  • Tutorial Videos

Developer Documentation

• Developer Guide
  • Before submitting a PR
  • PR handling guidelines
  • Code style
  • Faucet Development Environment
  • Makefile
  • Key architectural concepts/assumptions:
• Architecture
  • Faucet Design and Architecture
  • Faucet Openflow Switch Pipeline
  • Faucet Architecture
• Testing
  • Installing docker
  • Software switch testing with docker
  • Hardware switch testing with docker
  • Test suite options
• Fuzzing
  • Fuzzing faucet config with docker
  • Fuzzing faucet packet handling with docker
• Source Code
  • faucet

Quick References

• Frequently Asked Questions

Indices and tables

• Index
• Module Index
• Search Page