[ovs-dev] [PATCH] documentation: Add INSTALL.Libvirt file

[Kyle Mestery (kmestery)]

On Apr 11, 2012, at 3:24 PM, Ansis Atteka wrote:

> 
> 
> On Tue, Apr 10, 2012 at 2:42 PM, Kyle Mestery (kmestery) <kmestery at cisco.com> wrote:
> Ansis:
> 
> Just some minor comments below, mostly grammatical, but one around recommend sudo for command usage. Looks great though, nice writeup!
> Thanks for review. Fixed grammar issues.
> 
> Thanks,
> Kyle
> 
> On Apr 10, 2012, at 4:32 PM, Ansis Atteka wrote:
> 
> > Add documentation on how to use OVS integration
> > with the upcoming Libvirt 0.9.11 release.
> >
> > Signed-off-by: Ansis Atteka <aatteka at nicira.com>
> > ---
> > INSTALL.Libvirt |   73 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
> > 1 files changed, 73 insertions(+), 0 deletions(-)
> > create mode 100644 INSTALL.Libvirt
> >
> > diff --git a/INSTALL.Libvirt b/INSTALL.Libvirt
> > new file mode 100644
> > index 0000000..61e474c
> > --- /dev/null
> > +++ b/INSTALL.Libvirt
> > @@ -0,0 +1,73 @@
> > +                 How to Use Open vSwitch with Libvirt
> > +                 ====================================
> > +
> > +This document describes how to use Open vSwitch with Libvirt 0.9.11 or
> > +later. The Open vSwitch support in libvirt 0.9.11 eliminates the need to
> > +use OVS Linux Bridge compatibility layer (brcompatd) and interface up/down
> > +scripts. This document assumes that you followed INSTALL.Linux to get Open
> > +vSwitch setup on your Linux system and have libvirt 0.9.11 or later
> > +installed. The Open vSwitch support is included by default in Libvirt.
> > +Consult www.libvirt.org for instructions on how to build the latest Libvirt.
> > +
> > +Limitations
> > +-----------
> > +Currently there is no Open vSwitch support for networks that are managed
> > +by libvirt (e.g. NAT). As of now only bridged networks are supported (those
> > +where user has to manually create the bridge).
> > +
> The above should be "where the user has to manually create the bridge."
>  
> 
> > +
> > +Setup
> > +-----
> > +
> > +First create the Open vSwitch bridge by using the ovs-vsctl utility:
> > +
> > + % ovs-vsctl add-br ovsbr
> > +
> For these "ovs-vsctl" commands, do you want to perhaps recommend putting "sudo" before them? As an example, most Fedora documentation I've seen includes sudo in examples. Just a thought.
> I am not sure about prefixing commands with "sudo", because that
> would imply a particular philosophy on how a regular user can execute
> commands with administrative privileges.
> 
> Perhaps a better approach would be to simply mention that command
> must be executed with administrative privileges?
> 
> For example, on Ubuntu the regular user belongs to sudoers, hence
> the sudo+command approach would work. But on Fedora the regular user
> is not in sudoers, hence the sudo+command would fail.
> 
I like the approach you mention here regarding mentioning the command requires administrative privileges. I think that is the right way to go, because it conveys the desired meaning without getting distribution specific.

> 
> 
> > +Once that is done, create a VM, if necessary, and edit its Domain XML file:
> > +
> > + % virsh edit <vm>
> > +
> > +Lookup in the Domain XML file the <interface> section. There should be one
> > +such XML section per each interface the VM has.
> > +
> > + ...
> > + <interface type='network'>
> > +  <mac address='52:54:00:71:b1:b6'/>
> > +  <source network='default'/>
> > +  <address type='pci' domain='0x0000' bus='0x00' slot='0x03' function='0x0'/>
> > + </interface>
> > + ...
> > +
> > +And change it to something like this:
> > +
> > + ...
> > + <interface type='bridge'>
> > +  <mac address='52:54:00:71:b1:b6'/>
> > +  <source bridge='ovsbr'/>
> > +  <virtualport type='openvswitch'>
> > +  </virtualport>
> > +  <address type='pci' domain='0x0000' bus='0x00' slot='0x03' function='0x0'/>
> > + </interface>
> > + ...
> > +
> > +The interface type must be set to "bridge". The <source> XML element
> > +specifies to which bridge this interface will be attached to. The
> > +<virtualport> element indicates that bridge in <source> element is an
> > +Open vSwitch bridge.
> > +
> > +Then (re)start the VM and verify if guest's vnet interface is attached to
> 
> Change to "verify if the guest's vnet interface is attached to".
> 
> > +the ovsbr bridge.
> > +
> > + % ovs-vsctl show
> > +
> > +Troubleshooting
> > +---------------
> > +
> > +If VM does not want to start, then try to run libvirtd process either
> 
> Change to "If the VM does not want to start, then try to run the libvirtd process either"
> 
> > +from the terminal or inspect Libvirt/Open vSwitch log files for possible
> > +root cause.
> > +
> > +Bug Reporting
> > +-------------
> > +
> > +Please report problems to bugs at openvswitch.org.
> > --
> > 1.7.9.1
> >
> > _______________________________________________
> > dev mailing list
> > dev at openvswitch.org
> > http://openvswitch.org/mailman/listinfo/dev
> 
>