[Openstack-docs] network plug-in options in install guide

Anne Gentle annegentle at justwriteclick.com
Mon Nov 4 23:03:22 UTC 2013


I think this is a good way to go, but I'd like to see most of the use cases
in the configuration reference with just one or two happy paths in the
install guide. This pattern would be more like the way pluggable cinder is
documented, I think.

Dan Wendlandt was looking for the Nicira plugin docs last wee, for example,
and Nermina's going to add them to the configuration reference.

I'd prefer simplicity in the install guide and deep dives in the
configuration reference, what do you think?

Anne


On Mon, Nov 4, 2013 at 1:50 PM, Solly Ross <sross at redhat.com> wrote:

> Having both ML2 and OVS documented sounds good to me.  Currently, I'm a
> bit busy tracking down and fixing a bug involving communication between
> Nova and Cinder, but if nobody else has written such a section by the time
> I have finished, I can take a shot at adding a path to the Neutron install
> guide for ML2.  The patch that you referenced seems to have targeted the
> use cases section only, and not the main "Installing Networking Services"
> section.
>
> As for the Use Case section, my suggestion would be to have each use case
> specify a particular path through the guide, so it would read like "Use
> Case: XYZ.  The XYZ use case covers the situation when you want to have the
> QPW XTZ the NPO.  In an XZY setup, all QPWs have LXYs.  In order to set up
> this use case, you should follow the main documentation, and choose to
> follow the OVS path with GRE networking and no namespaces."  In fact, we
> could generalize this to broader OpenStack "typical setup" use cases, and
> have each OpenStack "typical setup" have a particular path through the
> guide with a list of documentation "modules" to follow to get that setup
> (e.g. "Follow sections 1 (Basic Setup), 2 (Keystone), ..., 9 (Neutron, and
> choose the OVS plugin with GRE tunneling), and 10 (Orchestration)."  This
> way, if somebody goes up to the guide without having already figured out
> what they want, they'll have a couple suggested paths to follow.
>
> Best Regards,
> Solly Ross
>
> ----- Original Message -----
> From: "Andreas Jaeger" <aj at suse.com>
> To: openstack-docs at lists.openstack.org
> Cc: "Solly Ross" <sross at redhat.com>
> Sent: Monday, November 4, 2013 2:31:45 PM
> Subject: network plug-in options in install guide
>
> Looking at the guide, you see cross-references jumping to other sections.
>
> Solly said in https://bugs.launchpad.net/openstack-manuals/+bug/1244759 :
> "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."
>
> Right now only Open vSwitch is documented. Instead of replacing Open
> vSwitch with ML2 (see https://review.openstack.org/#/c/54644/), why not
> have both ML2 and Open vSwitch documented as two different options there?
>
> We still would need to decide what to use in the "Neutron deployment use
> cases"
> (
> http://docs.openstack.org/trunk/install-guide/install/zypper/content/neutron-deploy-use-cases.html
> )
> - but that whole content is IMHO so inconsistent with the rest that it
> needs a rewrite anyway.
>
> Andreas
> --
>  Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi
>   SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
>    GF: Jeff Hawn,Jennifer Guild,Felix Imendörffer,HRB16746 (AG Nürnberg)
>     GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126
>
> _______________________________________________
> Openstack-docs mailing list
> Openstack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>



-- 
Anne Gentle
annegentle at justwriteclick.com
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20131104/f92d09b3/attachment-0001.html>


More information about the Openstack-docs mailing list