Jump to: navigation, search

Difference between revisions of "NetworkingGuide/TOC"

Line 1: Line 1:
== Proposed TOC for the Networking Guide ==
+
This guide targets OpenStack administrators seeking to deploy and manage neutron.
  
Blueprint: https://blueprints.launchpad.net/openstack-manuals/+spec/create-networking-guide
+
== Instructions for Contributors ==
 
 
=== Instructions for Contributors ===
 
  
 
# Pick a topic.
 
# Pick a topic.
 
# Develop content (text and/or diagrams) in a format that supports at least basic markup (titles, paragraphs, lists, etc.).
 
# 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)
+
# Provide a link to the content (e.g., gist on github.com) under the associated topic.
 
# Send e-mail to reviewers.
 
# Send e-mail to reviewers.
  
NOTE:  This is the initial "import" from the install and admin guides, as a starting point.
+
== Proposed topics for the Networking Guide ==
  
Resources:
+
Blueprint: https://blueprints.launchpad.net/openstack-manuals/+spec/create-networking-guide
* [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]
 
  
Available content for potential reuse:
+
NOTE: This is the initial "import" from the install and admin guides, as a starting point.
 
 
  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 ===
 
=== Preface ===
Line 118: Line 62:
 
### Server
 
### Server
 
#### Overview/concepts (provides API, manages database, etc.)
 
#### Overview/concepts (provides API, manages database, etc.)
#### Configuration file (particularly core_plugin and service_plugins)
 
 
### Plug-ins
 
### Plug-ins
 
#### Overview/concepts (manages agents)
 
#### Overview/concepts (manages agents)
#### Configuration file (generic location... /etc/neutron/plugins/*)
 
 
### Agents
 
### Agents
 
#### Overview/concepts (provide layer 2/3 connectivity to instances, handle physical-virtual network transition, handle metadata, etc.)
 
#### Overview/concepts (provide layer 2/3 connectivity to instances, handle physical-virtual network transition, handle metadata, etc.)
Line 127: Line 69:
 
##### Linux Bridge
 
##### Linux Bridge
 
###### Overview/concepts
 
###### Overview/concepts
###### Configuration file (generally within plug-in configuration)
 
 
##### OVS
 
##### OVS
 
###### Overview/concepts
 
###### Overview/concepts
###### Configuration file (generally within plug-in configuration)
 
 
#### Layer 3 (IP/Routing)
 
#### Layer 3 (IP/Routing)
 
##### L3
 
##### L3
 
###### Overview/concepts
 
###### Overview/concepts
###### Configuration file
 
 
##### DHCP
 
##### DHCP
 
###### Overview/concepts
 
###### Overview/concepts
###### Configuration file
 
 
#### Miscellaneous
 
#### Miscellaneous
 
##### Metadata
 
##### Metadata
 
###### Overview/concepts
 
###### Overview/concepts
###### Configuration file
 
 
== TOC below here not ready ==
 
  
 
=== Configuration ===
 
=== Configuration ===
Line 159: Line 94:
 
##### Flat
 
##### Flat
 
##### VLAN
 
##### VLAN
            3. GRE
+
##### GRE
            4. VXLAN
+
##### VXLAN
        3. Tenant network types (similar info in http://docs.openstack.org/admin-guide-cloud/content/tenant-provider-networks.html)
+
#### Tenant network types (similar info in http://docs.openstack.org/admin-guide-cloud/content/tenant-provider-networks.html)
            1. Local
+
##### Local
            2. VLAN
+
##### VLAN
                1. VLAN ID ranges
+
###### ID ranges
            3. GRE
+
##### GRE
                1. Tunnel ID ranges
+
###### Tunnel ID ranges
            4. VXLAN
+
##### VXLAN
                1. VNI ID ranges
+
###### ID ranges
        4. Mechanisms
+
###### Multicast discovery (L2 population)
            1. Linux Bridge
+
#### Mechanisms
                1. Option stanza/section
+
##### Linux Bridge
            2. OVS
+
###### Option stanza/section
                1. Option stanza/section
+
##### OVS
            3. Open Daylight
+
###### Option stanza/section
            4. L2 Population
+
##### L2 Population
            5. Proprietary (vendor)
+
##### Open Daylight
        5. Security
+
##### Proprietary (vendor)
            1. Options
+
#### Security
    2. Proprietary (vendor)
+
##### Options
5. Deployment
+
### Agents
    1. Example architecture (three-node)
+
#### L3
        1. Controller node
+
##### Configuration file
            1. Functions (provides API)
+
#### DHCP
        2. Network node
+
##### Configuration file
            1. Functions (handles routing, nat, floating IPs, etc.)
+
#### Metadata agent
        3. Compute nodes
+
##### Configuration file
            1. Functions (implements security groups)
+
##### Packet routing magic
    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
+
=== Deployment Scenarios ===
        2. Linux bridge using GRE
+
 
        3. Linux bridge using VXLAN
+
# Architecture 1 - Classic
        4. OVS with VLAN
+
## Controller node, network node, and 1+ compute nodes
        5. OVS with GRE
+
## Provider networks
        6. OVS with VXLAN
+
### Flat
        7. Mixed Linux Bridge and OVS
+
### VLAN
6. Scalability and high availability
+
## Tenant networks
    1. DHCP agents (http://docs.openstack.org/admin-guide-cloud/content/app_demo_multi_dhcp_agents.html)
+
### VLAN
    2. L3 Agents
+
### GRE
    3. DVR (Juno) (https://wiki.openstack.org/wiki/Neutron/DVR_L2_Agent)
+
### VXLAN
7. Advanced configuration
+
 
 +
# Architecture 2 - High availability (DVR and Open vSwitch)
 +
## Controller node and 1+ compute nodes
 +
## Provider networks
 +
### Flat
 +
### VLAN
 +
## Tenant networks
 +
### VLAN
 +
### GRE
 +
### VXLAN
 +
 
 +
# Architecture 3 - High availability (L3 HA and Linux Bridge)
 +
## Controller node, two network nodes, and 1+ compute nodes
 +
## Provider networks
 +
### Flat
 +
### VLAN
 +
## Tenant networks
 +
### VLAN
 +
### GRE
 +
### VXLAN
 +
 
 +
# Architecture 4 - Provider networks handle L3 and DHCP services (bare pipes)
 +
## Controller node and 1+ compute nodes
 +
## Provider networks
 +
### Flat
 +
### VLAN
 +
       
 +
# Adding high availability for DHCP
 +
## DHCP agents (http://docs.openstack.org/admin-guide-cloud/content/app_demo_multi_dhcp_agents.html)  
 +
 
 +
=== Advanced configuration ===
 
   Content copied from:
 
   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-advanced-config.html
Line 206: Line 171:
 
   *http://docs.openstack.org/admin-guide-cloud/content/section_networking-adv-operational_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 ?)
+
# Operational
    2. Advanced operational features
 
 
       1. Logging (http://docs.openstack.org/admin-guide-cloud/content/section_adv_logging.html)
 
       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)
+
# 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)
+
# 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
+
# VPNaaS
    6. Service Chaining (regXboi)
+
# Service Chaining (regXboi)
9. Group policy (regXboi)
+
# Group policy (regXboi)
    1. How it differs from legacy neutron data model
+
## How it differs from legacy neutron data model
10. Debugging
+
# Debugging
    1. Neutron-debug command
+
## Neutron-debug command
 +
 
 +
== Potential Resources and Reusable Content ==
 +
 
 +
* [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]
 +
 
 +
  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 ...
  
 
[[Category:Documentation Blueprint]]
 
[[Category:Documentation Blueprint]]

Revision as of 15:26, 27 September 2014

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

Instructions for Contributors

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

Proposed topics for the Networking Guide

Blueprint: 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.

Preface

Document change history

Introduction to networking

  1. Basic networking
    1. Ethernet
    2. VLANs
    3. ARP
    4. IP
    5. ICMP/TCP/UDP
  1. Network components
    1. Switches
    2. Routers
    3. Firewalls
    4. Load balancers
  1. Tunnel (segmentation) technologies
    1. Layer 2
      1. VLAN
    2. Layer 3
      1. GRE
      2. VXLAN
  1. Network namespaces
    1. Concepts (relation to VRFs)

Introduction to OpenStack Networking (neutron)

  1. 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
  1. Architecture
    1. Overview/concepts
    2. Service/component hierarchy
      1. Server
        1. Overview/concepts (provides API, manages database, etc.)
      2. Plug-ins
        1. Overview/concepts (manages agents)
      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
            1. Overview/concepts
          2. OVS
            1. Overview/concepts
        3. Layer 3 (IP/Routing)
          1. L3
            1. Overview/concepts
          2. DHCP
            1. Overview/concepts
        4. Miscellaneous
          1. Metadata
            1. Overview/concepts

Configuration

  1. Server
    1. Architecture
    2. Configuration file organization, relationships, etc.
      1. Reference common configuration items
  1. 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
        2. Tenant network types (similar info in http://docs.openstack.org/admin-guide-cloud/content/tenant-provider-networks.html)
          1. Local
          2. VLAN
            1. ID ranges
          3. GRE
            1. Tunnel ID ranges
          4. VXLAN
            1. ID ranges
            2. Multicast discovery (L2 population)
        3. Mechanisms
          1. Linux Bridge
            1. Option stanza/section
          2. OVS
            1. Option stanza/section
          3. L2 Population
          4. Open Daylight
          5. Proprietary (vendor)
        4. Security
          1. Options
      3. Agents
        1. L3
          1. Configuration file
        2. DHCP
          1. Configuration file
        3. Metadata agent
          1. Configuration file
          2. Packet routing magic

Deployment Scenarios

  1. Architecture 1 - Classic
    1. Controller node, network node, and 1+ compute nodes
    2. Provider networks
      1. Flat
      2. VLAN
    3. Tenant networks
      1. VLAN
      2. GRE
      3. VXLAN
  1. Architecture 2 - High availability (DVR and Open vSwitch)
    1. Controller node and 1+ compute nodes
    2. Provider networks
      1. Flat
      2. VLAN
    3. Tenant networks
      1. VLAN
      2. GRE
      3. VXLAN
  1. Architecture 3 - High availability (L3 HA and Linux Bridge)
    1. Controller node, two network nodes, and 1+ compute nodes
    2. Provider networks
      1. Flat
      2. VLAN
    3. Tenant networks
      1. VLAN
      2. GRE
      3. VXLAN
  1. Architecture 4 - Provider networks handle L3 and DHCP services (bare pipes)
    1. Controller node and 1+ compute nodes
    2. Provider networks
      1. Flat
      2. VLAN
  1. Adding high availability for DHCP
    1. DHCP agents (http://docs.openstack.org/admin-guide-cloud/content/app_demo_multi_dhcp_agents.html)

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. Operational
      1. Logging (http://docs.openstack.org/admin-guide-cloud/content/section_adv_logging.html)
  1. 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)
  2. 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)
  3. VPNaaS
  4. Service Chaining (regXboi)
  5. Group policy (regXboi)
    1. How it differs from legacy neutron data model
  6. Debugging
    1. Neutron-debug command

Potential Resources and Reusable Content

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