Installation Guide - Networking updates for Icehouse

[Matt Kassawara]

A group of us intends to update networking portions of the installation guide for Icehouse. During analysis of the project, we realized that the Neutron chapter would benefit from better integration. For example, configuring Neutron requires a considerable amount of jumping around the guide compared to Nova networking. Many of these changes will affect other portions of the guide. For example, the existing architectural and operating system configuration examples don't thoroughly cover Neutron. Due to the extent of these changes, the guide may periodically break for users trying to follow it.

https://blueprints.launchpad.net/openstack-manuals/+spec/networking-install-guide-improvements

Changes include the following tasks:

1) Add warnings in strategic places throughout the guide indicating potential issues for users during this process.

2) Improve example architectures for Nova networking and Neutron environments.

3) Improve operating system configuration for Nova networking and Neutron environments.

4) Remove modular (multiple plug-in) structure from Neutron chapter.

5) Update general instructions in Neutron chapter. For example, Icehouse doesn't require editing *.ini files.

6) Replace Open vSwitch plug-in instructions with ML2 plug-in instructions. Initial instructions will cover a single provider router with multiple tenant networks using GRE.

7) Improve explanations of Neutron component functions. Ideally, this would include diagrams of typical traffic flow.

8) Create "generic networking" chapter directly after Nova chapter.

9) Migrate Neutron chapter to "generic networking" chapter.

10) Migrate "configure networking" section of Nova chapter to "generic networking" chapter.

11) Create "launch an instance" chapter at end of guide and reference it at the end of every chapter that concludes with a functional environment.

12) Migrate "launch an instance" section of Nova chapter to "launch an instance" chapter.

13) Migrate "Neutron deployment use cases" section of Neutron chapter to more appropriate book.

14) Given issues with the Neutron ML2 plug-in using RDO packages, validate and update existing instructions for the OVS plug-in.

15) Given issues with the Neutron ML2 plug-in using RDO packages, add instructions and mark them "experimental" rather than replacing the instructions for the OVS plug-in.

16) Add instructions for validating functionality of each component.

Please use "Partial-Bug" and "Implements: blueprint networking-install-guide-improvements" when submitting patches. Also, please check if your patches close any other bugs related to the blueprint.

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/79810

[Matt Kassawara (ionosphere80)]

I'm currently working on the following tasks:

Remove modular (multiple plug-in) structure from Neutron chapter.

Update general instructions in Neutron chapter. For example, Icehouse doesn't require editing *.ini files.

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/79810
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=149fc8e4bd31280a0722ea739812945dde72631f
Submitter: Jenkins
Branch: master

commit 149fc8e4bd31280a0722ea739812945dde72631f
Author: Matt Kassawara <email address hidden>
Date: Tue Mar 11 17:39:32 2014 -0600

    Added warnings regarding networking updates for Icehouse

    I added several warnings informing users about potential structure
    and/or content issues during the update process for Icehouse. I will
    remove these warnings after we complete the process.

    Change-Id: Ic13fbbdf60005d5e87ce90e7f3eb225e7e5d5698
    Partial-Bug: #1291071

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/80100

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/80100
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=7013528ea5de4710e963abe414c6429145960b5f
Submitter: Jenkins
Branch: master

commit 7013528ea5de4710e963abe414c6429145960b5f
Author: Matt Kassawara <email address hidden>
Date: Wed Mar 12 16:26:14 2014 -0600

    Restructured and updated Neutron controller section

    As part of the installation guide improvement project, I performed
    the following operations on the Neutron controller section:

    1) Removed modularity since we will only support the ML2 plug-in
       for Icehouse.
    2) Added some <procedure> tags to separate content. Future patches
       will add descriptions of each procedure.
    3) Unified indentation and spacing.
    4) Removed *.ini configuration steps since Icehouse doesn't require
       editing *.ini files.
    5) Moved 'auth_uri' key under [keystone_authtoken] section in
       neutron.conf.
    6) Removed defunct 'auth_url' key.

    This section should continue to work for installations using the Open
    vSwitch plug-in for Neutron. Future patches will update the content
    to use ML2.

    Change-Id: I01b20a70b0b7db7fe096923318eb7dd4465b87c6
    Partial-Bug: #1291071
    Implements: blueprint networking-install-guide-improvements

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/80289

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/80330

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/80289
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=ba782e5be654bbfb3b24b86363eccc0e331a3d9f
Submitter: Jenkins
Branch: master

commit ba782e5be654bbfb3b24b86363eccc0e331a3d9f
Author: Matt Kassawara <email address hidden>
Date: Thu Mar 13 08:02:18 2014 -0600

    Restructured and updated Neutron network node section

    As part of the installation guide improvement project, I performed
    the following operations on the Neutron network node section:

    1) Removed modularity since we will only support the ML2 plug-in
       for Icehouse.
    2) Added some <procedure> tags to separate content. Future patches
       will add descriptions of each procedure.
    3) Unified indentation and spacing.
    4) Removed *.ini configuration steps since Icehouse doesn't require
       editing *.ini files.
    5) Moved 'auth_uri' key under [keystone_authtoken] section in
       neutron.conf.
    6) Removed defunct reference in Neutron use cases section.

    This section should continue to work for installations using the Open
    vSwitch plug-in for Neutron. Future patches will update the content
    to use ML2.

    Change-Id: I23e0ba8df56ef3227443b5588ccb51325ec649dd
    Partial-Bug: #1291071
    Implements: blueprint networking-install-guide-improvements

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/80330
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=70c905f6a8589837580890b7115ae32271eb2a25
Submitter: Jenkins
Branch: master

commit 70c905f6a8589837580890b7115ae32271eb2a25
Author: Matt Kassawara <email address hidden>
Date: Thu Mar 13 10:21:04 2014 -0600

    Restructured and updated Neutron compute section

    As part of the installation guide improvement project, I performed
    the following operations on the Neutron compute section:

    1) Removed modularity since we will only support the ML2 plug-in
       for Icehouse.
    2) Added some <procedure> tags to separate content. Future patches
       will add descriptions of each procedure.
    3) Unified indentation and spacing.
    4) Removed database configuration steps since Icehouse uses AMQP on
       compute nodes.
    5) Removed *.ini configuration steps since Icehouse doesn't require
       editing *.ini files.
    6) Moved 'auth_uri' key under [keystone_authtoken] section in
       neutron.conf.
    7) Removed defunct 'auth_url' key.

    This section should continue to work for installations using the Open
    vSwitch plug-in for Neutron. Future patches will update the content
    to use ML2.

    Change-Id: I2c6207b26a8f85078ac680110d3d3244e8affd75
    Partial-Bug: #1291071
    Implements: blueprint networking-install-guide-improvements

[Matt Kassawara (ionosphere80)]

I completed the following tasks:

Remove modular (multiple plug-in) structure from Neutron chapter.

Update general instructions in Neutron chapter. For example, Icehouse doesn't require editing *.ini files.

[Matt Kassawara (ionosphere80)]

I'm currently working on the following tasks:

Improve example architectures for Nova networking and Neutron environments.

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/80872

[Matt Kassawara (ionosphere80)]

I completed the following tasks:

Improve example architectures for Nova networking and Neutron environments.

I'm currently working on the following tasks:

Update general instructions in Neutron chapter. For example, Icehouse doesn't require editing *.ini files.

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/81983

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/80872
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=2294ed15a3bdafd124d61272bb4a350a0d60ab4f
Submitter: Jenkins
Branch: master

commit 2294ed15a3bdafd124d61272bb4a350a0d60ab4f
Author: Matt Kassawara <email address hidden>
Date: Sun Mar 16 19:08:53 2014 -0600

    Updated architecture chapter

    As part of the installation guide improvement project, I performed
    the following operations on the architecture chapter:

    1) Added new diagrams for example architectures supported by the
       the installation guide.
    2) Increased detail of node function descriptions.
    3) Removed potentially confusing and overwhelming logical
       architecture diagram.
    4) Clarified phrasing and wording.

    The contents of this chapter rely on other portions of the guide
    subject to change during this project and may need additional
    updates.

    Change-Id: I9b887f49a7d3ec94efc748a9056ec3a643ac7899
    Partial-Bug: #1291071
    Implements: blueprint networking-install-guide-improvements

[Matt Kassawara (ionosphere80)]

I completed the following tasks:

Update general instructions in Neutron chapter. For example, Icehouse doesn't require editing *.ini files.

I'm currently working on the following tasks:

Improve operating system configuration for Nova networking and Neutron environments.

[Matt Kassawara (ionosphere80)]

I'm currently working on the following tasks:

Create "generic networking" chapter directly after Nova chapter.

Migrate Neutron chapter to "generic networking" chapter.

Migrate "configure networking" section of Nova chapter to "generic networking" chapter.

Migrate "Neutron deployment use cases" section of Neutron chapter to more appropriate book.

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/82331

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/82331
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=62e4c70a09f014474d5bac006c185335d6c32acb
Submitter: Jenkins
Branch: master

commit 62e4c70a09f014474d5bac006c185335d6c32acb
Author: Matt Kassawara <email address hidden>
Date: Sat Mar 22 20:49:40 2014 -0600

    Restructured networking portions of installation guide

    As part of the installation guide improvement project, I performed
    the following operations on the networking portions of the
    installation guide:

    1) Created "generic networking" chapter directly after Nova chapter.
    2) Migrated Neutron chapter to "generic networking" chapter.
    3) Migrated "configure networking" section of Nova chapter to
       "generic networking" chapter.
    4) Temporarily unlinked "Neutron deployment use cases" section of
       Neutron chapter.
    5) Modified links affected by these changes.

    This patch primarily addresses structural changes to improve
    document flow. Future patches will address content affected by
    these changes.

    Change-Id: Ib1b12c8d902db1c0ab3cbee9b9fef34b7c8157ac
    Partial-Bug: #1291071
    Implements: blueprint networking-install-guide-improvements

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/82696

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/81983
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=36512433f92892940ccbf40b233a211286637363
Submitter: Jenkins
Branch: master

commit 36512433f92892940ccbf40b233a211286637363
Author: Matt Kassawara <email address hidden>
Date: Thu Mar 20 22:07:45 2014 -0600

    Restructured and updated Neutron initial networks section

    As part of the installation guide improvement project, I performed
    the following operations on the Neutron initial networks section:

    1) Added new diagram to help visualize network components and their
       locations within the environment.
    2) Added explanation for each procedure.
    3) Added use of 'openrc' files.
    4) Clarified phrasing and wording.

    Change-Id: I69946a009807681115ebe23c011495ffb8b9467e
    Partial-Bug: #1291071
    Implements: blueprint networking-install-guide-improvements

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/82696
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=f3ecb24050461b5daa88e3124ab2eb311b285a5e
Submitter: Jenkins
Branch: master

commit f3ecb24050461b5daa88e3124ab2eb311b285a5e
Author: Matt Kassawara <email address hidden>
Date: Mon Mar 24 20:31:45 2014 -0600

    Restructured and updated Nova networking sections

    As part of the installation guide improvement project, I performed
    the following operations on the Nova networking sections of the
    installation guide:

    1) Split configuration and initial network creation section to align
       with structure of Neutron chapter.
    2) Aligned phrasing/wording and examples with Neutron chapter.
    3) Removed defunct ch_neutron.xml from repository.
    4) Modified links affected by these changes.
    5) Updated glossary as necessary.

    Change-Id: I690a7c2565826f4370940a716a6200e974211d8f
    Partial-Bug: #1291071
    Implements: blueprint networking-install-guide-improvements

[Matt Kassawara (ionosphere80)]

I completed the following tasks:

Create "generic networking" chapter directly after Nova chapter.

Migrate Neutron chapter to "generic networking" chapter.

Migrate "configure networking" section of Nova chapter to "generic networking" chapter.

Migrate "Neutron deployment use cases" section of Neutron chapter to more appropriate book.

I'm currently working on the following tasks:

Improve operating system configuration for Nova networking and Neutron environments.

Given issues with the Neutron ML2 plug-in using RDO packages, validate and update existing instructions for the OVS plug-in.

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/84288

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/84288
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=ab3b945c263db7dd30a0c96632c7b30a66d42c76
Submitter: Jenkins
Branch: master

commit ab3b945c263db7dd30a0c96632c7b30a66d42c76
Author: Matt Kassawara <email address hidden>
Date: Mon Mar 31 17:34:03 2014 -0600

    Restructured and updated basic environment config chapter

    As part of the installation guide improvement project, I performed
    the following operations on the basic environment configuration
    chapter of the installation guide:

    1) Split large ch_basics.xml file into smaller files to ease addition
       of new networking content and future updates.
    2) Added information on how to install on VMs.
    3) Added recommended minimum hardware requirements for each node.
    4) Built detailed instructions for network configuration on
       three-node neutron and two-node nova example architectures
       including verification of connectivity using name resolution.
    5) Clarified phrasing and wording.
    6) Updated glossary as necessary.

    This patch primarily updates networking content in this chapter.

    Change-Id: Ib31a99448757d36ae29ff8069ddbeab8fe0106bd
    Partial-Bug: #1291071
    Implements: blueprint networking-install-guide-improvements

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/84780

[Matt Kassawara (ionosphere80)]

I completed the following tasks:

Improve operating system configuration for Nova networking and Neutron environments.

Given issues with the Neutron ML2 plug-in using RDO packages, validate and update existing instructions for the OVS plug-in.

I'm currently working on the following tasks:

Replace Open vSwitch plug-in instructions with ML2 plug-in instructions. Initial instructions will cover a single provider router with multiple tenant networks using GRE.

Given issues with the Neutron ML2 plug-in using RDO packages, add instructions and mark them "experimental" rather than replacing the instructions for the OVS plug-in.

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/84898

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/85203

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/84780
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=0bb46133d4764a263e7b1b9e6dd964dffdc4f999
Submitter: Jenkins
Branch: master

commit 0bb46133d4764a263e7b1b9e6dd964dffdc4f999
Author: Matt Kassawara <email address hidden>
Date: Wed Apr 2 10:07:57 2014 -0600

    Added ML2 controller node section to Neutron chapter

    As part of the installation guide improvement project, I performed
    the following operations on the Neutron chapter:

    1) Modified structure to retain existing OVS plug-in sections while
       adding ML2 plug-in sections.
    2) Added ML2 plug-in controller node section.

    This patch primarily covers content. Future patches may address
    structure and/or appearance issues.

    Change-Id: Ic6955316f51b3b3ada45e27e7a6d48bf6a815004
    Partial-Bug: #1291071
    Implements: blueprint networking-install-guide-improvements

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/85203
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=06d96b44c8c93fef9e641d25b73af6f80df27f33
Submitter: Jenkins
Branch: master

commit 06d96b44c8c93fef9e641d25b73af6f80df27f33
Author: Matt Kassawara <email address hidden>
Date: Thu Apr 3 12:22:28 2014 -0600

    Added ML2 compute node section to Neutron chapter

    As part of the installation guide improvement project, I performed
    the following operations on the Neutron chapter:

    1) Added ML2 plug-in compute node section.
    2) Added terms to the glossary as necessary.

    This patch primarily covers content. Future patches may address
    structure and/or appearance issues.

    Change-Id: Ibc3a67dc3e271b61b8debab8c634c32a5be11024
    Partial-Bug: #1291071
    Implements: blueprint networking-install-guide-improvements

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/84898
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=3ebc5a521cfd59f4835055b5bce02780a88927db
Submitter: Jenkins
Branch: master

commit 3ebc5a521cfd59f4835055b5bce02780a88927db
Author: Matt Kassawara <email address hidden>
Date: Wed Apr 2 11:11:30 2014 -0600

    Added ML2 network node section to Neutron chapter

    As part of the installation guide improvement project, I performed
    the following operations on the Neutron chapter:

    1) Added ML2 plug-in network node section.
    2) Added terms to the glossary as necessary.

    This patch primarily covers content. Future patches may address
    structure and/or appearance issues.

    Change-Id: I54d4a009dbc4a4569c7a0b1053720aacefbc4f80
    Partial-Bug: #1291071
    Implements: blueprint networking-install-guide-improvements

[Matt Kassawara (ionosphere80)]

I completed the following tasks:

Replace Open vSwitch plug-in instructions with ML2 plug-in instructions. Initial instructions will cover a single provider router with multiple tenant networks using GRE.

Given issues with the Neutron ML2 plug-in using RDO packages, add instructions and mark them "experimental" rather than replacing the instructions for the OVS plug-in.

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/86485

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/86760

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/86485
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=d0ece3d6efaa8ba7c6c1099b59754df83173f371
Submitter: Jenkins
Branch: master

commit d0ece3d6efaa8ba7c6c1099b59754df83173f371
Author: Matt Kassawara <email address hidden>
Date: Wed Apr 9 14:49:50 2014 -0600

    Updated Launch chapter

    As part of the installation guide improvement project, I performed
    the following operations on the Launch chapter:

    1) Split monolithic file with instructions for nova networking into
       separate files for nova and neutron networking.
    2) Updated instructions in each section to account for differences
       between nova and neutron networking.
    3) Updated other sections and glossary as necessary.

    Change-Id: I7faaadc0787cf85d816c7c2aab1247ecc77195b2
    Partial-Bug: #1291071
    Implements: blueprint networking-install-guide-improvements

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/86760
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=17fc8c8a8b829cab8c64470d3058137a102ed315
Submitter: Jenkins
Branch: master

commit 17fc8c8a8b829cab8c64470d3058137a102ed315
Author: Matt Kassawara <email address hidden>
Date: Thu Apr 10 19:18:20 2014 -0600

    Release candidate updates for Networking chapter

    As part of the installation guide improvement project, I performed
    the following operations on the Networking chapter:

    1) Moved Neutron ML2 sections before OVS sections and updated
       associated notes to steer users toward ML2.
    2) Removed database population steps because Neutron populates the
       database at first run.
    3) Moved 'enable_security_group' key to [securitygroup] section.
    4) Removed extraneous colons from procedure titles.
    5) Added command output to Neutron initial networks section.
    6) Added command output to Nova initial networks section.

    Change-Id: Ie677d199d2c64ef2a564eaa551295e1a321db02c
    Partial-Bug: #1291071
    Implements: blueprint networking-install-guide-improvements

[Matt Kassawara (ionosphere80)]

Nick Chase completed the following tasks:

Create "launch an instance" chapter at end of guide and reference it at the end of every chapter that concludes with a functional environment.

Migrate "launch an instance" section of Nova chapter to "launch an instance" chapter.

I completed the following tasks:

Add instructions for validating functionality of each component.

Completion of these steps concludes this bug.