From ae15d3369c7ea220bfbe8cddd417451dfff701b7 Mon Sep 17 00:00:00 2001
From: Jeff Lucovsky <jlucovsky@oisf.net>
Date: Sun, 16 Apr 2023 08:33:44 -0400
Subject: [PATCH] config/pfring: Document add'l pf-ring cluster types

This commit adds additional cluster-types for use with the pf-ring
packet source.

Issue: 5975
(cherry picked from commit 62f4049705b7a5fefe00c3ab034c87d9680e7f14)
---
 suricata.yaml.in | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/suricata.yaml.in b/suricata.yaml.in
index 78c4b1a0e7..47889be5e4 100644
--- a/suricata.yaml.in
+++ b/suricata.yaml.in
@@ -1765,7 +1765,13 @@ pfring:
     cluster-id: 99
 
     # Default PF_RING cluster type. PF_RING can load balance per flow.
-    # Possible values are cluster_flow or cluster_round_robin.
+    # Possible values are:
+    # - cluster_flow:               6-tuple: <src ip, src_port, dst ip, dst port, proto, vlan>
+    # - cluster_inner_flow:         6-tuple: <src ip, src port, dst ip, dst port, proto, vlan>
+    # - cluster_inner_flow_2_tuple: 2-tuple: <src ip,           dst ip                       >
+    # - cluster_inner_flow_4_tuple: 4-tuple: <src ip, src port, dst ip, dst port             >
+    # - cluster_inner_flow_5_tuple: 5-tuple: <src ip, src port, dst ip, dst port, proto      >
+    # - cluster_round_robin (NOT RECOMMENDED)
     cluster-type: cluster_flow
 
     # bpf filter for this interface
-- 
2.47.2