Merge pull request #1457 in SNORT/snort3 from ~MDAGON/snort3:doc_reload to master

Squashed commit of the following:

commit 5989f0abb312c7ec72db512945f6bc4635963013
Author: Maya Dagon <mdagon@cisco.com>
Date:   Fri Nov 30 16:20:04 2018 -0500

    doc: add a section for reload limitations

diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
index 774f156c0541cf62805e9646e5853c5cacbcc59b..b6a29f289fff131b2595d33beff5f98683f9ad51 100644 (file)
--- a/doc/CMakeLists.txt
+++ b/doc/CMakeLists.txt
@@ -62,6 +62,7 @@ if ( MAKE_DOC )
        perf_monitor.txt
        pop_imap.txt
        reference.txt
+       reload_limitations.txt
        sensitive_data.txt
        port_scan.txt
        side_channel.txt

diff --git a/doc/reference.txt b/doc/reference.txt
index ff64ed2af3449fd1db62a739d630d5fb95092ede..389bf8dd01d7ed4953769b8d23284d626e0e5c0a 100644 (file)
--- a/doc/reference.txt
+++ b/doc/reference.txt
@@ -55,3 +55,6 @@ include::plugins.txt[]
 
 include::daq_readme.txt[]
 
+=== Limitations
+
+include::reload_limitations.txt[]

diff --git a/doc/reload_limitations.txt b/doc/reload_limitations.txt
new file mode 100644 (file)
index 0000000..cbc25a9
--- /dev/null
+++ b/doc/reload_limitations.txt
@@ -0,0 +1,29 @@
+==== Reload limitations
+
+The following parameters can't be changed during reload, and require a restart:
+
+* active.attempts
+* active.device
+* alerts.detection_filter_memcap
+* alerts.event_filter_memcap
+* alerts.rate_filter_memcap
+* attribute_table.max_hosts
+* attribute_table.max_services_per_host
+* daq.snaplen
+* daq.no_promisc
+* detection.asn1
+* file_id.max_files_cached
+* process.chroot
+* process.daemon
+* process.set_gid
+* process.set_uid
+
+In addition, the following scenarios require a restart:
+
+* Enabling file capture for the first time
+* Changing file_id.capture_memcap if file capture was previously or currently
+ enabled
+* Changing file_id.capture_block_size if file capture was previously or
+ currently enabled
+
+In all of these cases reload will fail, and the original config will remain in use.