docs: how to enable coredump with systemd

Type: docs

Change-Id: I1f657389fec716cc6cdc942803e65f861ffea5f5
Signed-off-by: Benoît Ganne <bganne@cisco.com>

diff --git a/docs/troubleshooting/reportingissues/reportingissues.rst b/docs/troubleshooting/reportingissues/reportingissues.rst
index 261dec9..73b2397 100644 (file)
--- a/docs/troubleshooting/reportingissues/reportingissues.rst
+++ b/docs/troubleshooting/reportingissues/reportingissues.rst
@@ -194,6 +194,10 @@ will capture usable vpp core files in /tmp/dumps.
     # ulimit -c unlimited
     # echo 2 > /proc/sys/fs/suid_dumpable
 
+If you start VPP from systemd, you also need to edit
+/lib/systemd/system/vpp.service and uncomment the "LimitCORE=infinity"
+line before restarting VPP.
+
 Vpp core files often appear enormous. Gzip typically compresses them
 to manageable sizes. A multi-GByte corefile often compresses to 10-20
 Mbytes.

diff --git a/extras/rpm/vpp.service b/extras/rpm/vpp.service
index 40bf9d4..2cf9f91 100644 (file)
--- a/extras/rpm/vpp.service
+++ b/extras/rpm/vpp.service
@@ -9,6 +9,11 @@ ExecStart=/usr/bin/vpp -c /etc/vpp/startup.conf
 Type=simple
 Restart=on-failure
 RestartSec=5s
+# Uncomment the following line to enable VPP coredumps on crash
+# You still need to configure the rest of the system to collect them, see
+# https://fdio-vpp.readthedocs.io/en/latest/troubleshooting/reportingissues/reportingissues.html#core-files
+# for details
+#LimitCORE=infinity
 
 [Install]
 WantedBy=multi-user.target

diff --git a/src/pkg/debian/vpp.service b/src/pkg/debian/vpp.service
index 2e86941..4927feb 100644 (file)
--- a/src/pkg/debian/vpp.service
+++ b/src/pkg/debian/vpp.service
@@ -8,6 +8,11 @@ ExecStartPre=-/sbin/modprobe uio_pci_generic
 ExecStart=/usr/bin/vpp -c /etc/vpp/startup.conf
 ExecStopPost=/bin/rm -f /dev/shm/db /dev/shm/global_vm /dev/shm/vpe-api
 Restart=always
+# Uncomment the following line to enable VPP coredumps on crash
+# You still need to configure the rest of the system to collect them, see
+# https://fdio-vpp.readthedocs.io/en/latest/troubleshooting/reportingissues/reportingissues.html#core-files
+# for details
+#LimitCORE=infinity
 
 [Install]
 WantedBy=multi-user.target