From patchwork Thu Jul 14 21:23:31 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Gregory Rose X-Patchwork-Id: 1656659 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: bilbo.ozlabs.org; dkim=fail reason="signature verification failed" (2048-bit key; unprotected) header.d=gmail.com header.i=@gmail.com header.a=rsa-sha256 header.s=20210112 header.b=owx6yF50; dkim-atps=neutral Authentication-Results: ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=openvswitch.org (client-ip=140.211.166.138; helo=smtp1.osuosl.org; envelope-from=ovs-dev-bounces@openvswitch.org; receiver=) Received: from smtp1.osuosl.org (smtp1.osuosl.org [140.211.166.138]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by bilbo.ozlabs.org (Postfix) with ESMTPS id 4LkSCv49srz9s09 for ; Fri, 15 Jul 2022 07:23:55 +1000 (AEST) Received: from localhost (localhost [127.0.0.1]) by smtp1.osuosl.org (Postfix) with ESMTP id 59EC784DB8; Thu, 14 Jul 2022 21:23:53 +0000 (UTC) DKIM-Filter: OpenDKIM Filter v2.11.0 smtp1.osuosl.org 59EC784DB8 Authentication-Results: smtp1.osuosl.org; dkim=fail reason="signature verification failed" (2048-bit key) header.d=gmail.com header.i=@gmail.com header.a=rsa-sha256 header.s=20210112 header.b=owx6yF50 X-Virus-Scanned: amavisd-new at osuosl.org Received: from smtp1.osuosl.org ([127.0.0.1]) by localhost (smtp1.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id 10cySS0NxiID; Thu, 14 Jul 2022 21:23:51 +0000 (UTC) Received: from lists.linuxfoundation.org (lf-lists.osuosl.org [140.211.9.56]) by smtp1.osuosl.org (Postfix) with ESMTPS id 2F7A184DA0; Thu, 14 Jul 2022 21:23:49 +0000 (UTC) DKIM-Filter: OpenDKIM Filter v2.11.0 smtp1.osuosl.org 2F7A184DA0 Received: from lf-lists.osuosl.org (localhost [127.0.0.1]) by lists.linuxfoundation.org (Postfix) with ESMTP id EFD7EC0035; Thu, 14 Jul 2022 21:23:48 +0000 (UTC) X-Original-To: dev@openvswitch.org Delivered-To: ovs-dev@lists.linuxfoundation.org Received: from smtp3.osuosl.org (smtp3.osuosl.org [140.211.166.136]) by lists.linuxfoundation.org (Postfix) with ESMTP id 1F594C0071 for ; Thu, 14 Jul 2022 21:23:47 +0000 (UTC) Received: from localhost (localhost [127.0.0.1]) by smtp3.osuosl.org (Postfix) with ESMTP id 7403D61077 for ; Thu, 14 Jul 2022 21:23:46 +0000 (UTC) DKIM-Filter: OpenDKIM Filter v2.11.0 smtp3.osuosl.org 7403D61077 Authentication-Results: smtp3.osuosl.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.a=rsa-sha256 header.s=20210112 header.b=owx6yF50 X-Virus-Scanned: amavisd-new at osuosl.org Received: from smtp3.osuosl.org ([127.0.0.1]) by localhost (smtp3.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id HLo6ssRNfKsw for ; Thu, 14 Jul 2022 21:23:45 +0000 (UTC) X-Greylist: whitelisted by SQLgrey-1.8.0 DKIM-Filter: OpenDKIM Filter v2.11.0 smtp3.osuosl.org 1033D61094 Received: from mail-qt1-x82f.google.com (mail-qt1-x82f.google.com [IPv6:2607:f8b0:4864:20::82f]) by smtp3.osuosl.org (Postfix) with ESMTPS id 1033D61094 for ; Thu, 14 Jul 2022 21:23:44 +0000 (UTC) Received: by mail-qt1-x82f.google.com with SMTP id h22so2499367qta.3 for ; Thu, 14 Jul 2022 14:23:44 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=CJwZmbKGkU8glvAr3P0F6Fb7bB+gN3gIsd50FNuQY1U=; b=owx6yF509K624C09M62se/HI77GvncH5fQ+7uy7Kr/v0lZZeatLaenMFe5mMbsC6Te VJ2Dhxl1LUC5sDbVBtRcW2pkNWBKJaOeKJg52ZmHaFQY6ajumUi74SDwqHPeCMp4ngEa 4DulQrOB/URZkkXg2l1HTLjA2VmlL9Ztjf1J5k2Gifs4KzpiNc9pOQalViO5Yvx6WD4n AhKIZDsctrfBpXa/+POG1cUAQQDvg7OJ3XXb3p0rCxuX1mddAueRXz3QDdxD/LihWY5z PSGwtnLgHc4Dlc1Ycp9nzUpQSoXe/QaL2ohSBX6AiyhIj0/tv0NAy5+dRpcoSW2nOf/z px6Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=CJwZmbKGkU8glvAr3P0F6Fb7bB+gN3gIsd50FNuQY1U=; b=dkAqHymP0223GLooj3PKupY1DveIuJ/03heFOrh7CidvVFlBZBNcqROkSlZcLKOuZQ Ceu0W0q9imRd6NOVU9mp0yajMp4/ubh6r5E+tVKkXiCdXS1U2U+l9GyeX1uqOHEVJNkz 9gdfM3mzbSeMC6vqtg4HrPYD8EsGFpibHvqrEry7CIG0HUEGwSZ7q60WbRafsdFhukXM nr3zMJNcSGqeHwpW9a/+jua7VelpUG3gr7YNaWyzvCKcnSRndNYyYXSfILacqUqPM/AZ FEx31BiBpMk7jzcsKOokjlYS0+cMMSp0OkINh/6w1ZgFkeWjvYOiEPGEch6B+c6ChYsK rB/A== X-Gm-Message-State: AJIora8KqSNKXAIXKhxY0ohUHTp1jwHz5ZynvoFaqYP9b1wd0vSkk1c7 gsCpnC+zb51Z6o9iWPxAUnE5MgJiaLU= X-Google-Smtp-Source: AGRyM1uIbyLOU4ZbWIAGR9jK6Fbfa0kALnRsvyFVQa4++7Tja3HdFEybN8igpD4lvxpsY5n+XhhNIQ== X-Received: by 2002:a05:622a:120d:b0:31e:9c06:7a27 with SMTP id y13-20020a05622a120d00b0031e9c067a27mr9975255qtx.316.1657833823671; Thu, 14 Jul 2022 14:23:43 -0700 (PDT) Received: from VMware-box.domain ([97.115.145.232]) by smtp.googlemail.com with ESMTPSA id z12-20020ac87f8c000000b0031bf5677d96sm2374945qtj.84.2022.07.14.14.23.43 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 14 Jul 2022 14:23:43 -0700 (PDT) From: Greg Rose To: dev@openvswitch.org Date: Thu, 14 Jul 2022 14:23:31 -0700 Message-Id: <20220714212331.24848-7-gvrose8192@gmail.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20220714212331.24848-1-gvrose8192@gmail.com> References: <20220714212331.24848-1-gvrose8192@gmail.com> Subject: [ovs-dev] [PATCH V6 6/6] Documentation: Remove kernel module documentation. X-BeenThere: ovs-dev@openvswitch.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: ovs-dev-bounces@openvswitch.org Sender: "dev" As of Open vSwitch release 2.18 the OVS kernel module is no longer supported. Pull the documentation references. Reviewed-by: David Marchand Signed-off-by: Greg Rose --- Documentation/faq/releases.rst | 4 +- .../contributing/backporting-patches.rst | 7 +++ Documentation/intro/install/fedora.rst | 24 ------- Documentation/intro/install/general.rst | 63 ------------------- 4 files changed, 10 insertions(+), 88 deletions(-) diff --git a/Documentation/faq/releases.rst b/Documentation/faq/releases.rst index 8cfe2d392..bf2f3438c 100644 --- a/Documentation/faq/releases.rst +++ b/Documentation/faq/releases.rst @@ -75,6 +75,7 @@ Q: What Linux kernel versions does each Open vSwitch release work with? 2.15.x 3.16 to 5.8 2.16.x 3.16 to 5.8 2.17.x 3.16 to 5.8 + 2.18.x N/A ============ ============== Open vSwitch userspace should also work with the Linux kernel module built @@ -110,7 +111,8 @@ Q: Are all features available with all datapaths? Linux OVS tree The datapath implemented by the Linux kernel module distributed with the OVS source tree. This datapath is deprecated starting with OVS - 2.15.x and support capped at Linux kernel version 5.8. + 2.15.x and support capped at Linux kernel version 5.8. As of OVS 2.18.x + the Linux OVS tree is no longer supported. Userspace This datapath supports conventional system devices as well as diff --git a/Documentation/internals/contributing/backporting-patches.rst b/Documentation/internals/contributing/backporting-patches.rst index 162e9d209..d0a58f8de 100644 --- a/Documentation/internals/contributing/backporting-patches.rst +++ b/Documentation/internals/contributing/backporting-patches.rst @@ -119,6 +119,13 @@ userspace changes. How to backport kernel patches ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +These instructions only apply to Open vSwitch releases 2.17 and older. +As of Open vSwitch branch 2.18 the Open vSwitch kernel module is no +longer supported and only the Linux openvswitch kernel module is used. +In the case of Open vSwitch releases 2.17 and older, kernel backports +may be required for bux fixes and feature implementation so these +instructions are preserved for that reason. + First, the patch should be submitted upstream to `netdev`. When the patch has been applied to `net-next`, it is ready to be backported. Starting from the Linux tree, use ``git format-patch`` to format each patch that should be diff --git a/Documentation/intro/install/fedora.rst b/Documentation/intro/install/fedora.rst index 06a0bd3d5..02481597f 100644 --- a/Documentation/intro/install/fedora.rst +++ b/Documentation/intro/install/fedora.rst @@ -132,36 +132,12 @@ tests. This can take several minutes. $ make rpm-fedora RPMBUILD_OPT="--with check" -Kernel OVS Tree Datapath RPM -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -To build the Open vSwitch kernel module for the currently running kernel -version, run: - -:: - - $ make rpm-fedora-kmod - -To build the Open vSwitch kernel module for another kernel version, the desired -kernel version can be specified via the `kversion` macro. For example: - -:: - - $ make rpm-fedora-kmod \ - RPMBUILD_OPT='-D "kversion 4.3.4-300.fc23.x86_64"' - Installing ---------- RPM packages can be installed by using the command ``rpm -i``. Package installation requires superuser privileges. -The `openvswitch-kmod` RPM should be installed first if the Linux OVS tree -datapath module is to be used. The `openvswitch-kmod` RPM should not be -installed if only the in-tree Linux datapath or user-space datapath is needed. -Refer to the :doc:`/faq/index` for more information about the various Open -vSwitch datapath options. - In most cases only the `openvswitch` RPM will need to be installed. The `python3-openvswitch`, `openvswitch-test`, `openvswitch-devel`, and `openvswitch-debuginfo` RPMs are optional unless required for a specific diff --git a/Documentation/intro/install/general.rst b/Documentation/intro/install/general.rst index a297aadac..c2208bbed 100644 --- a/Documentation/intro/install/general.rst +++ b/Documentation/intro/install/general.rst @@ -302,24 +302,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 wish to build the kernel module for an architecture other than the -architecture of the machine used for the build, you may specify the kernel -architecture string using the KARCH variable when invoking the configure -script. For example, to build for MIPS with Linux:: - - $ ./configure --with-linux=/path/to/linux KARCH=mips - If you plan to do much Open vSwitch 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 @@ -390,51 +372,6 @@ Building $ make install -5. If you built kernel modules, you may install them, e.g.:: - - $ make modules_install - - It is possible that you already had a Open vSwitch kernel module installed - on your machine that came from upstream Linux (in a different directory). To - make sure that you load the Open vSwitch kernel module you built from this - repository, you should create a ``depmod.d`` file that prefers your newly - installed kernel modules over the kernel modules from upstream Linux. The - following snippet of code achieves the same:: - - $ config_file="/etc/depmod.d/openvswitch.conf" - $ for module in datapath/linux/*.ko; do - modname="$(basename ${module})" - echo "override ${modname%.ko} * extra" >> "$config_file" - echo "override ${modname%.ko} * weak-updates" >> "$config_file" - done - $ depmod -a - - Finally, load the kernel modules that you need. e.g.:: - - $ /sbin/modprobe openvswitch - - To verify that the modules have been loaded, run ``/sbin/lsmod`` and check - that openvswitch is listed:: - - $ /sbin/lsmod | grep openvswitch - - .. note:: - If the ``modprobe`` operation fails, look at the last few kernel log - messages (e.g. with ``dmesg | tail``). Generally, issues like this occur - when Open vSwitch is built for a kernel different from the one into which - you are trying to load it. Run ``modinfo`` on ``openvswitch.ko`` and on a - module built for the running kernel, e.g.:: - - $ /sbin/modinfo openvswitch.ko - $ /sbin/modinfo /lib/modules/$(uname -r)/kernel/net/bridge/bridge.ko - - Compare the "vermagic" lines output by the two commands. If they differ, - then Open vSwitch was built for the wrong kernel. - - If you decide to report a bug or ask a question related to module loading, - include the output from the ``dmesg`` and ``modinfo`` commands mentioned - above. - .. _general-starting: Starting