Welcome to Neutron’s developer 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 Neutron API.

This document describes Neutron for contributors of the project, and assumes that you are already familiar with Neutron from an end-user perspective.

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!

Neutron Policies

• Neutron Policies
  • Blueprints and Specs
  • Neutron Bugs
  • Contributor Onboarding
  • Neutron Core Reviewers
  • Neutron Teams
  • Code Merge Responsibilities
  • Neutron Gate Failure Triage
  • Neutron Code Reviews
  • Pre-release check list
  • Neutron Third-party CI

Neutron Stadium

• Neutron Stadium
  • Stadium Governance
  • Sub-Project Guidelines

Developer Docs

• Developer Guide
  • Programming HowTos and Tutorials
    • Effective Neutron: 100 specific ways to improve your Neutron contributions
    • Setting Up a Development Environment
    • Testing Neutron
    • Contributing new extensions to Neutron
    • Neutron public API
    • Client command extension support
    • Alembic Migrations
  • Neutron Internals
    • Services and agents
    • Neutron WSGI/HTTP API layer
    • ML2 Extension Manager
    • Calling the ML2 Plugin
    • Quota Management and Enforcement
    • API Extensions
    • Neutron Plugin Architecture
    • Neutron Database Layer
    • Relocation of Database Models
    • Authorization Policy Enforcement
    • Neutron RPC API Layer
    • Neutron Messaging Callback System
    • Layer 3 Networking in Neutron - via Layer 3 agent & OpenVSwitch
    • L3 agent extensions
    • L2 Agent Networking
    • Agent extensions
    • Neutron Open vSwitch vhost-user support
    • Quality of Service
    • Service Extensions
    • Neutron Callback System
    • Keep DNS Nameserver Order Consistency In Neutron
    • Integration with external DNS services
    • Upgrade strategy
    • Neutron Stadium i18n
    • Subnet Pools and Address Scopes
    • Open vSwitch Firewall Driver
    • Network IP Availability Extension
    • Add Tags to Neutron Resources
    • Composite Object Status via Provisioning Blocks
    • Retrying Operations
    • L3 agent extensions
  • Testing
    • Full Stack Testing
    • Test Coverage
    • Template for ModelMigrationSync for external repos
    • Transient DB Failure Injection
  • Module Reference
  • Indices and tables

Dashboards

There is a collection of dashboards to help developers and reviewers located here.

• Gerrit Dashboards

API Extensions

Go to http://api.openstack.org for information about OpenStack Network API extensions.