INSTALL.Fedora.rst

   1 ..
   2       Licensed under the Apache License, Version 2.0 (the "License"); you may
   3       not use this file except in compliance with the License. You may obtain
   4       a copy of the License at
   5
   6           http://www.apache.org/licenses/LICENSE-2.0
   7
   8       Unless required by applicable law or agreed to in writing, software
   9       distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  10       WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  11       License for the specific language governing permissions and limitations
  12       under the License.
  13
  14       Convention for heading levels in Open vSwitch documentation:
  15
  16       =======  Heading 0 (reserved for the title in a document)
  17       -------  Heading 1
  18       ~~~~~~~  Heading 2
  19       +++++++  Heading 3
  20       '''''''  Heading 4
  21
  22       Avoid deeper levels because they do not render well.
  23
  24 ============================
  25 Open vSwitch on Fedora Linux
  26 ============================
  27
  28 This document provides instructions for building and installing Open vSwitch
  29 RPM packages on a Fedora Linux host. Instructions for the installation of Open
  30 vSwitch on a Fedora Linux host without using RPM packages can be found in the
  31 `general installation guide <INSTALL.rst>`__.
  32
  33 These instructions have been tested with Fedora 23, and are also applicable for
  34 RHEL 7.x and its derivatives, including CentOS 7.x and Scientific Linux 7.x.
  35
  36 Build Requirements
  37 ------------------
  38
  39 To build packages for a Fedora Linux host, you will need the packages described
  40 in the `general installation guide <INSTALL.rst>`__. Specific packages (by
  41 package name) include:
  42
  43 - rpm-build
  44 - autoconf automake libtool
  45 - systemd-units openssl openssl-devel
  46 - python python-twisted-core python-zope-interface python-six
  47 - desktop-file-utils
  48 - groff graphviz
  49 - procps-ng
  50
  51 And (optionally):
  52
  53 - libcap-ng libcap-ng-devel
  54 - dpdk-devel
  55
  56 Bootstraping
  57 ------------
  58
  59 Refer to the *Bootstrapping* section of the `general installation guide
  60 <INSTALL.rst>`__.
  61
  62 Configuring
  63 -----------
  64
  65 Refer to the *Configuring* section of the `general installation guide
  66 <INSTALL.rst>`__.
  67
  68 Building
  69 --------
  70
  71 User Space RPMs
  72 ~~~~~~~~~~~~~~~
  73
  74 To build Open vSwitch user-space RPMs, execute the following from the directory
  75 in which `./configure` was executed:
  76
  77 ::
  78
  79     $ make rpm-fedora
  80
  81 This will create the RPMs `openvswitch`, `python-openvswitch`,
  82 `openvswitch-test`, `openvswitch-devel`, `openvswitch-ovn-common`,
  83 `openvswitch-ovn-central`, `openvswitch-ovn-host`, `openvswitch-ovn-vtep`,
  84 `openvswitch-ovn-docker`, and `openvswitch-debuginfo`.
  85
  86 To enable DPDK support in the openvswitch package, the ``--with dpdk`` option
  87 can be added:
  88
  89 ::
  90
  91     $ make rpm-fedora RPMBUILD_OPT="--with dpdk"
  92
  93 The above commands automatically run the Open vSwitch unit tests, which can
  94 take several minutes.  To reduce the build time by disabling the execution of
  95 these tests, the ``--without check`` option can be added:
  96
  97 ::
  98
  99     $ make rpm-fedora RPMBUILD_OPT="--without check"
 100
 101 Kernel OVS Tree Datapath RPM
 102 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 103
 104 To build the Open vSwitch kernel module for the currently running kernel
 105 version, run:
 106
 107 ::
 108
 109     $ make rpm-fedora-kmod
 110
 111 To build the Open vSwitch kernel module for another kernel version, the desired
 112 kernel version can be specified via the `kversion` macro.  For example:
 113
 114 ::
 115
 116     $ make rpm-fedora-kmod \
 117          RPMBUILD_OPT='-D "kversion 4.3.4-300.fc23.x86_64"'
 118
 119 Installing
 120 ----------
 121
 122 RPM packages can be installed by using the command ``rpm -i``. Package
 123 installation requires superuser privileges.
 124
 125 The `openvswitch-kmod` RPM should be installed first if the Linux OVS tree
 126 datapath module is to be used. The `openvswitch-kmod` RPM should not be
 127 installed if only the in-tree Linux datapath or user-space datapath is needed.
 128 See the `FAQ document <FAQ.rst>`__ for more information about the various Open
 129 vSwitch datapath options.
 130
 131 In most cases only the `openvswitch` RPM will need to be installed. The
 132 `python-openvswitch`, `openvswitch-test`, `openvswitch-devel`, and
 133 `openvswitch-debuginfo` RPMs are optional unless required for a specific
 134 purpose.
 135
 136 The `openvswitch-ovn-*` packages are only needed when using OVN.
 137
 138 Refer to the `RHEL README <rhel/README.RHEL.rst>`__ for additional usage and
 139 configuration information.
 140
 141 Reporting Bugs
 142 --------------
 143
 144 Report problems to bugs@openvswitch.org.