From patchwork Fri Jul 8 16:14:17 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Gregory Rose X-Patchwork-Id: 1654258 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=ga5iZEt+; dkim-atps=neutral Authentication-Results: ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=openvswitch.org (client-ip=2605:bc80:3010::136; helo=smtp3.osuosl.org; envelope-from=ovs-dev-bounces@openvswitch.org; receiver=) Received: from smtp3.osuosl.org (smtp3.osuosl.org [IPv6:2605:bc80:3010::136]) (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 4Lfdf11q4Xz9s09 for ; Sat, 9 Jul 2022 02:14:49 +1000 (AEST) Received: from localhost (localhost [127.0.0.1]) by smtp3.osuosl.org (Postfix) with ESMTP id 1848861466; Fri, 8 Jul 2022 16:14:47 +0000 (UTC) DKIM-Filter: OpenDKIM Filter v2.11.0 smtp3.osuosl.org 1848861466 Authentication-Results: smtp3.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=ga5iZEt+ 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 cvFkbASAMyWX; Fri, 8 Jul 2022 16:14:44 +0000 (UTC) Received: from lists.linuxfoundation.org (lf-lists.osuosl.org [140.211.9.56]) by smtp3.osuosl.org (Postfix) with ESMTPS id EEE4E613DC; Fri, 8 Jul 2022 16:14:41 +0000 (UTC) DKIM-Filter: OpenDKIM Filter v2.11.0 smtp3.osuosl.org EEE4E613DC Received: from lf-lists.osuosl.org (localhost [127.0.0.1]) by lists.linuxfoundation.org (Postfix) with ESMTP id 9CC29C0071; Fri, 8 Jul 2022 16:14:41 +0000 (UTC) X-Original-To: dev@openvswitch.org Delivered-To: ovs-dev@lists.linuxfoundation.org Received: from smtp1.osuosl.org (smtp1.osuosl.org [IPv6:2605:bc80:3010::138]) by lists.linuxfoundation.org (Postfix) with ESMTP id 8D664C002D for ; Fri, 8 Jul 2022 16:14:40 +0000 (UTC) Received: from localhost (localhost [127.0.0.1]) by smtp1.osuosl.org (Postfix) with ESMTP id 4019F8483D for ; Fri, 8 Jul 2022 16:14:40 +0000 (UTC) DKIM-Filter: OpenDKIM Filter v2.11.0 smtp1.osuosl.org 4019F8483D Authentication-Results: smtp1.osuosl.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.a=rsa-sha256 header.s=20210112 header.b=ga5iZEt+ 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 i9byeOu8MfFb for ; Fri, 8 Jul 2022 16:14:38 +0000 (UTC) X-Greylist: whitelisted by SQLgrey-1.8.0 DKIM-Filter: OpenDKIM Filter v2.11.0 smtp1.osuosl.org 345738481F Received: from mail-oa1-x35.google.com (mail-oa1-x35.google.com [IPv6:2001:4860:4864:20::35]) by smtp1.osuosl.org (Postfix) with ESMTPS id 345738481F for ; Fri, 8 Jul 2022 16:14:38 +0000 (UTC) Received: by mail-oa1-x35.google.com with SMTP id 586e51a60fabf-10c0d96953fso16205806fac.0 for ; Fri, 08 Jul 2022 09:14:38 -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=PR7xNng1CVss6PpAt3ADZNWwCeXY3mByumspJOrVjKE=; b=ga5iZEt+Ncjp3CXHZdlOSjigcTLcZe2ZRvncD3w4egxQRpohpIQSHkGQfzjhVYWNK2 ySxYp5gIDVD7S+Oq/RwXsVPe/x3x+rEan+2x6TKMVJpwOYTafacWE6f+AsnFr/Wmj8Mi nngquGnTAP2SWjS/t++ebd/0t3OGeg7ylysBsWdLOZR3WIXCcdLC2+deEkkCg0AITeYv yUOreKt+4rCOHGdt12upG8HMOIA3W+JgI2XteF7WlYfqSfm3KShXoMKTGZS50iuyfH3j Re0vpzc2FghZXUGQzrNiDmbkoNz/mWpPQI4ftYFdiRurc9rpbyO1QN2AU3EE8jhRtdZa 2Gwg== 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=PR7xNng1CVss6PpAt3ADZNWwCeXY3mByumspJOrVjKE=; b=utO4D9CZkfYAI73Y5AtZdd0jIwUT3WpIMAtcYazHFMji+edrAjDluK1Jx7Ac0sFNtE B0HLkiC28EWRecmrhVSkipQR1xm9S1RgVloewKsMszpA5cXfh50pE0HUJZq0QG2EY2rh jx7cDApRrWoSGmMeAm6drLjAslqoOjQRH4i7ClP+d0edoa40/GXZD458JTvPDnAU0Shm QR+C9QIo2K2s7YEUE5O+5MC5hFwegmM/+677pu7dTKnNvJD2CWWWJn8K3Hk/DWQjm4/z pLv1YdS70M+yyEJuftAREzFilALJciYXS4uUKht77NxE0L132xP5ZxfaKiDb6owKpWlU /Xkw== X-Gm-Message-State: AJIora9NXUIQK+WGmX11FY54YLxt0yR+IYkRLgSs3XpJgbOgXr8JKx/p Il0j9t1tcNcl74PAwC2J5e+4yhchdfc= X-Google-Smtp-Source: AGRyM1t0PBG/hHqp9bFarl0oTjbiNUE2BwRaDjIybeYoz6hmcsMw4q9IYAwZQwzKVqw7k82+y63VCg== X-Received: by 2002:a05:6870:2418:b0:101:9461:787c with SMTP id n24-20020a056870241800b001019461787cmr376318oap.196.1657296876955; Fri, 08 Jul 2022 09:14:36 -0700 (PDT) Received: from VMware-box.domain ([97.115.145.232]) by smtp.googlemail.com with ESMTPSA id l21-20020a544515000000b00326cb6225f8sm16685885oil.44.2022.07.08.09.14.36 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 08 Jul 2022 09:14:36 -0700 (PDT) From: Greg Rose To: dev@openvswitch.org Date: Fri, 8 Jul 2022 09:14:17 -0700 Message-Id: <20220708161417.12438-9-gvrose8192@gmail.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20220708161417.12438-1-gvrose8192@gmail.com> References: <20220708161417.12438-1-gvrose8192@gmail.com> Subject: [ovs-dev] [PATCH V2 8/8] 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. Signed-off-by: Greg Rose --- Documentation/faq/releases.rst | 5 +- .../contributing/backporting-patches.rst | 7 +++ Documentation/intro/install/fedora.rst | 24 ------- Documentation/intro/install/general.rst | 63 ------------------- 4 files changed, 10 insertions(+), 89 deletions(-) diff --git a/Documentation/faq/releases.rst b/Documentation/faq/releases.rst index 8cfe2d392..ab2925a62 100644 --- a/Documentation/faq/releases.rst +++ b/Documentation/faq/releases.rst @@ -74,7 +74,7 @@ Q: What Linux kernel versions does each Open vSwitch release work with? 2.14.x 3.16 to 5.5 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.17.x N/A ============ ============== Open vSwitch userspace should also work with the Linux kernel module built @@ -110,7 +110,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.17.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..8370c954d 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.16 and older. +As of Open vSwitch branch 2.17 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.16 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