Skip to content

Commit

Permalink
doc: add napatech plugin upgrade notes
Browse files Browse the repository at this point in the history
Issue: 7165
  • Loading branch information
jlucovsky committed Jul 16, 2024
1 parent 4c38593 commit f6b83bf
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 0 deletions.
2 changes: 2 additions & 0 deletions doc/userguide/upgrade.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,8 @@ Major changes
<upgrade/8.0-dns-logging-changes>`.
- PF_RING support has been moved to a plugin. See :doc:`PF_RING plugin
<upgrade/8.0-pfring-plugin>`.
- NAPATECH support has been moved to a plugin. See :doc:`NAPATECH plugin
<upgrade/8.0-napatech-plugin>`.

Removals
~~~~~~~~
Expand Down
43 changes: 43 additions & 0 deletions doc/userguide/upgrade/8.0-napatech-plugin.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
:orphan: Document only referenced from upgrade.rst

NAPATECH as a Plugin
====================

Suricata 8.0 moves NAPATECH 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 plugin is eventually removed from the
Suricata source tree these options may be removed and/or
changed as this would allow the NAPATECH plugin to have its
own release cycle and make changes independent of Suricata.

However, the ``napatech`` 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.

Then your existing NAPATECH command line options and configuration
should continue to work.

Caveats
-------

Currently building the NAPATECH plugin is not compatible with the
``--disable-shared`` configure argument.

0 comments on commit f6b83bf

Please sign in to comment.