From c278f4527c6aa62573f077730cd3829b168be141 Mon Sep 17 00:00:00 2001 From: Stephen Finucane Date: Sun, 30 Oct 2016 13:29:57 +0000 Subject: [PATCH] doc: Convert INSTALL.Libvirt to rST Signed-off-by: Stephen Finucane Signed-off-by: Russell Bryant --- INSTALL.Libvirt.md | 72 ----------------------------------- INSTALL.Libvirt.rst | 93 +++++++++++++++++++++++++++++++++++++++++++++ Makefile.am | 2 +- README.rst | 2 +- 4 files changed, 95 insertions(+), 74 deletions(-) delete mode 100644 INSTALL.Libvirt.md create mode 100644 INSTALL.Libvirt.rst diff --git a/INSTALL.Libvirt.md b/INSTALL.Libvirt.md deleted file mode 100644 index 3b36503a0..000000000 --- a/INSTALL.Libvirt.md +++ /dev/null @@ -1,72 +0,0 @@ -How to Use Open vSwitch with Libvirt -==================================== - -This document describes how to use Open vSwitch with Libvirt 0.9.11 or -later. This document assumes that you followed [INSTALL.rst] or installed -Open vSwitch from distribution packaging such as a .deb or .rpm. The Open -vSwitch support is included by default in Libvirt 0.9.11. Consult -www.libvirt.org for instructions on how to build the latest Libvirt, if your -Linux distribution by default comes with an older Libvirt release. - -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 the user has to manually create the bridge). - -Setup ------ - -First, create the Open vSwitch bridge by using the ovs-vsctl utility (this -must be done with administrative privileges): - - % ovs-vsctl add-br ovsbr - -Once that is done, create a VM, if necessary, and edit its Domain XML file: - - % virsh edit - -Lookup in the Domain XML file the `` section. There should be one -such XML section for each interface the VM has. - -``` - - - -
- -``` - -And change it to something like this: - -``` - - - - -
- - ``` - -The interface type must be set to "bridge". The `` XML element -specifies to which bridge this interface will be attached to. The -`` element indicates that the bridge in `` element is an -Open vSwitch bridge. - -Then (re)start the VM and verify if the guest's vnet interface is attached to -the ovsbr bridge. - - % ovs-vsctl show - -Troubleshooting ---------------- -If the VM does not want to start, then try to run the libvirtd process either -from the terminal, so that all errors are printed in console, or inspect -Libvirt/Open vSwitch log files for possible root cause. - -Bug Reporting -------------- - -Please report problems to bugs@openvswitch.org. - -[INSTALL.rst]:INSTALL.rst diff --git a/INSTALL.Libvirt.rst b/INSTALL.Libvirt.rst new file mode 100644 index 000000000..b32944cf8 --- /dev/null +++ b/INSTALL.Libvirt.rst @@ -0,0 +1,93 @@ +.. + 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. + +========================= +Open vSwitch with Libvirt +========================= + +This document describes how to use Open vSwitch with Libvirt 0.9.11 or later. +This document assumes that you followed the `general installation guide +`__ or installed Open vSwitch from distribution packaging such as +a .deb or .rpm. The Open vSwitch support is included by default in Libvirt +0.9.11. Consult www.libvirt.org for instructions on how to build the latest +Libvirt, if your Linux distribution by default comes with an older Libvirt +release. + +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 +the user has to manually create the bridge). + +Setup +----- + +First, create the Open vSwitch bridge by using the ovs-vsctl utility (this must +be done with administrative privileges):: + + $ ovs-vsctl add-br ovsbr + +Once that is done, create a VM, if necessary, and edit its Domain XML file:: + + $ virsh edit + +Lookup in the Domain XML file the ```` section. There should be one +such XML section for each interface the VM has:: + + + + +
+ + +And change it to something like this:: + + + + + +
+ + +The interface type must be set to ``bridge``. The ```` XML element +specifies to which bridge this interface will be attached to. The +```` element indicates that the bridge in ```` element is +an Open vSwitch bridge. + +Then (re)start the VM and verify if the guest's vnet interface is attached to +the ovsbr bridge:: + + $ ovs-vsctl show + +Troubleshooting +--------------- + +If the VM does not want to start, then try to run the libvirtd process either +from the terminal, so that all errors are printed in console, or inspect +Libvirt/Open vSwitch log files for possible root cause. + +Bug Reporting +------------- + +Report problems to bugs@openvswitch.org. diff --git a/Makefile.am b/Makefile.am index 3f3cd2164..15846d92b 100644 --- a/Makefile.am +++ b/Makefile.am @@ -78,7 +78,7 @@ docs = \ INSTALL.DPDK.rst \ INSTALL.Fedora.rst \ INSTALL.KVM.rst \ - INSTALL.Libvirt.md \ + INSTALL.Libvirt.rst \ INSTALL.NetBSD.md \ INSTALL.RHEL.md \ INSTALL.SELinux.md \ diff --git a/README.rst b/README.rst index c0a2ce476..979852b8f 100644 --- a/README.rst +++ b/README.rst @@ -90,7 +90,7 @@ To use Open vSwitch... - ...with KVM on Linux, see `here `__ and `here `__. -- ...with Libvirt, see `here `__. +- ...with Libvirt, see `here `__. - ...without using a kernel module, see `here `__. -- 2.39.2