Add conditions for each platform (elastic#8811)

* Add conditions for each platform * Add conditions to directory layout topic * Combine conditions for deb and rpm
dedemorton · Nov 9, 2018 · 870cec5 · 870cec5
1 parent ff5b9b3
commit 870cec5
Show file tree

Hide file tree

Showing 27 changed files with 168 additions and 152 deletions.
diff --git a/auditbeat/docs/configuring-howto.asciidoc b/auditbeat/docs/configuring-howto.asciidoc
@@ -49,7 +49,6 @@ include::./auditbeat-general-options.asciidoc[]
 
 include::./reload-configuration.asciidoc[]
 
-:allplatforms:
 include::../../libbeat/docs/queueconfig.asciidoc[]
 
 include::../../libbeat/docs/outputconfig.asciidoc[]
@@ -70,10 +69,11 @@ include::../../libbeat/docs/loggingconfig.asciidoc[]
 
 :standalone:
 include::../../libbeat/docs/shared-env-vars.asciidoc[]
+:standalone!:
 
 :standalone:
-:allplatforms:
 include::../../libbeat/docs/yaml.asciidoc[]
+:standalone!:
 
 include::../../libbeat/docs/regexp.asciidoc[]
 

diff --git a/auditbeat/docs/getting-started.asciidoc b/auditbeat/docs/getting-started.asciidoc
@@ -181,13 +181,11 @@ include::../../libbeat/docs/step-look-at-config.asciidoc[]
 [id="{beatname_lc}-template"]
 === Step 3: Load the index template in {es}
 
-:allplatforms:
 include::../../libbeat/docs/shared-template-load.asciidoc[]
 
 [[load-kibana-dashboards]]
 === Step 4: Set up the {kib} dashboards
 
-:allplatforms:
 include::../../libbeat/docs/dashboards.asciidoc[]
 
 [id="{beatname_lc}-starting"]
@@ -201,14 +199,7 @@ NOTE: If you use an init.d script to start {beatname_uc} on deb or rpm, you can'
 specify command line flags (see <<command-line-options>>). To specify flags,
 start {beatname_uc} in the foreground.
 
-*deb:*
-
-["source","sh",subs="attributes"]
-----------------------------------------------------------------------
-sudo service {beatname_lc} start
-----------------------------------------------------------------------
-
-*rpm:*
+*deb and rpm:*
 
 ["source","sh",subs="attributes"]
 ----------------------------------------------------------------------

diff --git a/auditbeat/docs/index.asciidoc b/auditbeat/docs/index.asciidoc
@@ -12,6 +12,11 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
 :discuss_forum: beats/{beatname_lc}
 :beat_default_index_prefix: {beatname_lc}
 :has_ml_jobs: yes
+:deb_os:
+:rpm_os:
+:mac_os:
+:docker_platform:
+:win_os:
 
 include::../../libbeat/docs/shared-beats-attributes.asciidoc[]
 

diff --git a/filebeat/docs/configuring-howto.asciidoc b/filebeat/docs/configuring-howto.asciidoc
@@ -54,7 +54,6 @@ include::./filebeat-general-options.asciidoc[]
 
 include::./reload-configuration.asciidoc[]
 
-:allplatforms:
 include::../../libbeat/docs/queueconfig.asciidoc[]
 
 include::../../libbeat/docs/outputconfig.asciidoc[]
@@ -77,14 +76,15 @@ include::../../libbeat/docs/loggingconfig.asciidoc[]
 
 :standalone:
 include::../../libbeat/docs/shared-env-vars.asciidoc[]
+:standalone!:
 
 :autodiscoverJolokia:
 :autodiscoverHints:
 include::../../libbeat/docs/shared-autodiscover.asciidoc[]
 
 :standalone:
-:allplatforms:
 include::../../libbeat/docs/yaml.asciidoc[]
+:standalone!:
 
 include::../../libbeat/docs/regexp.asciidoc[]
 

diff --git a/filebeat/docs/getting-started.asciidoc b/filebeat/docs/getting-started.asciidoc
@@ -186,19 +186,16 @@ include::../../libbeat/docs/step-look-at-config.asciidoc[]
 [[config-filebeat-logstash]]
 === Step 3: Configure Filebeat to use Logstash
 
-:allplatforms:
 include::../../libbeat/docs/shared-logstash-config.asciidoc[]
 
 [[filebeat-template]]
 === Step 4: Load the index template in Elasticsearch
 
-:allplatforms:
 include::../../libbeat/docs/shared-template-load.asciidoc[]
 
 [[load-kibana-dashboards]]
 === Step 5: Set up the Kibana dashboards
 
-:allplatforms:
 include::../../libbeat/docs/dashboards.asciidoc[]
 
 [[filebeat-starting]]
@@ -212,14 +209,7 @@ NOTE: If you use an init.d script to start Filebeat on deb or rpm, you can't
 specify command line flags (see <<command-line-options>>). To specify flags,
 start Filebeat in the foreground.
 
-*deb:*
-
-["source","sh",subs="attributes"]
-----------------------------------------------------------------------
-sudo service {beatname_lc} start
-----------------------------------------------------------------------
-
-*rpm:*
+*deb and rpm:*
 
 ["source","sh",subs="attributes"]
 ----------------------------------------------------------------------

diff --git a/filebeat/docs/index.asciidoc b/filebeat/docs/index.asciidoc
@@ -12,6 +12,11 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
 :discuss_forum: beats/{beatname_lc}
 :beat_default_index_prefix: {beatname_lc}
 :has_ml_jobs: yes
+:deb_os:
+:rpm_os:
+:mac_os:
+:docker_platform:
+:win_os:
 
 include::../../libbeat/docs/shared-beats-attributes.asciidoc[]
 

diff --git a/heartbeat/docs/configuring-howto.asciidoc b/heartbeat/docs/configuring-howto.asciidoc
@@ -46,7 +46,6 @@ include::./heartbeat-options.asciidoc[]
 
 include::./heartbeat-general-options.asciidoc[]
 
-:allplatforms:
 include::../../libbeat/docs/queueconfig.asciidoc[]
 
 include::../../libbeat/docs/outputconfig.asciidoc[]
@@ -67,12 +66,13 @@ include::../../libbeat/docs/loggingconfig.asciidoc[]
 
 :standalone:
 include::../../libbeat/docs/shared-env-vars.asciidoc[]
+:standalone!:
 
 include::../../libbeat/docs/shared-autodiscover.asciidoc[]
 
 :standalone:
-:allplatforms:
 include::../../libbeat/docs/yaml.asciidoc[]
+:standalone!:
 
 include::../../libbeat/docs/regexp.asciidoc[]
 

diff --git a/heartbeat/docs/getting-started.asciidoc b/heartbeat/docs/getting-started.asciidoc
@@ -205,13 +205,11 @@ include::../../libbeat/docs/step-look-at-config.asciidoc[]
 [[heartbeat-template]]
 === Step 3: Load the index template in Elasticsearch
 
-:allplatforms:
 include::../../libbeat/docs/shared-template-load.asciidoc[]
 
 [[load-kibana-dashboards]]
 === Step 4: Set up the Kibana dashboards
 
-:allplatforms:
 include::../../libbeat/docs/dashboards.asciidoc[]
 
 [[heartbeat-starting]]
@@ -225,14 +223,7 @@ NOTE: If you use an init.d script to start Heartbeat on deb or rpm, you can't
 specify command line flags (see <<command-line-options>>). To specify flags,
 start Heartbeat in the foreground.
 
-*deb:*
-
-["source","sh",subs="attributes"]
-----------------------------------------------------------------------
-sudo service {beatname_lc}-elastic start
-----------------------------------------------------------------------
-
-*rpm:*
+*deb and rpm:*
 
 ["source","sh",subs="attributes"]
 ----------------------------------------------------------------------

diff --git a/heartbeat/docs/index.asciidoc b/heartbeat/docs/index.asciidoc
@@ -12,6 +12,11 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
 :discuss_forum: beats/{beatname_lc}
 :beat_default_index_prefix: {beatname_lc}
 :has_ml_jobs: yes
+:deb_os:
+:rpm_os:
+:mac_os:
+:docker_platform:
+:win_os:
 
 include::../../libbeat/docs/shared-beats-attributes.asciidoc[]
 

diff --git a/journalbeat/docs/configuring-howto.asciidoc b/journalbeat/docs/configuring-howto.asciidoc
@@ -47,9 +47,7 @@ include::./config-options.asciidoc[]
 
 include::./general-options.asciidoc[]
 
-:allplatforms:
 include::../../libbeat/docs/queueconfig.asciidoc[]
-:allplatforms!:
 
 include::../../libbeat/docs/outputconfig.asciidoc[]
 
@@ -75,10 +73,8 @@ include::../../libbeat/docs/shared-env-vars.asciidoc[]
 //include::../../libbeat/docs/shared-autodiscover.asciidoc[]
 
 :standalone:
-:allplatforms:
 include::../../libbeat/docs/yaml.asciidoc[]
 :standalone!:
-:allplatforms!:
 
 include::../../libbeat/docs/regexp.asciidoc[]
 

diff --git a/journalbeat/docs/getting-started.asciidoc b/journalbeat/docs/getting-started.asciidoc
@@ -182,15 +182,13 @@ include::../../libbeat/docs/step-look-at-config.asciidoc[]
 
 IMPORTANT: This documentation is placeholder content. It has not yet been reviewed.
 
-:allplatforms:
 include::../../libbeat/docs/shared-template-load.asciidoc[]
 
 [[load-kibana-dashboards]]
 === Step 4: Set up the Kibana dashboards
 
 IMPORTANT: This documentation is placeholder content. It has not yet been reviewed.
 
-:allplatforms:
 include::../../libbeat/docs/dashboards.asciidoc[]
 
 [id="{beatname_lc}-starting"]
@@ -206,14 +204,7 @@ NOTE: If you use an init.d script to start {beatname_uc} on deb or rpm, you can'
 specify command line flags (see <<command-line-options>>). To specify flags,
 start {beatname_uc} in the foreground.
 
-*deb:*
-
-["source","sh",subs="attributes"]
-----------------------------------------------------------------------
-sudo service {beatname_lc} start
-----------------------------------------------------------------------
-
-*rpm:*
+*deb and rpm:*
 
 ["source","sh",subs="attributes"]
 ----------------------------------------------------------------------

diff --git a/journalbeat/docs/index.asciidoc b/journalbeat/docs/index.asciidoc
@@ -13,6 +13,8 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
 :beat_default_index_prefix: {beatname_lc}
 :has_ml_jobs: no
 :libbeat-docs: Beats Platform Reference
+:deb_os:
+:rpm_os:
 
 include::../../libbeat/docs/shared-beats-attributes.asciidoc[]
 

diff --git a/libbeat/docs/config-file-format.asciidoc b/libbeat/docs/config-file-format.asciidoc
@@ -378,5 +378,4 @@ output.console:
 [[config-file-format-tips]]
 === YAML tips and gotchas
 
-:allplatforms:
 include::yaml.asciidoc[]
diff --git a/libbeat/docs/dashboards.asciidoc b/libbeat/docs/dashboards.asciidoc
@@ -32,42 +32,45 @@ the _Beats Developer Guide_.
 ifndef::only-elasticsearch[]
 If you've configured the Logstash output, see
 <<load-dashboards-logstash>>.
-endif::[]
-
-ifdef::allplatforms[]
+endif::only-elasticsearch[]
 
 ifeval::["{requires-sudo}"=="yes"]
 
 include::../../libbeat/docs/shared-note-sudo.asciidoc[]
 
 endif::[]
 
+ifdef::deb_os,rpm_os[]
 *deb and rpm:*
 
 ["source","sh",subs="attributes"]
 ----------------------------------------------------------------------
 {beatname_lc} setup --dashboards
 ----------------------------------------------------------------------
+endif::deb_os,rpm_os[]
 
-
+ifdef::mac_os[]
 *mac:*
 
 ["source","sh",subs="attributes"]
 ----------------------------------------------------------------------
 ./{beatname_lc} setup --dashboards
 ----------------------------------------------------------------------
+endif::mac_os[]
 
-
+ifdef::docker_platform[]
 *docker:*
 
 ["source","sh",subs="attributes"]
 ----------------------------------------------------------------------
 docker run --net="host" {dockerimage} setup --dashboards
 ----------------------------------------------------------------------
+endif::docker_platform[]
 
+ifdef::win_os[]
+ifndef::win_only[]
 *win:*
-
-endif::allplatforms[]
+endif::win_only[]
 
 Open a PowerShell prompt as an Administrator (right-click the PowerShell icon
 and select *Run As Administrator*).
@@ -79,6 +82,7 @@ and run:
 ----------------------------------------------------------------------
 PS > .{backslash}{beatname_lc}.exe setup --dashboards
 ----------------------------------------------------------------------
+endif::win_os[]
 
 ifndef::only-elasticsearch[]
 [[load-dashboards-logstash]]
@@ -93,8 +97,7 @@ credentials.
 TIP: The example shows a hard-coded password, but you should store sensitive
 values in the <<keystore,secrets keystore>>.
 
-ifdef::allplatforms[]
-
+ifdef::deb_os,rpm_os[]
 *deb and rpm:*
 
 ["source","sh",subs="attributes"]
@@ -106,8 +109,9 @@ ifdef::allplatforms[]
   -E output.elasticsearch.password={pwd} \
   -E setup.kibana.host=localhost:5601
 ----
+endif::deb_os,rpm_os[]
 
-
+ifdef::mac_os[]
 *mac:*
 
 ["source","sh",subs="attributes"]
@@ -119,8 +123,10 @@ ifdef::allplatforms[]
   -E output.elasticsearch.password={pwd} \
   -E setup.kibana.host=localhost:5601 
 ----
+endif::mac_os[]
 
 
+ifdef::docker_platform[]
 *docker:*
 
 ["source","sh",subs="attributes"]
@@ -132,11 +138,12 @@ docker run --net="host" {dockerimage} setup -e \
   -E output.elasticsearch.password={pwd} \
   -E setup.kibana.host=localhost:5601
 ----
+endif::docker_platform[]
 
-
+ifdef::win_os[]
+ifndef::win_only[]
 *win:*
-
-endif::allplatforms[]
+endif::win_only[]
 
 Open a PowerShell prompt as an Administrator (right-click the PowerShell icon
 and select *Run As Administrator*).
@@ -153,7 +160,7 @@ PS > .{backslash}{beatname_lc}.exe setup -e `
   -E output.elasticsearch.password={pwd} `
   -E setup.kibana.host=localhost:5601 
 ----
-
+endif::win_os[]
 
 endif::only-elasticsearch[]