Faucet Documentation

User Documentation

• Introduction to Faucet
  • What is Faucet?
  • What is Gauge?
  • Why Faucet?
  • Getting Help
• Installation
  • Common Installation Tasks
  • Encrypted Control Channel
  • Installation with Docker on Ubuntu with systemd
  • Installation with pip
• Docker
  • Faucet Dockerfile
  • Initial configuration
  • Official builds
  • Dockerfile
  • Dockerfile.gauge
  • docker-compose.yaml
• Configuration
  • Verifying configuration
  • Configuration examples
  • Applying configuration updates
  • Configuration in separate files
  • Configuration options
• 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 NoviFlow
  • Faucet on OVS with DPDK
• External Resources
  • Online Tutorials
  • Tutorial Videos

Developer Documentation

• Developer guide
  • Before submitting a PR
  • Code style
  • Makefile
  • Key architectural concepts/assumptions:
• Architecture
  • Faucet Design and Architecture
  • Faucet Openflow Switch Pipeline
  • Faucet Architecture
• Testing
  • Software switch testing with docker
  • Hardware switch testing with docker
• Fuzzing
  • Fuzzing faucet with docker
• Source Code
  • faucet

Quick References

• Frequently Asked Questions

Indices and tables

• Index
• Module Index
• Search Page