Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add conditions for each platform #8811

Merged
merged 3 commits into from
Nov 1, 2018
Merged

Add conditions for each platform #8811

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8782448
Add conditions for each platform
dedemorton Oct 30, 2018
e230cd9
Add conditions to directory layout topic
dedemorton Oct 31, 2018
4e53f3d
Combine conditions for deb and rpm
dedemorton Oct 31, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions auditbeat/docs/configuring-howto.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,6 @@ include::./auditbeat-general-options.asciidoc[]

include::./reload-configuration.asciidoc[]

:allplatforms:
include::../../libbeat/docs/queueconfig.asciidoc[]

include::../../libbeat/docs/outputconfig.asciidoc[]
Expand All @@ -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[]

Expand Down
11 changes: 1 addition & 10 deletions auditbeat/docs/getting-started.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
Expand All @@ -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"]
----------------------------------------------------------------------
Expand Down
5 changes: 5 additions & 0 deletions auditbeat/docs/index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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[]

Expand Down
4 changes: 2 additions & 2 deletions filebeat/docs/configuring-howto.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,6 @@ include::./filebeat-general-options.asciidoc[]

include::./reload-configuration.asciidoc[]

:allplatforms:
include::../../libbeat/docs/queueconfig.asciidoc[]

include::../../libbeat/docs/outputconfig.asciidoc[]
Expand All @@ -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[]

Expand Down
12 changes: 1 addition & 11 deletions filebeat/docs/getting-started.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]]
Expand All @@ -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"]
----------------------------------------------------------------------
Expand Down
5 changes: 5 additions & 0 deletions filebeat/docs/index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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[]

Expand Down
4 changes: 2 additions & 2 deletions heartbeat/docs/configuring-howto.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@ include::./heartbeat-options.asciidoc[]

include::./heartbeat-general-options.asciidoc[]

:allplatforms:
include::../../libbeat/docs/queueconfig.asciidoc[]

include::../../libbeat/docs/outputconfig.asciidoc[]
Expand All @@ -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[]

Expand Down
11 changes: 1 addition & 10 deletions heartbeat/docs/getting-started.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]]
Expand All @@ -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"]
----------------------------------------------------------------------
Expand Down
5 changes: 5 additions & 0 deletions heartbeat/docs/index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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[]

Expand Down
4 changes: 0 additions & 4 deletions journalbeat/docs/configuring-howto.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,7 @@ include::./config-options.asciidoc[]

include::./general-options.asciidoc[]

:allplatforms:
include::../../libbeat/docs/queueconfig.asciidoc[]
:allplatforms!:

include::../../libbeat/docs/outputconfig.asciidoc[]

Expand All @@ -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[]

Expand Down
11 changes: 1 addition & 10 deletions journalbeat/docs/getting-started.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
Expand All @@ -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"]
----------------------------------------------------------------------
Expand Down
2 changes: 2 additions & 0 deletions journalbeat/docs/index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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[]

Expand Down
1 change: 0 additions & 1 deletion libbeat/docs/config-file-format.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -378,5 +378,4 @@ output.console:
[[config-file-format-tips]]
=== YAML tips and gotchas

:allplatforms:
include::yaml.asciidoc[]
35 changes: 21 additions & 14 deletions libbeat/docs/dashboards.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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*).
Expand All @@ -79,6 +82,7 @@ and run:
----------------------------------------------------------------------
PS > .{backslash}{beatname_lc}.exe setup --dashboards
----------------------------------------------------------------------
endif::win_os[]

ifndef::only-elasticsearch[]
[[load-dashboards-logstash]]
Expand All @@ -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"]
Expand All @@ -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"]
Expand All @@ -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"]
Expand All @@ -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*).
Expand All @@ -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[]

Loading