From 1e0d3435dbd76b643352c64c5aff60d1fe9e158c Mon Sep 17 00:00:00 2001 From: Jeff Lucovsky Date: Sun, 14 Jul 2024 09:29:37 -0400 Subject: [PATCH] doc: add napatech plugin upgrade notes Issue: 7165 --- doc/userguide/upgrade.rst | 2 + doc/userguide/upgrade/8.0-napatech-plugin.rst | 42 +++++++++++++++++++ 2 files changed, 44 insertions(+) create mode 100644 doc/userguide/upgrade/8.0-napatech-plugin.rst diff --git a/doc/userguide/upgrade.rst b/doc/userguide/upgrade.rst index 389cca88cf..63e2146280 100644 --- a/doc/userguide/upgrade.rst +++ b/doc/userguide/upgrade.rst @@ -77,6 +77,8 @@ Major changes - sip.to - sip.content_type - sip.content_length +- Napatech support has been moved to a capture plugin. See :doc:`Napatech plugin + `. Removals ~~~~~~~~ diff --git a/doc/userguide/upgrade/8.0-napatech-plugin.rst b/doc/userguide/upgrade/8.0-napatech-plugin.rst new file mode 100644 index 0000000000..af9c0bc0c4 --- /dev/null +++ b/doc/userguide/upgrade/8.0-napatech-plugin.rst @@ -0,0 +1,42 @@ +:orphan: Document only referenced from upgrade.rst + +Napatech as a Plugin +==================== + +Suricata 8.0 moves Napatech packet capture support to a dynamically loaded +plugin. For convenience, this plugin is still bundled with Suricata, but it +may be removed from the Suricata source tree into its own repository in a +future release. + +Upgrading +--------- + +Suricata 8.0 continues to respect the ``--enable-napatech`` compile time +option, as well as the ``--napatech`` command-line options, and also +the ``napatech`` section of the configuration file. + +.. note:: When the Napatech capture plugin is eventually removed from the + Suricata source tree these options may be removed and/or changed + as this would allow the Napatech capture plugin to have its own + release cycle and make changes independent of Suricata. + +However, the ``napatech`` capture plugin must be loaded before it can be +used. If doing a fresh build of Suricata with Napatech support, the +``suricata.yaml`` configuration file should be configured to load the +plugin already, for example:: + + plugins: + - /usr/lib/suricata/napatech.so + +If you are upgrading, you will need to add the location of +``napatech.so`` to the ``plugins`` section of your ``suricata.yaml`` +manually, as shown above. + +Existing Napatech command-line options and configuration should continue to work. + +Caveats +------- + +Currently building the Napatech capture plugin is not compatible with the +``--disable-shared`` configure argument. + -- 2.47.2