From 579596e91001d80f3610e487c21f6dc937794d1c Mon Sep 17 00:00:00 2001 From: lcawl Date: Mon, 9 Jul 2018 12:04:34 -0700 Subject: [PATCH 1/2] [DOCS] Adds shutdown pages for the Beats --- auditbeat/docs/setting-up-running.asciidoc | 2 ++ filebeat/docs/setting-up-running.asciidoc | 2 ++ heartbeat/docs/setting-up-running.asciidoc | 2 ++ libbeat/docs/shared-shutdown.asciidoc | 24 +++++++++++++++++++++ metricbeat/docs/setting-up-running.asciidoc | 2 ++ packetbeat/docs/setting-up-running.asciidoc | 2 ++ winlogbeat/docs/setting-up-running.asciidoc | 2 ++ 7 files changed, 36 insertions(+) create mode 100644 libbeat/docs/shared-shutdown.asciidoc diff --git a/auditbeat/docs/setting-up-running.asciidoc b/auditbeat/docs/setting-up-running.asciidoc index c666a8abca2..7495529e462 100644 --- a/auditbeat/docs/setting-up-running.asciidoc +++ b/auditbeat/docs/setting-up-running.asciidoc @@ -30,3 +30,5 @@ include::../../libbeat/docs/keystore.asciidoc[] include::../../libbeat/docs/command-reference.asciidoc[] include::./running-on-docker.asciidoc[] + +include::../../libbeat/docs/shared-shutdown.asciidoc[] diff --git a/filebeat/docs/setting-up-running.asciidoc b/filebeat/docs/setting-up-running.asciidoc index 8225809b9b0..4560fc9adda 100644 --- a/filebeat/docs/setting-up-running.asciidoc +++ b/filebeat/docs/setting-up-running.asciidoc @@ -34,3 +34,5 @@ include::../../libbeat/docs/command-reference.asciidoc[] include::./running-on-docker.asciidoc[] include::./running-on-kubernetes.asciidoc[] + +include::../../libbeat/docs/shared-shutdown.asciidoc[] diff --git a/heartbeat/docs/setting-up-running.asciidoc b/heartbeat/docs/setting-up-running.asciidoc index 4e179b40c28..a6762faa0e7 100644 --- a/heartbeat/docs/setting-up-running.asciidoc +++ b/heartbeat/docs/setting-up-running.asciidoc @@ -29,3 +29,5 @@ include::../../libbeat/docs/keystore.asciidoc[] include::../../libbeat/docs/command-reference.asciidoc[] include::./running-on-docker.asciidoc[] + +include::../../libbeat/docs/shared-shutdown.asciidoc[] diff --git a/libbeat/docs/shared-shutdown.asciidoc b/libbeat/docs/shared-shutdown.asciidoc new file mode 100644 index 00000000000..9ec2dc57386 --- /dev/null +++ b/libbeat/docs/shared-shutdown.asciidoc @@ -0,0 +1,24 @@ +////////////////////////////////////////////////////////////////////////// +//// This content is shared by all Elastic Beats. Make sure you keep the +//// descriptions here generic enough to work for all Beats that include +//// this file. When using cross references, make sure that the cross +//// references resolve correctly for any files that include this one. +//// Use the appropriate variables defined in the index.asciidoc file to +//// resolve Beat names: beatname_uc and beatname_lc. +//// Use the following include to pull this content into a doc file: +//// include::../../libbeat/docs/shared-directory-layout.asciidoc[] +////////////////////////////////////////////////////////////////////////// + +[[shutdown]] +=== Stopping {beatname_uc} + +An orderly shutdown of {beatname_uc} ensures that it has a chance to clean up +and close outstanding resources. You can help ensure an orderly shutdown by +stopping {beatname_uc} properly. + +If you’re running {beatname_uc} as a service, you can stop it via the service +management functionality provided by your installation. + +If you’re running {beatname_uc} directly in the console, you can stop it by +entering *Ctrl-C*. Alternatively, send SIGTERM to the {beatname_uc} process on a +POSIX system. \ No newline at end of file diff --git a/metricbeat/docs/setting-up-running.asciidoc b/metricbeat/docs/setting-up-running.asciidoc index 13f28655b5f..b8a180aaed9 100644 --- a/metricbeat/docs/setting-up-running.asciidoc +++ b/metricbeat/docs/setting-up-running.asciidoc @@ -33,3 +33,5 @@ include::../../libbeat/docs/command-reference.asciidoc[] include::./running-on-docker.asciidoc[] include::./running-on-kubernetes.asciidoc[] + +include::../../libbeat/docs/shared-shutdown.asciidoc[] diff --git a/packetbeat/docs/setting-up-running.asciidoc b/packetbeat/docs/setting-up-running.asciidoc index 4e179b40c28..a6762faa0e7 100644 --- a/packetbeat/docs/setting-up-running.asciidoc +++ b/packetbeat/docs/setting-up-running.asciidoc @@ -29,3 +29,5 @@ include::../../libbeat/docs/keystore.asciidoc[] include::../../libbeat/docs/command-reference.asciidoc[] include::./running-on-docker.asciidoc[] + +include::../../libbeat/docs/shared-shutdown.asciidoc[] diff --git a/winlogbeat/docs/setting-up-running.asciidoc b/winlogbeat/docs/setting-up-running.asciidoc index a3fa01c2f21..946b4133292 100644 --- a/winlogbeat/docs/setting-up-running.asciidoc +++ b/winlogbeat/docs/setting-up-running.asciidoc @@ -25,3 +25,5 @@ include::../../libbeat/docs/shared-directory-layout.asciidoc[] include::../../libbeat/docs/keystore.asciidoc[] include::../../libbeat/docs/command-reference.asciidoc[] + +include::../../libbeat/docs/shared-shutdown.asciidoc[] From ccb610d795f8d064f5e6cdcb3b8e116573acf7ef Mon Sep 17 00:00:00 2001 From: lcawl Date: Mon, 9 Jul 2018 13:04:15 -0700 Subject: [PATCH 2/2] [DOCS] Fixed path in file intro --- libbeat/docs/shared-shutdown.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/libbeat/docs/shared-shutdown.asciidoc b/libbeat/docs/shared-shutdown.asciidoc index 9ec2dc57386..bbe14b011f5 100644 --- a/libbeat/docs/shared-shutdown.asciidoc +++ b/libbeat/docs/shared-shutdown.asciidoc @@ -6,7 +6,7 @@ //// Use the appropriate variables defined in the index.asciidoc file to //// resolve Beat names: beatname_uc and beatname_lc. //// Use the following include to pull this content into a doc file: -//// include::../../libbeat/docs/shared-directory-layout.asciidoc[] +//// include::../../libbeat/docs/shared-shutdown.asciidoc[] ////////////////////////////////////////////////////////////////////////// [[shutdown]]