NetworkingGuide/TOC

This guide targets OpenStack administrators seeking to deploy and manage neutron.

Instructions for Contributors

 * 1) Pick an existing topic or create a new topic. For new topics, we're primarily interested in deployment scenarios.
 * 2) Develop content (text and/or diagrams) in a format that supports at least basic markup (e.g., titles, paragraphs, lists, etc.).
 * 3) Provide a link to the content (e.g., gist on github.com, wiki page, blog post, etc.) under the associated topic.
 * 4) Send e-mail to reviewers at networking@openstacknow.com.  Make sure to include the email address under which you joined the Foundation if you want to be added as a co-author.
 * 5) A writer turns the content into an actual patch, with tracking bug, and docs reviewers (and the original author, we would hope) make sure it gets reviewed and merged.

To build the RST version of the guide -- that is, the guide based on this TOC -- download the openstack-manuals repo using the instructions at https://wiki.openstack.org/wiki/Documentation/HowTo#Edit_OpenStack_RST_and.2For_DocBook_documentation then type:

tox -e network

You will find the HTML output in the build directory.

Proposed topics for the Networking Guide
Blueprint: https://blueprints.launchpad.net/openstack-manuals/+spec/create-networking-guide

Document change history

 * Edgar Magana (3/5/15) Tagging as (***) chapters and sub-chapters that already exist in the networking guide

Introduction to networking

 * 1) Basic networking (Completed)
 * 2) Network components (Needs some work, very basic information)
 * 3) Switches
 * 4) Routers
 * 5) Firewalls
 * 6) Load balancers
 * 7) Tunnel (segmentation) technologies (Needs some work, very basic information)
 * 8) GRE
 * 9) VXLAN
 * 10) Network namespaces (Completed)
 * 11) Network address translation (Completed)

Introduction to OpenStack Networking (neutron)

 * 1) Overview/concepts
 * 2) Virtual network component comparisons (how neutron models above components) (terms in http://docs.openstack.org/admin-guide-cloud/content/api_abstractions.html)
 * 3) Networks (switches?)
 * 4) Flat
 * 5) VLAN
 * 6) GRE
 * 7) VXLAN
 * 8) Subnets (supports multiple per network?)
 * 9) Ports (switch ports?)
 * 10) Routers (routers)
 * 11) Security groups (firewalls)
 * 12) Extensions
 * 13) Service/component hierarchy
 * 14) Server
 * 15) Overview/concepts (provides API, manages database, etc.)
 * 16) Plug-ins
 * 17) Overview/concepts (manages agents)
 * 18) Agents
 * 19) Overview/concepts (provide layer 2/3 connectivity to instances, handle physical-virtual network transition, handle metadata, etc.)
 * 20) Layer 2 (Ethernet/Switching)
 * 21) Linux Bridge
 * 22) Overview/concepts
 * 23) OVS
 * 24) Overview/concepts
 * 25) Layer 3 (IP/Routing)
 * 26) L3
 * 27) Overview/concepts
 * 28) DHCP
 * 29) Overview/concepts
 * 30) Miscellaneous
 * 31) Metadata
 * 32) Overview/concepts
 * 33) Services
 * 34) Routing Services
 * 35) VPNaaS
 * 36) LBaaS
 * 37) FWaaS

Configuration
(Check source for current content.)
 * 1) Server
 * 2) Architecture
 * 3) Configuration file organization, relationships, etc.
 * 4) Reference common configuration items
 * 5) ML2 plug-in
 * 6) Overview
 * 7) Architecture
 * 8) Configuration file organization, relationships, etc.
 * 9) Network type drivers
 * 10) Flat
 * 11) VLAN
 * 12) GRE
 * 13) VXLAN
 * 14) Tenant network types (similar info in http://docs.openstack.org/admin-guide-cloud/content/tenant-provider-networks.html)
 * 15) Local
 * 16) VLAN
 * 17) ID ranges
 * 18) GRE
 * 19) Tunnel ID ranges
 * 20) VXLAN
 * 21) ID ranges
 * 22) Multicast discovery (L2 population)
 * 23) Mechanisms
 * 24) Linux Bridge
 * 25) Option stanza/section
 * 26) OVS
 * 27) Option stanza/section
 * 28) L2 Population
 * 29) Specialized
 * 30) Open Source (explains that mechanisms such as OpenDaylight, OpenContrail exist; does not cover how to do this)
 * 31) Proprietary (vendor) (Just specifying that these exist; does not cover how to do this)
 * 32) Security
 * 33) Options
 * 34) Agents
 * 35) L3
 * 36) Configuration file
 * 37) DHCP
 * 38) Configuration file
 * 39) Metadata
 * 40) Configuration file

Deployment Scenarios

 * 1) Scenario 1a - Legacy with OVS Converted/Merged
 * 2) Controller node, network node, and 1+ compute nodes (with DVR at least two compute node are required).
 * 3) Provider networks
 * 4) Flat
 * 5) VLAN
 * 6) Tenant networks
 * 7) VLAN
 * 8) GRE
 * 9) VXLAN
 * 10) Scenario 1b - Legacy with Linux Bridge Converted/Merged
 * 11) Controller node, network node, and 1+ compute nodes (with DVR at least two compute node are required).
 * 12) Provider networks
 * 13) Flat
 * 14) VLAN
 * 15) Tenant networks
 * 16) VLAN
 * 17) GRE
 * 18) VXLAN
 * 19) Scenario 2 - High availability (DVR and Open vSwitch) In Progress: Being converted to RST by Matt K
 * 20) Controller node, network node, and 2+ compute nodes
 * 21) Provider networks
 * 22) Flat
 * 23) VLAN
 * 24) Tenant networks
 * 25) GRE
 * 26) VXLAN
 * 27) Scenario 3a - High availability (L3 HA and OVS) Converted/Merged
 * 28) Controller node, two network nodes, and 1+ compute nodes
 * 29) Provider networks
 * 30) Flat
 * 31) VLAN
 * 32) Tenant networks
 * 33) VLAN
 * 34) GRE
 * 35) VXLAN
 * 36) Scenario 3b - High availability (L3 HA and Linux Bridge) Work in Progress
 * 37) Controller node, two network nodes, and 1+ compute nodes
 * 38) Provider networks
 * 39) Flat
 * 40) VLAN
 * 41) Tenant networks
 * 42) VLAN
 * 43) GRE
 * 44) VXLAN
 * 45) Scenario 4a - Provider networks with OVS Converted/Merged
 * 46) Controller node and 1+ compute nodes
 * 47) Provider networks
 * 48) Flat
 * 49) VLAN
 * 50) Scenario 4b - Provider networks with Linux Bridge Needs Review
 * 51) Controller node and 1+ compute nodes
 * 52) Provider networks
 * 53) Flat
 * 54) VLAN

Migrations

 * 1) Nova-network to Neutron
 * 2) Legacy to DVR (https://docs.google.com/document/d/1qmKoP4GVdjeEEVvqf3tYptVuvUzVIeQmJiTPWPoi_E0/edit -- see migration section at the end)
 * 3) Legacy to L3 HA (Needs work)

Miscellaneous
(Simple note, needs to be added.)
 * 1) Disabling libvirt networking
 * 2) Adding high availability for DHCP  (Needs work)
 * 3) DHCP agents (http://docs.openstack.org/admin-guide-cloud/content/app_demo_multi_dhcp_agents.html)

Advanced configuration

 * 1) Operational
 * 2) Logging (http://docs.openstack.org/admin-guide-cloud/content/section_adv_logging.html)
 * 3) LBaaS (http://docs.openstack.org/admin-guide-cloud/content/section_lbaas-overview.html and http://docs.openstack.org/admin-guide-cloud/content/lbaas_workflow.html and  http://docs.openstack.org/admin-guide-cloud/content/install_neutron-lbaas-agent.html)
 * 4) FWaaS (http://docs.openstack.org/admin-guide-cloud/content/install_neutron-fwaas-agent.html and http://docs.openstack.org/admin-guide-cloud/content/fwaas.html)
 * 5) VPNaaS
 * 6) Service Chaining (regXboi)
 * 7) Group policy (regXboi)
 * 8) How it differs from legacy neutron data model
 * 9) Debugging
 * 10) Neutron-debug command
 * 11) IPv6
 * 12) SLAAC vs. Stateful vs. Stateless
 * 13) Prefix Delegation

Potential Resources and Reusable Content

 * Grizzly Networking Administration Guide
 * Networking section of Install Guide for Red Hat, SUSE, Debian, Ubuntu
 * Networking section of Cloud Admin Guide
 * Networking section of Operators Guide
 * Networking section of Security Guide
 * Networking section of Config Reference
 * Network API Reference
 * Advanced Networking Config section of Cloud Admin Guide
 * Advanced Features section of Cloud Admin Guide
 * Advanced Operational Features section of Cloud Admin Guide

Cloud Administrator Guide

 * Networking API (includes table with mapping from some net concepts and mapping to Neutron)
 * Configuring SSL support (mostly config ref)
 * LBaaS overview (mostly config ref)
 * FWaaS overview (task-oriented, nice diagram)
 * Plug-in architecture (links, some ref on which plug-ins work with which hypervisors)
 * Plug-in configurations (subsections task-oriented on different plug-ins)
 * Configure data-forwarding nodes (subsections task-oriented on different plug-ins)
 * Configure DHCP agent (subsections task-oriented on different plug-ins)
 * Configure L3 agent (task-oriented)
 * Configure metering agent (task-oriented)
 * Configure LBaaS (task-oriented, OVS or Linux Bridge)
 * Networking architecture overview (overview of some neutron services)
 * Network connectivity for physical hosts (diagram of basic three-node arch)
 * Tenant and provider networks (info on types of networks, diagram)
 * VMware NSX integration
 * Configure Identity service for networking (subsections with tasks and some config ref)
 * Networking scenarios - OVS (two scenarios, diagrams, tasks, OVS tunneling)
 * Networking scenarios - Linux Bridge (two scenarios, diagrams)
 * Networking scenarios - ML2 (concept info, two scenarios, diagrams, sec group API)
 * Advanced config options (mostly config ref)
 * Scalable and HA DHCP agents (tasks, diagram)
 * API abstractions (concept info on neutron, good sets of tasks)
 * Basic Networking operations
 * Administrative operations
 * Advanced Networking operations
 * Use Compute with networking (lots of good tasks for common stuff)
 * Advanced features through API extensions - Provider networks
 * Advanced features through API extensions - L3 routing and NAT
 * Advanced features through API extensions - Security groups
 * Advanced features through API extensions - Basic LBaaS operations
 * Advanced features through API extensions - FWaaS
 * Advanced features through API extensions - Plug-in specific extensions
 * Advanced features through API extensions - L3 metering
 * Advanced operational features - Logging
 * Advanced operational features - Notifications
 * Authentication and authorization (lots of concept info, policy reference)

High Availability Guide

 * (mostly links)

Operations Guide

 * (concept info on different architecture and topologies)