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

• Installation Guide
  • Overview
  • Networking service overview
  • Networking (neutron) concepts
  • Install and configure for openSUSE and SUSE Linux Enterprise
  • Install and configure for Red Hat Enterprise Linux and CentOS
  • Install and configure for Ubuntu

Networking Guide

• OpenStack Networking Guide
  • Introduction
  • Configuration
  • Deployment examples
  • Operations
  • Migration
  • Miscellaneous
  • Archived Contents

Configuration Reference

• Configuration Guide
  • Configuration Reference
  • Policy Reference

CLI Reference

• Command-Line Interface Reference
  • neutron-debug
  • neutron-sanity-check
  • neutron-status

Neutron Feature Classification

• Neutron Feature Classification
  • Introduction
  • General Feature Support
  • Provider Network Support

Contributor Guide

• Contributor Guide
  • Neutron Policies
  • Neutron Stadium
  • Developer Guide
  • Neutron Internals
  • Dashboards

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.