Several sections in the installation documentation were copied from the Open vSwitch install guide when OVN was split from OVS in 2020 and were never updated.
Remove the ovs-dev.py reference which is an OVS development tool not relevant to OVN. Remove TAP/tun device requirements that apply to OVS userspace datapath, not OVN. Remove the Linux kernel module build instructions (--with-linux and EXTRA_CFLAGS) since OVN does not ship a kernel module. Fix "Open vSwitch user programs" and "compiling OVS" to correctly say "OVN" in the context of OVN configure options. Clarify the jemalloc note to reference OVN components. Clarify the ovs-lib dependency to explain it is provided by the Open vSwitch installation. Update bug reporting from the old [email protected] to the OVN GitHub issue tracker and [email protected]. Fix "convert OVS schema" to "convert the schema" in ovn-upgrades.rst. Assisted-by: Claude Opus 4.6, OpenCode Signed-off-by: Ales Musil <[email protected]> --- Documentation/intro/install/general.rst | 42 ++++++-------------- Documentation/intro/install/ovn-upgrades.rst | 4 +- 2 files changed, 14 insertions(+), 32 deletions(-) diff --git a/Documentation/intro/install/general.rst b/Documentation/intro/install/general.rst index aa09d5d96..6745803a1 100644 --- a/Documentation/intro/install/general.rst +++ b/Documentation/intro/install/general.rst @@ -134,8 +134,6 @@ following to obtain better warnings: - flake8 (for Python code) -You may find the ovs-dev script found in ``ovs/utilities/ovs-dev.py`` useful. - .. _general-install-reqs: Installation Requirements @@ -146,8 +144,7 @@ To simply install and run OVN you require the following software: - Shared libraries compatible with those used for the build. -On Linux you should ensure that ``/dev/urandom`` exists. To support TAP -devices, you must also ensure that ``/dev/net/tun`` exists. +On Linux you should ensure that ``/dev/urandom`` exists. .. _general-bootstrapping: @@ -213,7 +210,7 @@ shared libraries instead:: $ ./configure --enable-shared -To use a specific C compiler for compiling Open vSwitch user programs, also +To use a specific C compiler for compiling OVN user programs, also specify it on the configure command line, like so:: $ ./configure CC=gcc-4.2 @@ -248,16 +245,9 @@ recommended to use ``-march=native`` settings:: $ ./configure CFLAGS="-g -O2 -march=native" With this, GCC will detect the processor and automatically set appropriate -flags for it. This should not be used if you are compiling OVS outside the +flags for it. This should not be used if you are compiling OVN outside the target machine. -.. note:: - CFLAGS are not applied when building the Linux kernel module. Custom CFLAGS - for the kernel module are supplied using the ``EXTRA_CFLAGS`` variable when - running make. For example:: - - $ make EXTRA_CFLAGS="-Wno-error=date-time" - If you are a developer and want to enable Address Sanitizer for debugging purposes, at about a 2x runtime cost, you can add ``-fsanitize=address -fno-omit-frame-pointer -fno-common`` to CFLAGS. For @@ -265,17 +255,6 @@ example:: $ ./configure CFLAGS="-g -O2 -fsanitize=address -fno-omit-frame-pointer -fno-common" -To build the Linux kernel module, so that you can run the kernel-based switch, -pass the location of the kernel build directory on ``--with-linux``. For -example, to build for a running instance of Linux:: - - $ ./configure --with-linux=/lib/modules/$(uname -r)/build - -.. note:: - If ``--with-linux`` requests building for an unsupported version of Linux, - then ``configure`` will fail with an error message. Refer to the - :doc:`/faq/index` for advice in that case. - If you plan to do much OVN development, you might want to add ``--enable-Werror``, which adds the ``-Werror`` option to the compiler command line, turning warnings into errors. That makes it impossible to miss warnings @@ -307,9 +286,10 @@ directory, e.g. to try out both GCC and Clang builds. For example:: $ mkdir _gcc && (cd _gcc && ./configure CC=gcc) $ mkdir _clang && (cd _clang && ./configure CC=clang) -Under certain loads the ovsdb-server and other components perform better when -using the jemalloc memory allocator, instead of the glibc memory allocator. If -you wish to link with jemalloc add it to LIBS:: +Under certain loads the OVN database servers and other components +perform better when using the jemalloc memory allocator, instead of +the glibc memory allocator. If you wish to link with jemalloc add it +to LIBS:: $ ./configure LIBS=-ljemalloc @@ -376,8 +356,9 @@ the daemons can be started by using the ovn-ctl utility. This will take care to setup initial conditions, and start the daemons in the correct order. The ovn-ctl utility is located in '$(pkgdatadir)/scripts', and defaults to '/usr/local/share/ovn/scripts'. ovn-ctl utility requires the 'ovs-lib' -helper shell script which is present in '/usr/local/share/openvswitch/scripts'. -So invoking ovn-ctl as "./ovn-ctl" will fail. +helper shell script provided by Open vSwitch, which is typically present in +'/usr/local/share/openvswitch/scripts'. So invoking ovn-ctl as +"./ovn-ctl" will fail unless Open vSwitch is properly installed. An example after install might be:: @@ -611,4 +592,5 @@ When using ovn in container, exec to container to run above commands:: 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/ovn-upgrades.rst b/Documentation/intro/install/ovn-upgrades.rst index e4be8e9f4..c27b7f50e 100644 --- a/Documentation/intro/install/ovn-upgrades.rst +++ b/Documentation/intro/install/ovn-upgrades.rst @@ -197,8 +197,8 @@ of known impactible schema changes and how to fix when error encountered. #. Release 22.12: index [transit_switch, availability_zone, route_table, ip_prefix, nexthop] added for OVN Interconnection Southbound DB table Route. - If there are duplicated records in this table, users are adviced to upgrade - ovn-ic daemons in all availability zones first and after that convert OVS + If there are duplicated records in this table, users are advised to upgrade + ovn-ic daemons in all availability zones first and after that convert the schema (restart ovn-ic database daemon). #. Release 2.11 and earlier: The availability_zone name is added to the -- 2.54.0 _______________________________________________ dev mailing list [email protected] https://mail.openvswitch.org/mailman/listinfo/ovs-dev
