NetworkingGuide/TOC

Proposed TOC for the Networking Guide

Blueprint: https://blueprints.launchpad.net/openstack-manuals/+spec/create-networking-guide

Instructions for Contributors

Pick a topic.
Develop content (text and/or diagrams) in a format that supports at least basic markup (titles, paragraphs, lists, etc.).
Provide a link to the content (e.g., gist on github.com)
Send e-mail to reviewers.

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

Resources:

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

Available content for potential reuse:

 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 hypervs)
   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 (concpet 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 (mostly links)
 Operations Guide
   (concept info on different architecture and topologies)
 Security Guide ...

Persona (Target Audience)

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

Preface

Document change history

Introduction to networking

Basic networking
1. Ethernet
2. VLANs
3. ARP
4. IP
5. ICMP/TCP/UDP

Network components
1. Switches
2. Routers
3. Firewalls
4. Load balancers

Tunnel (segmentation) technologies
1. Layer 2
  1. VLAN
2. Layer 3
  1. GRE
  2. VXLAN

Network namespaces
1. Concepts (relation to VRFs)

Introduction to OpenStack Networking (neutron)

Virtual network component comparisons (how neutron models above components) (terms in http://docs.openstack.org/admin-guide-cloud/content/api_abstractions.html)
1. Networks (switches?)
  1. Flat
  2. VLAN
  3. GRE
  4. VXLAN
2. Subnets (supports multiple per network?)
3. Ports (switch ports?)
4. Routers (routers)
5. Security groups (firewalls)
6. Extensions

Architecture
1. Overview/concepts
2. Service/component hierarchy
  1. Server
    1. Overview/concepts (provides API, manages database, etc.)
    2. Configuration file (particularly core_plugin and service_plugins)
  2. Plug-ins
    1. Overview/concepts (manages agents)
    2. Configuration file (generic location... /etc/neutron/plugins/*)
  3. 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
        Overview/concepts
        
        Configuration file (generally within plug-in configuration)
      2. OVS
        Overview/concepts
        
        Configuration file (generally within plug-in configuration)
    3. Layer 3 (IP/Routing)
      1. L3
        Overview/concepts
        
        Configuration file
      2. DHCP
        Overview/concepts
        
        Configuration file
    4. Miscellaneous
      1. Metadata
        Overview/concepts
        
        Configuration file

TOC below here not ready

Configuration

Server
1. Architecture
2. Configuration file organization, relationships, etc.
  1. Reference common configuration items

ML2 plug-in
1. Overview
  1. Architecture
  2. Configuration file organization, relationships, etc.
    1. Network type drivers
      1. Flat
      2. VLAN

           3. GRE
           4. VXLAN
       3. Tenant network types (similar info in http://docs.openstack.org/admin-guide-cloud/content/tenant-provider-networks.html)
           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)

5. 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) (http://docs.openstack.org/admin-guide-cloud/content/ml2_scenarios.html)
       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

6. Scalability and high availability

   1. DHCP agents (http://docs.openstack.org/admin-guide-cloud/content/app_demo_multi_dhcp_agents.html)
   2. L3 Agents
   3. DVR (Juno) (https://wiki.openstack.org/wiki/Neutron/DVR_L2_Agent)

7. Advanced configuration

  Content copied from:
  *http://docs.openstack.org/admin-guide-cloud/content/section_networking-advanced-config.html
  *http://docs.openstack.org/admin-guide-cloud/content/section_networking-adv-features.html
  *http://docs.openstack.org/admin-guide-cloud/content/section_networking-adv-operational_features.html

   1. Provider networks (http://docs.openstack.org/admin-guide-cloud/content/tenant-provider-networks.html ?)
   2. Advanced operational features
      1. 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)

9. Group policy (regXboi)

   1. How it differs from legacy neutron data model

10. Debugging

   1. Neutron-debug command