doc: reflect most recent cpu affinity settings

Some settings like output-cpu-set never been used and detect got renamed
to worker. This reflects those changes already present in the yaml also
within the documentation.
pull/2890/head
Andreas Herz 8 years ago
parent d363a165c1
commit c048ee6505

@ -978,9 +978,9 @@ thread. In that case 1, 2 and 4 are at core 0 (zero). Each core has
its own detect thread. The detect thread running on core 0 has a lower its own detect thread. The detect thread running on core 0 has a lower
priority than the other threads running on core 0. If these other priority than the other threads running on core 0. If these other
cores are to occupied, the detect thread on core 0 has not much cores are to occupied, the detect thread on core 0 has not much
packets to process. De detect threads running on other cores will packets to process. The detect threads running on other cores will
process more packets. This is only the case after setting the option process more packets. This is only the case after setting the option
at 'yes'. to 'yes'.
*Example 7 Balancing workload* *Example 7 Balancing workload*
@ -1001,23 +1001,21 @@ waited for a detection thread. The remaining detection thread can
become active. become active.
In the option 'cpu affinity' you can set which CPU's/cores work on In the option 'cpu affinity' you can set which CPU's/cores work on which
which thread. In this option there are several sets of threads. The thread. In this option there are several sets of threads. The management-,
management-, receive-, decode-, stream-, detect-, verdict-, reject- receive-, worker- and verdict-set. These are fixed names and can not be
and outputs-set. These are fixed names and can not be changed. For changed. For each set there are several options: cpu, mode, and prio. In the
each set there are several options: cpu, mode, and prio. In the option 'cpu' you can set the numbers of the CPU's/cores which will run the
option 'cpu' you can set the numbers of the CPU's/cores which will run threads from that set. You can set this option to 'all', use a range (0-3) or a
the threads from that set. You can set this option to 'all', use a comma separated list (0,1). The option 'mode' can be set to 'balanced' or
range (0-3) or a comma separated list (0,1). The option 'mode' can be 'exclusive'. When set to 'balanced', the individual threads can be processed by
set to 'balanced' or 'exclusive'. When set to 'balanced', the all cores set in the option 'cpu'. If the option 'mode' is set to 'exclusive',
individual threads can be processed by all cores set in the option there will be fixed cores for each thread. As mentioned before, threads can
'cpu'. If the option 'mode' is set to 'exclusive', there will be fixed have different priority's. In the option 'prio' you can set a priority for each
cores for each thread. As mentioned before, threads can have thread. This priority can be low, medium, high or you can set the priority to
different priority's. In the option 'prio' you can set a priority for 'default'. If you do not set a priority for a CPU, than the settings in
each thread. This priority can be low, medium, high or you can set the 'default' will count. By default Suricata creates one 'detect' (worker) thread
priority to 'default'. If you do not set a priority for a CPU, than per available CPU/CPU core.
the settings in 'default' will count. By default Suricata creates one
'detect' thread per available CPU/CPU core.
:: ::
@ -1026,14 +1024,9 @@ the settings in 'default' will count. By default Suricata creates one
cpu: [ 0 ] # include only these cpus in affinity settings cpu: [ 0 ] # include only these cpus in affinity settings
- receive-cpu-set: - receive-cpu-set:
cpu: [ 0 ] # include only these cpus in affinity settings cpu: [ 0 ] # include only these cpus in affinity settings
- decode-cpu-set: - worker-cpu-set:
cpu: [ 0, 1 ]
mode: "balanced"
- stream-cpu-set:
cpu: [ "0-1" ]
- detect-cpu-set:
cpu: [ "all" ] cpu: [ "all" ]
mode: "exclusive" # run detect threads in these cpus mode: "exclusive"
# Use explicitely 3 threads and don't compute number by using # Use explicitely 3 threads and don't compute number by using
# detect-thread-ratio variable: # detect-thread-ratio variable:
# threads: 3 # threads: 3
@ -1046,14 +1039,6 @@ the settings in 'default' will count. By default Suricata creates one
cpu: [ 0 ] cpu: [ 0 ]
prio: prio:
default: "high" default: "high"
- reject-cpu-set:
cpu: [ 0 ]
prio:
default: "low"
- output-cpu-set:
cpu: [ "all" ]
prio:
default: "medium"
Relevant cpu-affinity settings for IDS/IPS modes Relevant cpu-affinity settings for IDS/IPS modes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -1064,13 +1049,13 @@ IDS mode
Runmode AutoFp:: Runmode AutoFp::
management-cpu-set - used for management (example - flow.managers, flow.recyclers) management-cpu-set - used for management (example - flow.managers, flow.recyclers)
recive-cpu-set - used for receive and decode receive-cpu-set - used for receive and decode
detect-cpu-set - used for streamtcp,detect,output(logging),reject worker-cpu-set - used for streamtcp,detect,output(logging),reject
Rumode Workers:: Rumode Workers::
management-cpu-set - used for management (example - flow.managers, flow.recyclers) management-cpu-set - used for management (example - flow.managers, flow.recyclers)
detect-cpu-set - used for receive,streamtcp,decode,detect,output(logging),respond/reject worker-cpu-set - used for receive,streamtcp,decode,detect,output(logging),respond/reject
IPS mode IPS mode
@ -1079,14 +1064,14 @@ IPS mode
Runmode AutoFp:: Runmode AutoFp::
management-cpu-set - used for management (example - flow.managers, flow.recyclers) management-cpu-set - used for management (example - flow.managers, flow.recyclers)
recive-cpu-set - used for receive and decode receive-cpu-set - used for receive and decode
detect-cpu-set - used for streamtcp,detect,output(logging) worker-cpu-set - used for streamtcp,detect,output(logging)
verdict-cpu-set - used for verdict and respond/reject verdict-cpu-set - used for verdict and respond/reject
Runmode Workers:: Runmode Workers::
management-cpu-set - used for management (example - flow.managers, flow.recyclers) management-cpu-set - used for management (example - flow.managers, flow.recyclers)
detect-cpu-set - used for receive,streamtcp,decode,detect,output(logging),respond/reject, verdict worker-cpu-set - used for receive,streamtcp,decode,detect,output(logging),respond/reject, verdict

Loading…
Cancel
Save