Difference between revisions of "NetworkingGuide/TOC"

Revision as of 15:17, 8 August 2014

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.

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)
   Core Networking API features (concpet info on neutron, good sets of tasks)
   Use Compute with networking (lots of good tasks for common stuff)
   Advanced features through API extensions (advanced tasks for routing, sec groups, LBaaS, FWaaS, etc)
   Advanced operational features (tasks for logging and 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

Networking

1. Introduction to networking
   1. Explanation of layers
   2. Switches
   3. Routers
   4. Firewalls
   5. Tunnel (segmentation) technologies
      1. Layer 2
         1. VLAN
      2. Layer 3
         1. GRE
         2. VXLAN
   6. Namespaces
   7. Neutron data model (how above networking concepts are done in Neutron)
      1. Networks
      2. Subnets
      3. Ports
      4. Extensions

1. Networking (neutron) architecture
   1. Overview/concepts
      1. Service/component hierarchy
         1. Neutron server -> Plug-in -> Agents
      2. Example architectures (possibly take from use cases in Grizzly Network Guide)
         1. Example 1
            1. Controller / Network node
               1. Server
               2. Plug-in
               3. Agents
            2. Compute node
               1. Plug-in
               2. Agents
         2. Example 2
            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

4. 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)

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)
       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
   2. L3 Agents
   3. DVR (Juno)

7. Advanced configuration

   1. Provider networks

8. Advanced operational features

   1. Logging

9. Advanced services

   1. LBaaS
   2. FWaaS
   3. VPNaaS
   4. Service Chaining (regXboi)

10. Group policy (regXboi)

   1. How it differs from legacy neutron data model

11. Debugging

   1. Neutron-debug command