Install Guide: Networking chapter is confusing

Bug #1244759 reported by Andreas Jaeger
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
openstack-manuals
Fix Released
High
Nermina Miller

Bug Description

We have duplicate information in the guide, send people around to other sections where they can choose between different plugins - but only offer OVS as single plugin - and don't follow the conventions from the rest of the guide.

I've added annotations to a PDF file of the Install Guide and uploaded it to:

https://dl.dropboxusercontent.com/u/31007128/openstack-install-guide-zypper-trunk-annotated-jaegerandi.pdf

The annotations are only in the Networking chapter.

Revision history for this message
Solly Ross (sross-7) wrote :

Ok, I'll take a look. I've been trying to fix some of that up. The idea with the sections for the different plugins was that some of the other companies/organizations with their own plugins would fill in parts for their own sections. Let me take a look a some of the annotations you made and I'll get back to you.

Revision history for this message
Andreas Jaeger (jaegerandi) wrote :

Solly, the idea is nice, let's implement it a bit better. Why not add an empty section for reference there and some introductory section explaining at least some of the options (ML2, LinuxBridge, OVS).

Thanks for looking into this.

Revision history for this message
Anne Gentle (annegentle) wrote :

Notes from the mailing list thread at http://lists.openstack.org/pipermail/openstack/2013-October/002521.html in the attached.

Revision history for this message
Anne Gentle (annegentle) wrote :

Sorry for making a catch-all, but the bug is descriptive of what was reported on the mailing list as well.

Revision history for this message
Nermina Miller (nerminamiller) wrote :

Hi all, following up. Could I go in and remove the duplicates? Also, do we need to evaluate the old plugin info and see if we can bring some of it back to the configuration reference and the install guide? See these old docs: http://docs.openstack.org/grizzly/openstack-network/admin/content/ch_install.html

Changed in openstack-manuals:
assignee: nobody → Nermina Miller (nerminamiller)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to openstack-manuals (stable/havana)

Fix proposed to branch: stable/havana
Review: https://review.openstack.org/55345

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to openstack-manuals (master)

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

Changed in openstack-manuals:
assignee: Nermina Miller (nerminamiller) → Andreas Jaeger (jaegerandi)
status: New → In Progress
Changed in openstack-manuals:
assignee: Andreas Jaeger (jaegerandi) → Nermina Miller (nerminamiller)
Changed in openstack-manuals:
assignee: Nermina Miller (nerminamiller) → Andreas Jaeger (jaegerandi)
Changed in openstack-manuals:
assignee: Andreas Jaeger (jaegerandi) → Nermina Miller (nerminamiller)
tags: added: install-guide
Changed in openstack-manuals:
assignee: Nermina Miller (nerminamiller) → Diane Fleming (diane-fleming)
Changed in openstack-manuals:
assignee: Diane Fleming (diane-fleming) → nobody
assignee: nobody → Nermina Miller (nerminamiller)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to openstack-manuals (master)

Reviewed: https://review.openstack.org/55404
Committed: http://github.com/openstack/openstack-manuals/commit/1fe3fe0a3199017aaabf3ac421b26da725290b5b
Submitter: Jenkins
Branch: master

commit 1fe3fe0a3199017aaabf3ac421b26da725290b5b
Author: nerminamiller <email address hidden>
Date: Wed Nov 6 11:47:39 2013 -0500

    Move various plugin configuration info from the old networking install chapter to Cloud Admin Guide

    Move Big Switch, Nicira, OSV, PLUMgrid, Ryu, and neutron agent config info to ch_neworking
    Add info about deleting nova-network before initializing networking install
    Add crossreferences to Config Ref and Install Guide

    author: nermina miller
    backport: havana
    Partial-Bug: 1244759

    Change-Id: I5fe694de95da45879acccb5dfa45a331aa591403

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to openstack-manuals (stable/havana)

Fix proposed to branch: stable/havana
Review: https://review.openstack.org/56139

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to openstack-manuals (stable/havana)

Reviewed: https://review.openstack.org/56139
Committed: http://github.com/openstack/openstack-manuals/commit/57c48319be1f733aa3da3cd5c251eb5007adbc22
Submitter: Jenkins
Branch: stable/havana

commit 57c48319be1f733aa3da3cd5c251eb5007adbc22
Author: nerminamiller <email address hidden>
Date: Wed Nov 6 11:47:39 2013 -0500

    Move various plugin configuration info from the old networking install chapter to Cloud Admin Guide

    Move Big Switch, Nicira, OSV, PLUMgrid, Ryu, and neutron agent config info to ch_neworking
    Add info about deleting nova-network before initializing networking install
    Add crossreferences to Config Ref and Install Guide

    author: nermina miller
    backport: havana
    Partial-Bug: 1244759

    Not backported since not needed and caused conflicts:
     doc/admin-guide-cloud/ch_networking.xml

    (cherry picked from commit 1fe3fe0a3199017aaabf3ac421b26da725290b5b)

    Change-Id: Ib45674d38df1fd4bc7f34ce136216c1d4c83ff8a

tags: added: in-stable-havana
Changed in openstack-manuals:
status: In Progress → Fix Committed
Revision history for this message
Andreas Jaeger (jaegerandi) wrote :

The changees done by Nermina are great but do not address the overall situation in the Install Guide, reopening.

Changed in openstack-manuals:
status: Fix Committed → Confirmed
importance: Undecided → High
milestone: none → icehouse
Revision history for this message
Matt Kassawara (ionosphere80) wrote :

We decided to only support a single plug-in for Icehouse, so I believe the following patches address this issue:

https://review.openstack.org/80100
https://review.openstack.org/80289
https://review.openstack.org/80330

Revision history for this message
Matt Kassawara (ionosphere80) wrote :
Changed in openstack-manuals:
status: Confirmed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.