Add an "Installing from Packages" section to fedora.rst with dnf install commands for ovn-central, ovn-host, ovn, and ovn-vtep, along with a note about EPEL for RHEL/CentOS Stream users.
Rewrite the "Building RPM Packages from Source" section to align with the actual build process in rhel/automake.mk and rhel/ovn-fedora.spec.in: the OVS submodule must be built first and its tarball generated with make dist before running make rpm-fedora. Add the ovn-br-controller package to the list. Fix formatting inconsistencies in the package list. Remove distributions.rst since its content is now covered by the install-from-packages sections in both debian.rst and fedora.rst. The old OpenSuSE section is intentionally dropped as its content was outdated and incomplete. Update index.rst toctree and automake.mk accordingly. Assisted-by: Claude Opus 4.6, OpenCode Signed-off-by: Ales Musil <[email protected]> --- Documentation/automake.mk | 1 - Documentation/intro/install/distributions.rst | 52 -------- Documentation/intro/install/fedora.rst | 126 +++++++++--------- Documentation/intro/install/index.rst | 1 - 4 files changed, 65 insertions(+), 115 deletions(-) delete mode 100644 Documentation/intro/install/distributions.rst diff --git a/Documentation/automake.mk b/Documentation/automake.mk index 59036b4bc..aa286ebd9 100644 --- a/Documentation/automake.mk +++ b/Documentation/automake.mk @@ -8,7 +8,6 @@ DOC_SOURCE = \ Documentation/intro/install/index.rst \ Documentation/intro/install/debian.rst \ Documentation/intro/install/documentation.rst \ - Documentation/intro/install/distributions.rst \ Documentation/intro/install/fedora.rst \ Documentation/intro/install/general.rst \ Documentation/intro/install/ovn-upgrades.rst \ diff --git a/Documentation/intro/install/distributions.rst b/Documentation/intro/install/distributions.rst deleted file mode 100644 index 142f96876..000000000 --- a/Documentation/intro/install/distributions.rst +++ /dev/null @@ -1,52 +0,0 @@ -.. - 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 OVN 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. - -================================================== -Distributions packaging Open Virtual Network (OVN) -================================================== - -This document lists various popular distributions packaging OVN. - -.. note:: - The packaged version available with distributions may not be latest - OVN release. - -Debian -------- - -You can use ``apt-get`` or ``aptitude`` to install the .deb packages and must -be superuser. Debian has ``ovn-common``, ``ovn-host``, ``ovn-central`` and -``ovn-vtep`` .deb packages. - -Fedora ------- - -Fedora provides ``ovn``, ``ovn-host``, ``ovn-central`` -and ``ovn-vtep`` rpm packages. Use ``yum`` or ``dnf`` to install -the rpm packages and must be superuser. - -OpenSuSE --------- - -OpenSUSE provides ``openvswitch-ovn-common``, ```openvswitch-ovn-host``, -```openvswitch-ovn-central`` and ```openvswitch-ovn-vtep`` rpm packages. diff --git a/Documentation/intro/install/fedora.rst b/Documentation/intro/install/fedora.rst index 1924fa0a9..b1d2ea5df 100644 --- a/Documentation/intro/install/fedora.rst +++ b/Documentation/intro/install/fedora.rst @@ -25,110 +25,114 @@ Fedora, RHEL 8.x+ Packaging for OVN ====================================== -This document provides instructions for building and installing OVN -RPM packages on a Fedora Linux host. Instructions for the installation of OVN -on a Fedora Linux host without using RPM packages can be found in the +This document provides instructions for installing OVN on Fedora, +RHEL 8.x and later, and CentOS Stream, either from distribution +packages or by building RPM packages from source. Instructions for +installing OVN from source without packaging can be found in the :doc:`general`. -These instructions are applicable for Fedora, RHEL 8.x and later, and -CentOS Stream. +Installing from Packages +------------------------- -Build Requirements ------------------- +Fedora provides ``ovn``, ``ovn-central``, ``ovn-host``, +``ovn-vtep``, and ``ovn-br-controller`` RPM packages. Use ``dnf`` +to install them as superuser. -You will need to install all required packages to build the RPMs. -Newer distributions use ``dnf`` but if it's not available, then use -``yum`` instructions. +For a central node (runs OVN databases and ovn-northd):: -The command below will install RPM tools and generic build dependencies. -And (optionally) include these packages: libcap-ng libcap-ng-devel. + $ sudo dnf install ovn-central -DNF: -:: +For each host/hypervisor (runs ovn-controller):: - $ dnf install @'Development Tools' rpm-build dnf-plugins-core + $ sudo dnf install ovn-host -YUM: -:: +Additional packages:: - $ yum install @'Development Tools' rpm-build yum-utils + $ sudo dnf install ovn # shared components + $ sudo dnf install ovn-vtep # VTEP gateway support + $ sudo dnf install ovn-br-controller # bridge controller -Then it is necessary to install OVN specific build dependencies. -The dependencies are listed in the SPEC file, but first it is necessary -to replace the VERSION tag to be a valid SPEC. +For RHEL and CentOS Stream, the OVN packages may be available through +EPEL or the distribution's own repositories. -The command below will create a temporary SPEC file:: +.. note:: + The packaged version available in distributions may not be the latest + OVN release. - $ sed -e 's/@VERSION@/0.0.1/' rhel/ovn-fedora.spec.in \ - > /tmp/ovn.spec +Building RPM Packages from Source +--------------------------------- + +Build Requirements +~~~~~~~~~~~~~~~~~~ + +Install RPM tools and generic build dependencies:: -And to install specific dependencies, use the corresponding tool below. -For some of the dependencies on RHEL you may need to add two additional -repositories to help yum-builddep, e.g.:: + $ sudo dnf install @'Development Tools' rpm-build dnf-plugins-core - $ subscription-manager repos --enable=rhel-7-server-extras-rpms - $ subscription-manager repos --enable=rhel-7-server-optional-rpms +Then install OVN-specific build dependencies. The dependencies are +listed in the SPEC file, but first it is necessary to replace the +VERSION tag to be a valid SPEC. -DNF:: +The command below will create a temporary SPEC file:: - $ dnf builddep /tmp/ovn.spec + $ sed -e 's/@VERSION@/0.0.1/' rhel/ovn-fedora.spec.in \ + > /tmp/ovn.spec -YUM:: +And to install the specific dependencies:: - $ yum-builddep /tmp/ovn.spec + $ sudo dnf builddep /tmp/ovn.spec Once that is completed, remove the file ``/tmp/ovn.spec``. -Bootstraping ------------- +Bootstrapping +~~~~~~~~~~~~~ Refer to :ref:`general-bootstrapping`. Configuring ------------ +~~~~~~~~~~~ Refer to :ref:`general-configuring`. Building --------- +~~~~~~~~ -OVN RPMs -~~~~~~~~~~~~~~~ +To build OVN RPMs, first generate the OVS source tarball in the OVS +source directory (the OVS submodule must be built first, as described +in :ref:`general-bootstrapping`):: -To build OVN RPMs, first generate openvswitch source tarball in -your openvwitch source directory by running + $ make -C ovs dist -:: - - $make dist - -And then execute the following in the OVN source directory -(in which `./configure` was executed): - -:: +Then execute the following from the OVN source directory (in which +``./configure`` was executed):: $ make rpm-fedora -This will create the RPMs `ovn`, `ovn-central`, `ovn-host`, `ovn-vtep`, -`ovn-docker`, ``ovn-debuginfo``, ``ovn-central-debuginfo``, -``ovn-host-debuginfo`` and ```ovn-vtep-debuginfo```. - +This will create the RPMs ``ovn``, ``ovn-central``, ``ovn-host``, +``ovn-vtep``, ``ovn-docker``, and ``ovn-br-controller``, along with +their debuginfo variants. You can also have the above commands automatically run the OVN unit -tests. This can take several minutes. - -:: +tests. This can take several minutes:: $ make rpm-fedora RPMBUILD_OPT="--with check" - Installing ----------- +~~~~~~~~~~ + +RPM packages can be installed by using the command ``rpm -i``. +Package installation requires superuser privileges:: + + $ sudo rpm -i ovn-*.rpm + +Or install specific packages:: -RPM packages can be installed by using the command ``rpm -i``. Package -installation requires superuser privileges. + $ sudo rpm -i ovn-<version>.rpm # shared components + $ sudo rpm -i ovn-central-<version>.rpm # on central node + $ sudo rpm -i ovn-host-<version>.rpm # on each host Reporting Bugs -------------- -Report problems to [email protected]. +Report problems to https://github.com/ovn-org/ovn/issues or [email protected]. diff --git a/Documentation/intro/install/index.rst b/Documentation/intro/install/index.rst index b94a1e1b4..2093cbbfa 100644 --- a/Documentation/intro/install/index.rst +++ b/Documentation/intro/install/index.rst @@ -52,7 +52,6 @@ provided below. .. toctree:: :maxdepth: 2 - distributions debian fedora -- 2.54.0 _______________________________________________ dev mailing list [email protected] https://mail.openvswitch.org/mailman/listinfo/ovs-dev
