Developer Guide

In the Developer Guide, you will find information on Neutron’s lower level programming APIs. There are sections that cover the core pieces of Neutron, including its database, message queue, and scheduler components. There are also subsections that describe specific plugins inside Neutron. Finally, the developer guide includes information about Neutron testing infrastructure.

Programming HowTos and Tutorials

• Effective Neutron: 100 specific ways to improve your Neutron contributions
  • Developing better software
    • Plugin development
    • Database interaction
    • System development
    • Eventlet concurrent model
    • Mocking and testing
    • Backward compatibility
    • Scalability issues
    • Translation and logging
    • Project interfaces
    • Documenting your code
  • Landing patches more rapidly
    • Scoping your patch appropriately
    • Nits and pedantic comments
    • Reviewer comments
    • Code Review
    • IRC
    • Commit messages
    • Dealing with Zuul
• Setting Up a Development Environment
  • Getting the code
• Testing Neutron
  • Why Should You Care
  • Definitions
  • Testing Frameworks
    • Unit Tests
    • Functional Tests
    • Fullstack Tests
    • API Tests
    • Scenario Tests
    • Rally Tests
  • Development Process
    • Structure of the Unit Test Tree
  • Running Tests
    • PEP8 and Unit Tests
    • Functional Tests
    • Fullstack Tests
    • API & Scenario Tests
    • Running Individual Tests
  • Coverage
  • Debugging
    • Post-mortem Debugging
    • References
• Contributing new extensions to Neutron
  • Introduction
  • Contribution Process
  • Design and Development
  • Testing and Continuous Integration
  • Defect Management
    • Security Issues
  • Backport Management Strategies
  • DevStack Integration Strategies
  • Project Initial Setup
  • Internationalization support
    • oslo.i18n
    • Setting up translation support
    • Enable Translation
  • Integrating with the Neutron system
    • Configuration Files
    • Database Models and Migrations
    • DB Model/Migration Testing
    • Entry Points
    • API Extensions
    • Service Providers
    • Interface Drivers
    • Rootwrap Filters
    • Extending python-neutronclient
    • Other repo-split items
• Neutron public API
  • Breakages
• Client command extension support
• Alembic Migrations
  • Introduction
  • The Migration Wrapper
  • Migration Branches
    • 1. Independent Sub-Project Tables
    • 2. Offline/Online Migrations
  • Developers
    • Running neutron-db-manage without devstack
    • Script Auto-generation
    • Expand and Contract Scripts
    • Expand and Contract Branch Exceptions
    • HEAD files for conflict management
    • Applying database migration rules
    • Tagging milestone revisions
    • Generation of comparable metadata with current database schema

Neutron Internals

• Services and agents
  • Entry points
  • Interacting with Eventlet
  • Connecting to the Database
  • Configuration Options
• Neutron WSGI/HTTP API layer
  • Startup
  • WSGI Application
  • Further reading
• ML2 Extension Manager
• Calling the ML2 Plugin
• Quota Management and Enforcement
  • High Level View
  • Quota Management
  • Resource Usage Info
  • Quota Enforcement
  • Setting up Resource Tracking for a Plugin
  • Notes for Implementors of RPC Interfaces and RESTful Controllers
  • Exceptions and Caveats
  • References
• API Extensions
  • Examples
    • Guided Tour: The Neutron Security Group API
  • Extensions for Resources with standard attributes
• Neutron Plugin Architecture
  • Plugin API
• Neutron Database Layer
  • Difference between ‘default’ and ‘server_default’ parameters for columns
  • Database migrations
  • Tests to verify that database migrations and models are in sync
  • The Standard Attribute Table
• Relocation of Database Models
  • Structure of Model Definitions
    • References
• Authorization Policy Enforcement
  • Authorization workflow
    • Request authorization
    • Response Filtering
  • The neutron.policy API
  • Neutron specific policy rules
    • OwnerCheck: Extended Checks for Resource Ownership
    • FieldCheck: Verify Resource Attributes
  • Guidance for API developers
  • Notes
  • References
• Neutron RPC API Layer
  • Client Side
  • Server Side
  • Versioning
    • Example Change
  • Neutron RPC APIs
    • Example: DHCP
  • More Info
• Neutron Messaging Callback System
  • Rolling upgrades strategy
    • Resource pull requests
    • Resource push notifications
  • Topic names for every resource type RPC endpoint
  • Subscribing to resources
  • Unsubscribing from resources
  • Sending resource events
  • References
• Layer 3 Networking in Neutron - via Layer 3 agent & OpenVSwitch
  • Neutron logical network setup
  • Neutron logical router setup
  • Neutron Routers are realized in OpenVSwitch
  • Finding the router in ip/ipconfig
  • Provider Networking
• L3 agent extensions
  • L3 agent extension API
  • Further Reading
• L2 Agent Networking
  • Open vSwitch L2 Agent
    • VLAN Tags
    • GRE Tunnels
    • VXLAN Tunnels
    • Geneve Tunnels
    • Bridge Management
    • Tackling the Network Trunking use case
    • Further Reading
  • L2 Networking with Linux Bridge
  • L2 Networking with SR-IOV enabled NICs
    • Further Reading
  • L2 agent extensions
    • Open vSwitch agent API
    • Linuxbridge agent API
• Agent extensions
  • Agent API object
• Neutron Open vSwitch vhost-user support
  • Platform requirements
  • Configuration
  • What about the networking-ovs-dpdk repo?
• Quality of Service
  • Service side design
    • QoS plugin implementation guide
    • Supported QoS rule types
    • Database models
    • QoS versioned objects
    • RPC communication
  • Agent side design
    • Agent backends
    • Linux bridge
  • QoS driver design
  • Configuration
  • Testing strategy
    • Neutron objects
    • Functional tests
    • API tests
• Service Extensions
  • Calling the Core Plugin from Services
• Neutron Callback System
  • Subscribing to events
  • Subscribing and aborting events
  • Unsubscribing to events
  • FAQ
• Keep DNS Nameserver Order Consistency In Neutron
  • Get Subnet Details Info
  • Update Subnet DNS Nameservers
• Integration with external DNS services
  • Changes to the neutron API
• Upgrade strategy
  • Rolling upgrade
    • Server upgrade
    • Agents upgrade
    • Networking backends
  • Upgrade testing
  • Review guidelines
• Neutron Stadium i18n
• Subnet Pools and Address Scopes
  • Subnet Pools
    • Subnet Pool Quotas
    • Allocation
  • Address Scopes
    • Routing
    • RPC
    • Model
    • L3 Agent
• Open vSwitch Firewall Driver
  • Firewall API calls
  • OpenFlow rules
  • Rules example with explanation:
  • Future work
    • Upgrade path from iptables hybrid driver
• Network IP Availability Extension
  • API Specification
    • Availability for all networks
    • Availability by network ID
    • Supported Query Filters
• Add Tags to Neutron Resources
  • Which Resources
  • Model
  • API
• Composite Object Status via Provisioning Blocks
  • High Level View
  • ML2, L2 agents, and DHCP agents
• Retrying Operations
  • Idempotency on Failures
  • Argument Mutation
  • Retrying to Handle Race Conditions
  • Nesting
  • Usage
• L3 agent extensions
  • L3 agent extension API

Testing

• Full Stack Testing
  • Goals
• Test Coverage
  • Coverage
  • Missing Infrastructure
• Template for ModelMigrationSync for external repos
  • What does the test do?
  • Steps for implementing the test
    • 1. Import all models in one place
    • 2. Implement the test module
    • 3. Add functional requirements
• Transient DB Failure Injection

Module Reference

Todo

Add in all the big modules as automodule indexes.

Indices and tables

• Index
• Module Index
• Search Page