On Wed, Nov 08, 2017 at 09:44:53PM +0000, Mark Michelson wrote:
> Hi Ben, I gave this another read and found a couple of small issues. I
> think once those are cleared up, I'll be ready to ack this.
>
> On Tue, Nov 7, 2017 at 8:50 PM Ben Pfaff <[email protected]> wrote:
>
> > This is adapted from a talk I gave at OpenStack Summit Sydney on Nov. 6.
> >
> > Signed-off-by: Ben Pfaff <[email protected]>
> > ---
> > v1->v2: Replace overview of OVN with reference to ovn-architecture(7).
> > (Thanks Mark.)
> >
> > Documentation/automake.mk | 1 +
> > Documentation/topics/index.rst | 1 +
> > Documentation/topics/ovn-news-2.8.rst | 281
> > ++++++++++++++++++++++++++++++++++
> > 3 files changed, 283 insertions(+)
> > create mode 100644 Documentation/topics/ovn-news-2.8.rst
> >
> > diff --git a/Documentation/automake.mk b/Documentation/automake.mk
> > index 733da3ca9da1..3ea2c2cb5fe0 100644
> > --- a/Documentation/automake.mk
> > +++ b/Documentation/automake.mk
> > @@ -40,6 +40,7 @@ DOC_SOURCE = \
> > Documentation/topics/integration.rst \
> > Documentation/topics/language-bindings.rst \
> > Documentation/topics/openflow.rst \
> > + Documentation/topics/ovn-news-2.8.rst \
> > Documentation/topics/ovsdb-replication.rst \
> > Documentation/topics/porting.rst \
> > Documentation/topics/role-based-access-control.rst \
> > diff --git a/Documentation/topics/index.rst
> > b/Documentation/topics/index.rst
> > index 00d6b0b837ec..13b6d8abbb30 100644
> > --- a/Documentation/topics/index.rst
> > +++ b/Documentation/topics/index.rst
> > @@ -58,6 +58,7 @@ OVN
> >
> > high-availability
> > role-based-access-control
> > + ovn-news-2.8
> >
> > .. list-table::
> >
> > diff --git a/Documentation/topics/ovn-news-2.8.rst
> > b/Documentation/topics/ovn-news-2.8.rst
> > new file mode 100644
> > index 000000000000..173d500ae3b7
> > --- /dev/null
> > +++ b/Documentation/topics/ovn-news-2.8.rst
> > @@ -0,0 +1,281 @@
> > +..
> > + Licensed under the Apache License, Version 2.0 (the "License"); you
> > may
> > + not use this file except in compliance with the License. You may
> > obtain
> > + a copy of the License at
> > +
> > + http://www.apache.org/licenses/LICENSE-2.0
> > +
> > + Unless required by applicable law or agreed to in writing, software
> > + distributed under the License is distributed on an "AS IS" BASIS,
> > WITHOUT
> > + WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
> > See the
> > + License for the specific language governing permissions and
> > limitations
> > + under the License.
> > +
> > + Convention for heading levels in Open vSwitch documentation:
> > +
> > + ======= Heading 0 (reserved for the title in a document)
> > + ------- Heading 1
> > + ~~~~~~~ Heading 2
> > + +++++++ Heading 3
> > + ''''''' Heading 4
> > +
> > + Avoid deeper levels because they do not render well.
> > +
> > +===============================
> > +What's New with OVS and OVN 2.8
> > +===============================
> > +
> > +This document is about what was added in Open vSwitch 2.8, which was
> > released
> > +at the end of August 2017, concentrating on the new features in OVN. It
> > also
> > +covers some of what is coming up in Open vSwitch and OVN 2.9, which is
> > due to
> > +be released in February 2018. OVN has many features, and this document
> > does
> > +not cover every new or enhanced feature (but contributions are welcome).
> > +
> > +This document assumes a basic familiarity with Open vSwitch, OVN, and
> > their
> > +associated tools. For more information, please refer to the Open vSwitch
> > and
> > +OVN documentation, such as the ``ovn-architecture``\(7) manpage.
> >
>
> Hm, the left parenthesis is backslash-escaped but the right is not. Is that
> a quirk of restructured text or should both be escaped?
I think that's a quirk of restructured text. I am imitating the style I
see elsewhere in the tree. It looks like the formatted version comes
out looking correct.
> > +Connections Between Levels
> > +~~~~~~~~~~~~~~~~~~~~~~~~~~
> > +
> > +OVN and Open vSwitch work almost like a stack of compilers: Neutron
> > +configuration is translated to OVN northbound configuration, which the OVN
> > +Neutron plugin translates to OVN southbound logical flows, which
> > ``ovn-northd``
> > +translates to OpenFlow flows, which Open vSwitch translates to datapath
> > flows.
> >
>
> The actors in this sentence are off. ovn-northd translates the northbound
> configuration into southbound logical flows, and then ovn-controller
> translates those into openflow flows.
Oh, that's weird. Thanks, I rewrote it.
> > +OVN has built-in support for DHCPv4 and DHCPv6. OVN 2.8 adds small
> > +refinements.
> >
>
> It would be good to briefly state what these small refinements are. Or if
> they're so small that they don't warrant calling out specifically in this
> document, then you can delete this paragraph altogether.
I decided to just delete it.
I posted v3 (although I goofed and marked it as v2 again in the subject):
https://patchwork.ozlabs.org/patch/836523/
Thanks!
Ben
_______________________________________________
dev mailing list
[email protected]
https://mail.openvswitch.org/mailman/listinfo/ovs-dev
