[#4147] Added core dump doc

diff --git a/doc/sphinx/arm/rst_arm_sources.mk b/doc/sphinx/arm/rst_arm_sources.mk
deleted file mode 100644 (file)
index 1163296..0000000
--- a/doc/sphinx/arm/rst_arm_sources.mk
+++ /dev/null
@@ -1,54 +0,0 @@
-rst_arm_sources += arm/acknowledgments.rst
-rst_arm_sources += arm/admin.rst
-rst_arm_sources += arm/agent.rst
-rst_arm_sources += arm/classify.rst
-rst_arm_sources += arm/config-backend.rst
-rst_arm_sources += arm/config-templates.rst
-rst_arm_sources += arm/config.rst
-rst_arm_sources += arm/congestion-handling.rst
-rst_arm_sources += arm/ctrl-channel.rst
-rst_arm_sources += arm/database-connectivity.rst
-rst_arm_sources += arm/ddns.rst
-rst_arm_sources += arm/dhcp4-srv.rst
-rst_arm_sources += arm/dhcp6-srv.rst
-rst_arm_sources += arm/ext-gss-tsig.rst
-rst_arm_sources += arm/ext-netconf.rst
-rst_arm_sources += arm/ext-radius.rst
-rst_arm_sources += arm/hammer.rst
-rst_arm_sources += arm/hooks-bootp.rst
-rst_arm_sources += arm/hooks-cb-cmds.rst
-rst_arm_sources += arm/hooks-class-cmds.rst
-rst_arm_sources += arm/hooks-ddns-tuning.rst
-rst_arm_sources += arm/hooks-flex-id.rst
-rst_arm_sources += arm/hooks-flex-option.rst
-rst_arm_sources += arm/hooks-gss-tsig.rst
-rst_arm_sources += arm/hooks-ha.rst
-rst_arm_sources += arm/hooks-host-cache.rst
-rst_arm_sources += arm/hooks-host-cmds.rst
-rst_arm_sources += arm/hooks-lease-cmds.rst
-rst_arm_sources += arm/hooks-lease-query.rst
-rst_arm_sources += arm/hooks-limits.rst
-rst_arm_sources += arm/hooks-mysql.rst
-rst_arm_sources += arm/hooks-pgsql.rst
-rst_arm_sources += arm/hooks-legal-log.rst
-rst_arm_sources += arm/hooks-perfmon.rst
-rst_arm_sources += arm/hooks-ping-check.rst
-rst_arm_sources += arm/hooks-radius.rst
-rst_arm_sources += arm/hooks-rbac.rst
-rst_arm_sources += arm/hooks-run-script.rst
-rst_arm_sources += arm/hooks-stat-cmds.rst
-rst_arm_sources += arm/hooks-subnet-cmds.rst
-rst_arm_sources += arm/hooks-user-chk.rst
-rst_arm_sources += arm/hooks.rst
-rst_arm_sources += arm/install.rst
-rst_arm_sources += arm/integrations.rst
-rst_arm_sources += arm/intro.rst
-rst_arm_sources += arm/keactrl.rst
-rst_arm_sources += arm/lease-expiration.rst
-rst_arm_sources += arm/lfc.rst
-rst_arm_sources += arm/logging.rst
-rst_arm_sources += arm/quickstart.rst
-rst_arm_sources += arm/security.rst
-rst_arm_sources += arm/shell.rst
-rst_arm_sources += arm/stats.rst
-rst_arm_sources += arm/stork.rst

diff --git a/doc/sphinx/arm/security.rst b/doc/sphinx/arm/security.rst
index ddabdf77180848ceaff25cd68f92f2b0246a2f78..9800deaecfed02182f3ca7ea9467cccc31efd2f3 100644 (file)
--- a/doc/sphinx/arm/security.rst
+++ b/doc/sphinx/arm/security.rst
@@ -689,3 +689,35 @@ from a project ("be hit by a bus") before the project stalls due to lack of know
 personnel. It is hard to estimate precisely, but the bus factor for Kea is somewhere around five. As of
 2021, there are six core developers and two quality assurance engineers, with many additional casual
 contributors (product manager, support team, IT, etc.). The team is geographically dispersed.
+
+Miscellaneous
+=============
+
+Creating core dump files
+------------------------
+
+When enabled kernels create core dump files when a process crashes or
+gets a signal with this action. The way to enable core dump files
+is system dependent but with common controls as the `coredumpsize`
+or `core file size` limit which can be seen and changed using `ulimit`
+or `limit` commands or shell built-ins.
+
+The Knowledge Base document `What to do if your BIND, Kea DHCP, Stork,
+or ISC DHCP server has crashed <https://kb.isc.org/docs/aa-00340>` document
+even oriented to ISC support explains per systems details in its
+``Things to check if a core file does not get generated`` section.
+
+Another way to create a core dump file is the `gcore` command which
+creates such files / images from a running process. Please look at its
+manual page to understand how to use it. Two points are important:
+
+- does `gcore` suspend or provides an option to suspend to dumped process?
+
+- the name of the produced core dump file (useful also for core dump file
+  created by the kernel).
+
+.. warning::
+
+   Beware that core dump files can be very large so can easily fill
+   the file system where they are stored... for instance do not forget
+   to not leave this feature enabled when not / no longer needed.

diff --git a/doc/sphinx/man/man8s.mk b/doc/sphinx/man/man8s.mk
deleted file mode 100644 (file)
index 7af7c1f..0000000
--- a/doc/sphinx/man/man8s.mk
+++ /dev/null
@@ -1,10 +0,0 @@
-man8s += $(sphinxbuilddir)/man/kea-admin.8
-man8s += $(sphinxbuilddir)/man/kea-ctrl-agent.8
-man8s += $(sphinxbuilddir)/man/kea-dhcp4.8
-man8s += $(sphinxbuilddir)/man/kea-dhcp6.8
-man8s += $(sphinxbuilddir)/man/kea-dhcp-ddns.8
-man8s += $(sphinxbuilddir)/man/kea-lfc.8
-man8s += $(sphinxbuilddir)/man/kea-netconf.8
-man8s += $(sphinxbuilddir)/man/kea-shell.8
-man8s += $(sphinxbuilddir)/man/keactrl.8
-man8s += $(sphinxbuilddir)/man/perfdhcp.8

diff --git a/doc/sphinx/man/rst_man_sources.mk b/doc/sphinx/man/rst_man_sources.mk
deleted file mode 100644 (file)
index 933fafe..0000000
--- a/doc/sphinx/man/rst_man_sources.mk
+++ /dev/null
@@ -1,10 +0,0 @@
-rst_man_sources += man/kea-admin.8.rst
-rst_man_sources += man/kea-ctrl-agent.8.rst
-rst_man_sources += man/kea-dhcp4.8.rst
-rst_man_sources += man/kea-dhcp6.8.rst
-rst_man_sources += man/kea-dhcp-ddns.8.rst
-rst_man_sources += man/kea-lfc.8.rst
-rst_man_sources += man/kea-netconf.8.rst
-rst_man_sources += man/kea-shell.8.rst
-rst_man_sources += man/keactrl.8.rst
-rst_man_sources += man/perfdhcp.8.rst