Chapter 7. Add a networking service in OpenStack Installation Guide for Ubuntu 12.04/14.04 (LTS) - icehouse - component description missing

[Marco CONSONNI]

This section misses the descriptions of the software components (CLI, daemons, etc) that build up neutron architecture.
I found this kind of description very useful in the other section.

I understand this is not a real bug; flag it as a "wishlist".

-----------------------------------
Built: 2014-07-10T16:04:18 00:00
git SHA: 6969432798f9eab69863f6fac714a228516a39aa
URL: http://docs.openstack.org/icehouse/install-guide/install/apt/content/ch_networking.html
source File: file:/home/jenkins/workspace/openstack-manuals-tox-doc-publishdocs/doc/install-guide/ch_networking.xml
xml:id: ch_networking

[Marco CONSONNI (marco-consonni)]

I found some material that could provide some material http://docs.openstack.org/admin-guide-cloud/content/arch_overview.html

[Matt Kassawara (ionosphere80)]

We describe much of the neutron architecture here:

http://docs.openstack.org/icehouse/install-guide/install/apt/content/ch_overview.html#architecture_example-architectures

We also explain the purpose of the components in each procedure here:

http://23.253.231.218:8080/install-guide-yum/content/section_neutron-networking-ml2.html

If this doesn't help, please clarify.

[Marco CONSONNI (marco-consonni)]

Hello, I was suggesting to add a description of the Neutron sub-components (i.e. daemons, CLI, etc.) similar to what reported on the sections dedicated to the other components.

For example nova's description reports something like:

"OpenStack Compute consists of the following areas and their components:

API

nova-api service

    Accepts and responds to end user compute API calls. The service supports the OpenStack Compute API, the Amazon EC2 API, and a special Admin API for privileged users to perform administrative actions. It enforces some policies and initiates most orchestration activities, such as running an instance. "

etc... (see Chapter 5. Add the Compute service)

Similar situation for cinder

"The OpenStack Block Storage service (cinder) adds persistent storage to a virtual machine. Block Storage provides an infrastructure for managing volumes, and interacts with OpenStack Compute to provide volumes for instances. The service also enables management of volume snapshots, and volume types.

The Block Storage service consists of the following components:

cinder-api

    Accepts API requests, and routes them to the cinder-volume for action."

(see Chapter 8. Add the Block Storage service)

[Marco CONSONNI (marco-consonni)]

Hello, I was reading the bug description I originally submitted and I must admit that it was not clear at all. Sorry about that.

Anyway, the point is that all the sections dedicated to the other OpenStack projects, or modules, like nova, cinder, swift, etc... start with a brief overview of the corresponding sub-modules (daemons, CLI, etc..). Well, in my understanding, this description is very useful for understanding the "anatomy" of each openstack project and help understand why some packages are installed on one node and not on another.

Having said that, Neutron's description could benefit of this explanation that should be reported just after the paragraph named as "OpenStack Networking (neutron)" and right before the two hyperlinks to "Networking concepts" and "Modular Layer 2 (ML2) plug-in". I suggest the material found here (http://docs.openstack.org/admin-guide-cloud/content/arch_overview.html) for the purpose.

It is worth noticing that section "Legacy networking (nova-network)", where we describe the legacy networking, doesn't really need the sub-modules description that is given where nova is treated.

Hope it helps.

[OpenStack Infra (hudson-openstack)]

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

commit 25c96dd7e552de26b80343066e5cc32a9f5fce50
Author: darrenchan <email address hidden>
Date: Fri Dec 5 17:13:33 2014 +1100

    Linked Neutron overview content in the Installation Guide

    'xi:include parse' the neutron overview content in the OpenStack Networking section

    backport: Juno
    Closes-Bug: #1340524

    Change-Id: Ifaf92418552396c992764cb55696da30dd654853

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: stable/juno
Review: https://review.openstack.org/139702

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/139702
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=f0f0a3f7a8618fdfa0cc0a4a7a746833b4621565
Submitter: Jenkins
Branch: stable/juno

commit f0f0a3f7a8618fdfa0cc0a4a7a746833b4621565
Author: darrenchan <email address hidden>
Date: Fri Dec 5 17:13:33 2014 +1100

    Linked Neutron overview content in the Installation Guide

    'xi:include parse' the neutron overview content in the OpenStack Networking section

    backport: Juno
    Closes-Bug: #1340524

    Change-Id: Ifaf92418552396c992764cb55696da30dd654853
    (cherry picked from commit 25c96dd7e552de26b80343066e5cc32a9f5fce50)

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/openstack-manuals 15.0.0 release.