NetworkingGuide/TOC

This is the proposed TOC for the Networking Guide. (Blueprint located at https://blueprints.launchpad.net/openstack-manuals/+spec/create-networking-guide .)

NOTE: This is the initial "import" from the install and admin guides, as a starting point.

Persona (Target Audience)

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

Preface

Document change history

Networking

1. Introduction to networking

   1. Switches
   2. Routers
   3. Firewalls
   4. Tunnel (segmentation) technologies
       1. Layer 2
           1. VLAN
       2. Layer 3
           1. GRE
           2. VXLAN
    5. Namespaces

2. Networking (neutron) architecture

   1. Overview/concepts
       1. Service/component hierarchy
           1. Neutron server -> Plug-in -> Agents
       2. Typical architecture
           1. Controller node
               1. Server
               2. Plug-in
           2. Network node
               1. Plug-in
               2. Agents
           3. Compute nodes
               1. Plug-in
               2. Agents
   2. Server
       1. Overview/concepts (provides API, manages database, etc.)
       2. Configuration file (particularly core_plugin and service_plugins)
   3. Plug-in
       1. Overview/concepts (manages agents)
       2. Configuration file (generic location... /etc/neutron/plugins/*)
   4. Agents
       1. Overview/concepts (provide layer 2/3 connectivity to instances, handle physical-virtual network transition, handle metadata, etc.)
       2. Layer 2 (Ethernet/Switching)
           1. Linux Bridge
               1. Overview/concepts
               2. Configuration file (generally within plug-in configuration)
           2. OVS
               1. Overview/concepts
               2. Configuration file (generally within plug-in configuration)
       3. Layer 3 (IP/Routing)
           1. L3
               1. Overview/concepts
               2. Configuration file
           2. DHCP
               1. Overview/concepts
               2. Configuration file
       4. Miscellaneous
           1. Metadata
               1. Overview/concepts
               2. Configuration file

3. Plug-ins

   1. ML2
       1. Overview
           1. Architecture
           2. Configuration file organization, relationships, etc.
       2. Network type drivers
           1. Flat
           2. VLAN
           3. GRE
           4. VXLAN
       3. Tenant network types
           1. Local
           2. VLAN
               1. VLAN ID ranges
           3. GRE
               1. Tunnel ID ranges
           4. VXLAN
               1. VNI ID ranges
       4. Mechanisms
           1. Linux Bridge
               1. Option stanza/section
           2. OVS
               1. Option stanza/section
           3. Open Daylight
           4. L2 Population
           5. Proprietary (vendor)
       5. Security
           1. Options
   2. Proprietary (vendor)

4. Deployment

   1. Example architecture (three-node)
       1. Controller node
           1. Functions (provides API)
       2. Network node
           1. Functions (handles routing, nat, floating IPs, etc.)
       3. Compute nodes
           1. Functions (implements security groups)
   2. Scenarios (provide configuration, diagrams, and flow of communication when launching an instance)
       1. Linux bridge using VLAN
       2. Linux bridge using GRE
       3. Linux bridge using VXLAN
       4. OVS with VLAN
       5. OVS with GRE
       6. OVS with VXLAN
       7. Mixed Linux Bridge and OVS

5. Scalability and high availability

   1. DHCP agents
   2. L3 Agents
   3. DVR (Juno)

6. Advanced configuration

   1. Provider networks

7. Advanced operational features

   1. Logging

8. Advanced services

   1. LBaaS
   2. FWaaS
   3. VPNaaS

9. Debugging

   1. Neutron-debug command