Jump to: navigation, search

Difference between revisions of "NetworkingGuide/TOC"

(Split typical architecture into example architectures and added an additional architecture example.)
Line 2: Line 2:
  
 
NOTE:  This is the initial "import" from the install and admin guides, as a starting point.
 
NOTE:  This is the initial "import" from the install and admin guides, as a starting point.
 +
 +
Resources:
 +
* [http://docs.openstack.org/grizzly/openstack-network/admin/content/ Grizzly Networking Administration Guide]
 +
* Networking section of Install Guide for [http://docs.openstack.org/icehouse/install-guide/install/yum/content/ch_networking.html Red Hat], [http://docs.openstack.org/icehouse/install-guide/install/zypper/content/ch_networking.html SUSE], [http://docs.openstack.org/icehouse/install-guide/install/apt-debian/content/ch_networking.html Debian], [http://docs.openstack.org/icehouse/install-guide/install/apt/content/ch_networking.html Ubuntu]
 +
* [http://docs.openstack.org/admin-guide-cloud/content/ch_networking.html Networking section of Cloud Admin Guide]
 +
* [http://docs.openstack.org/openstack-ops/content/network_design.html Networking section of Operators Guide]
 +
* [http://docs.openstack.org/security-guide/content/networking.html Networking section of Security Guide]
 +
* [http://docs.openstack.org/icehouse/config-reference/content/ch_configuring-openstack-networking.html Networking section of Config Reference]
 +
* [http://docs.openstack.org/api/openstack-network/2.0/content/ Network API Reference]
  
 
Persona (Target Audience)
 
Persona (Target Audience)
Line 13: Line 22:
 
Networking  
 
Networking  
  
1. Introduction to networking
+
# Introduction to networking
    1. Switches
+
## Explanation of layers
    2. Routers
+
## Switches
    3. Firewalls
+
## Routers
    4. Tunnel (segmentation) technologies
+
## Firewalls
        1. Layer 2
+
## Tunnel (segmentation) technologies
            1. VLAN
+
### Layer 2
        2. Layer 3
+
#### VLAN
            1. GRE
+
### Layer 3
            2. VXLAN
+
#### GRE
    5. Namespaces
+
#### VXLAN
 +
## Namespaces
 +
## Neutron data model (how above networking concepts are done in Neutron)
 +
### Networks
 +
### Subnets
 +
### Ports
 +
### Extensions
  
2. Networking (neutron) data model (regXboi addition)
+
# Networking (neutron) architecture
    1. Networks
+
## Overview/concepts
    2. Subnets
+
### Service/component hierarchy
    3. Ports
+
#### Neutron server -> Plug-in -> Agents
    4. Extensions
+
### Example architectures (possibly take from [http://docs.openstack.org/grizzly/openstack-network/admin/content/use_cases.html use cases in Grizzly Network Guide])
 +
#### Example 1
 +
##### Controller / Network node
 +
###### Server
 +
###### Plug-in
 +
###### Agents
 +
##### Compute node
 +
###### Plug-in
 +
###### Agents
 +
#### Example 2
 +
##### Controller node
 +
###### Server
 +
###### Plug-in
 +
##### Network node
 +
###### Plug-in
 +
###### Agents
 +
##### Compute nodes
 +
###### Plug-in
 +
###### Agents
 +
## Server
 +
### Overview/concepts (provides API, manages database, etc.)
 +
### Configuration file (particularly core_plugin and service_plugins)
 +
## Plug-in
 +
### Overview/concepts (manages agents)
 +
### Configuration file (generic location... /etc/neutron/plugins/*)
 +
## Agents
 +
### Overview/concepts (provide layer 2/3 connectivity to instances, handle physical-virtual network transition, handle metadata, etc.)
 +
### Layer 2 (Ethernet/Switching)
 +
#### Linux Bridge
 +
##### Overview/concepts
 +
##### Configuration file (generally within plug-in configuration)
 +
#### OVS
 +
##### Overview/concepts
 +
##### Configuration file (generally within plug-in configuration)
 +
#### Layer 3 (IP/Routing)
 +
##### L3
 +
###### Overview/concepts
 +
###### Configuration file
 +
##### DHCP
 +
###### Overview/concepts
 +
###### Configuration file
 +
#### Miscellaneous
 +
##### Metadata
 +
###### Overview/concepts
 +
###### Configuration file
  
3. Networking (neutron) architecture
 
    1. Overview/concepts
 
        1. Service/component hierarchy
 
            1. Neutron server -> Plug-in -> Agents
 
        2. Example architectures
 
            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
 
4. Plug-ins
 
     1. ML2
 
     1. ML2

Revision as of 13:11, 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:

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