Add ovsdbmonitor GUI tool by Andy Southgate, contributed by Citrix.
[sliver-openvswitch.git] / INSTALL.Linux
index 6529118..20a0dd8 100644 (file)
@@ -27,10 +27,6 @@ you will need the following software:
       connections from an Open vSwitch to an OpenFlow controller.  To
       enable, configure with --enable-ssl=yes.
 
-    - libpcre, the Perl Compatible Regular Expression library, is
-      optional but recommended.  Without it, OVSDB will not be able to
-      validate regular-expression based contraints.
-
 To compile the kernel module, you must also install the following.  If
 you cannot build or install the kernel module, you may use the
 userspace-only implementation, at a cost in performance.  The
@@ -65,7 +61,7 @@ If you are working from a Git tree or snapshot (instead of from a
 distribution tarball), or if you modify the Open vSwitch build system,
 you will also need the following software:
 
-    - Autoconf version 2.63 or later.
+    - Autoconf version 2.64 or later.
 
     - Automake version 1.10 or later.
 
@@ -73,6 +69,11 @@ you will also need the following software:
 
     - Python 2.x, for x >= 4.
 
+If you modify the ovsdbmonitor tool, then you will also need the
+following:
+
+    - pyuic4 from PyQt4 (http://www.riverbankcomputing.co.uk).
+
 Installation Requirements
 -------------------------
 
@@ -84,9 +85,6 @@ following software:
     - libssl compatible with the libssl used for build, if OpenSSL was
       used for the build.
 
-    - libpcre compatible with the libpcre used for build, if PCRE was
-      used for the build.
-
     - The Linux kernel version configured as part of the build.
 
     - For optional support of ingress policing, the "tc" program from
@@ -98,6 +96,22 @@ following software:
       if it is installed in a different location, then some Open
       vSwitch log messages will not be as detailed.
 
+To run the ovsdmonitor tool, the machine must also have the following
+software:
+
+    - Python 2.x, for x >= 4.
+
+    - Python Twisted Conch.
+
+    - Python JSON.
+
+    - PySide or PyQt4.
+
+    - Python Zope interface module.
+
+(On Debian "lenny" the above can be installed with "apt-get install
+python-json python-qt4 python-zopeinterface python-twisted-conch".)
+
 Building and Installing Open vSwitch for Linux
 ==============================================
 
@@ -162,23 +176,40 @@ Prerequisites section, follow the procedure below to build.
    To verify that the modules have been loaded, run "/sbin/lsmod" and
    check that openvswitch_mod is listed.
 
-Configuration
-=============
+7. Initialize the configuration database using ovsdb-tool, e.g.:
+
+      % ovsdb-tool create /usr/local/etc/ovs-vswitchd.conf.db vswitchd/vswitch.ovsschema
+
+Startup
+=======
+
+Before starting ovs-vswitchd itself, you need to start its
+configuration database, ovsdb-server.  Configure it to use the
+database you created during step 7 of installation, above, and to
+listen on a Unix domain socket, e.g.:
+
+      % ovsdb-server /usr/local/etc/ovs-vswitchd.conf.db --remote=punix:/usr/local/var/run/openvswitch/db.sock
+
+Then initialize the database with "ovs-vsctl init".  This is only
+necessary the first time after you create the database with
+ovsdb-tool (but running it at any time is harmless):
+
+      % ovs-vsctl init
+
+Then start the main Open vSwitch daemon, telling it to connect to the
+same Unix domain socket:
 
-Open vSwitch is configured primarily through a configuration file,
-whose name is specified on the ovs-vswitchd command line.  Please
-refer to ovs-vswitchd(8) and ovs-vswitchd.conf(5) for information on
-how to start ovs-vswitchd and the syntax of its configuration file,
-respectively.
+      % ovs-vswitchd unix:/usr/local/var/run/openvswitch/db.sock
 
-At runtime, you may make ovs-vswitchd reload its configuration file
-and update its configuration accordingly by sending it a SIGHUP
-signal.  The ovs-appctl utility can also be used to do this:
+Now you may use ovs-vsctl to set up bridges and other Open vSwitch
+features.  For example, to create a bridge named br0 and add ports
+eth0 and vif1.0 to it:
 
-    % ovs-appctl vswitchd/reload
+      % ovs-vsctl add-br br0
+      % ovs-vsctl add-port br0 eth0
+      % ovs-vsctl add-port br0 vif1.0
 
-In the latter case, ovs-appctl will wait for ovs-vswitchd to finish
-reloading before it exits.
+Please refer to ovs-vsctl(8) for more details.
 
 Bug Reporting
 -------------