Welcome to Neutron’s documentation!¶
Neutron is an OpenStack project to provide “network connectivity as a service” between interface devices (e.g., vNICs) managed by other OpenStack services (e.g., nova). It implements the OpenStack Networking API.
This documentation is generated by the Sphinx toolkit and lives in the source tree. Additional documentation on Neutron and other components of OpenStack can be found on the OpenStack wiki and the Neutron section of the wiki. The Neutron Development wiki is also a good resource for new contributors.
Enjoy!
Installation Guide¶
Networking Guide¶
- OpenStack Networking Guide
- Introduction
- Configuration
- Active-active L3 Gateway with Multihoming
- Address Scopes
- Automatic allocation of network topologies
- Availability Zones
- BGP Dynamic Routing
- BGP Floating IPs over L2 Segmented Networks
- Agents and Services
- DNS Integration
- DNS Integration with an External Service
- DNS Resolution for Instances
- Distributed Virtual Routing with VRRP
- Experimental Features Framework
- Floating IP Port Forwarding
- IPAM Configuration
- IPv6
- Macvtap Mechanism Driver
- Metadata Service Caching
- Metadata Service Query Rate-limiting
- ML2 Plug-in
- MTU Considerations
- NDP Proxy
- Network Segment Ranges
- Open vSwitch with DPDK Datapath
- Open vSwitch Hardware Offloading
- Open vSwitch Native Firewall Driver
- Packet Logging Framework
- Quality of Service (QoS)
- Quality of Service (QoS): Guaranteed Minimum Bandwidth
- Quality of Service (QoS): Guaranteed Minimum Packet Rate
- Role-Based Access Control (RBAC)
- Routed provider networks
- Router flavors with the L3 OVN service plugin
- SR-IOV
- Service Function Chaining
- Service Subnets
- Subnet Onboarding
- Subnet Pools
- Trunking
- WSGI Usage with the Neutron API
- Deployment examples
- Operations
- Migration
- Miscellaneous
- OVN Driver Administration Guide
- OVN information
- Features
- Routing
- IP Multicast: IGMP snooping configuration guide for OVN
- OpenStack and OVN Tutorial
- Reference architecture
- DPDK Support in OVN
- Troubleshooting
- SR-IOV guide for OVN
- Availability Zones guide for OVN
- Routed Provider Networks for OVN
- Off-path SmartNIC DPUs with OVN
- Baremetal provisioning guide for OVN
- OVN External Ports
- RPC messages in OVN
- OVN L3 scheduler
Configuration Reference¶
CLI Reference¶
OVN Driver¶
Neutron Feature Classification¶
Contributor Guide¶
Eventlet deprecation¶
API Reference¶
Go to https://docs.openstack.org/api-ref/network/ for information about the OpenStack Network API and its extensions.
Search¶
Neutron document search: Search the contents of this document.
OpenStack wide search: Search the wider set of OpenStack documentation, including forums.