[DOCS] Add homebrew instructions to install docs (#12607)

* [DOCS] Add homebrew instructions to install docs * More changes * Fix command to match formulae * Remove brew version because it's not currently needed * Fix paths
elastic · Jun 20, 2019 · 04ed003 · 04ed003
1 parent 400c67e
commit 04ed003
Show file tree

Hide file tree

Showing 10 changed files with 96 additions and 0 deletions.
diff --git a/auditbeat/docs/getting-started.asciidoc b/auditbeat/docs/getting-started.asciidoc
@@ -75,6 +75,8 @@ tar xzvf {beatname_lc}-{version}-darwin-x86_64.tar.gz
 
 endif::[]
 
+include::{libbeat-dir}/docs/shared-brew-install.asciidoc[]
+
 [[linux]]
 *linux:*
 
@@ -244,6 +246,8 @@ in the _Beats Platform Reference_.
 If you see a warning about too many open files, you need to increase the
 `ulimit`. See the <<ulimit,FAQ>> for more details.
 
+include::{libbeat-dir}/docs/shared-brew-run.asciidoc[]
+
 *win:*
 
 ["source","sh",subs="attributes"]

diff --git a/filebeat/docs/getting-started.asciidoc b/filebeat/docs/getting-started.asciidoc
@@ -75,6 +75,8 @@ tar xzvf filebeat-{version}-darwin-x86_64.tar.gz
 
 endif::[]
 
+include::{libbeat-dir}/docs/shared-brew-install.asciidoc[]
+
 [[linux]]
 *linux:*
 

diff --git a/heartbeat/docs/getting-started.asciidoc b/heartbeat/docs/getting-started.asciidoc
@@ -81,6 +81,8 @@ tar xzvf heartbeat-{version}-darwin-x86_64.tar.gz
 
 endif::[]
 
+include::{libbeat-dir}/docs/shared-brew-install.asciidoc[]
+
 [[linux]]
 *linux:*
 

diff --git a/libbeat/docs/dashboards.asciidoc b/libbeat/docs/dashboards.asciidoc
@@ -63,6 +63,13 @@ ifdef::mac_os[]
 ----------------------------------------------------------------------
 ./{beatname_lc} setup --dashboards
 ----------------------------------------------------------------------
+
+*brew:*
+
+["source","sh",subs="attributes"]
+----------------------------------------------------------------------
+{beatname_lc} setup --dashboards
+----------------------------------------------------------------------
 endif::mac_os[]
 
 ifdef::linux_os[]
@@ -139,6 +146,18 @@ ifdef::mac_os[]
   -E output.elasticsearch.password={pwd} \
   -E setup.kibana.host=localhost:5601 
 ----
+
+*brew:*
+
+["source","sh",subs="attributes"]
+----
+{beatname_lc} setup -e \
+  -E output.logstash.enabled=false \
+  -E output.elasticsearch.hosts=['localhost:9200'] \
+  -E output.elasticsearch.username={beat_default_index_prefix}_internal \
+  -E output.elasticsearch.password={pwd} \
+  -E setup.kibana.host=localhost:5601 
+----
 endif::mac_os[]
 
 ifdef::linux_os[]

diff --git a/libbeat/docs/shared-brew-install.asciidoc b/libbeat/docs/shared-brew-install.asciidoc
@@ -0,0 +1,21 @@
+[[brew]]
+*brew:*
+
+ifeval::["{release-state}"=="unreleased"]
+
+Version {stack-version} of {beatname_uc} has not yet been released.
+
+endif::[]
+
+ifeval::["{release-state}"!="unreleased"]
+
+["source","sh",subs="attributes"]
+-------------------------
+brew tap elastic/tap
+brew install elastic/tap/{beatname_lc}-full
+-------------------------
+
+This installs the most recently released default distribution of. To install the
+OSS distribution, specify +elastic/tap/{beatname_lc}-oss+.
+
+endif::[]
diff --git a/libbeat/docs/shared-brew-run.asciidoc b/libbeat/docs/shared-brew-run.asciidoc
@@ -0,0 +1,17 @@
+*brew:*
+
+To have launchd start +elastic/tap/{beatname_lc}+ and then restart it at login,
+run:
+
+["source","sh",subs="attributes"]
+-----
+brew services start elastic/tap/{beatname_lc}
+-----
+
+To run {beatname_uc} in the foreground instead of running it as a background
+service, run:
+
+["source","sh",subs="attributes"]
+-----
+{beatname_lc} -e
+-----
diff --git a/libbeat/docs/shared-directory-layout.asciidoc b/libbeat/docs/shared-directory-layout.asciidoc
@@ -99,6 +99,19 @@ ifndef::win_only[]
 
 endif::win_only[]
 
+ifdef::mac_os[]
+===== brew
+[cols="<h,<,<m",options="header",]
+|=======================================================================
+| Type   | Description | Location
+| home   | Home of the {beatname_uc} installation. | /usr/local/var/homebrew/linked/{beatname_lc}-full
+| bin    | The location for the binary files. | /usr/local/var/homebrew/linked/{beatname_lc}-full/bin
+| config | The location for configuration files. | /usr/local/etc/{beatname_lc}
+| data   | The location for persistent data files. | /usr/local/var/lib/{beatname_lc}
+| logs   | The location for the logs created by {beatname_uc}. | /usr/local/var/log/{beatname_lc}
+|=======================================================================
+endif::mac_os[]
+
 ifdef::win_only[]
 
 ["source","sh",subs="attributes"]

diff --git a/libbeat/docs/shared-template-load.asciidoc b/libbeat/docs/shared-template-load.asciidoc
@@ -152,6 +152,13 @@ ifdef::mac_os[]
 ----
 ./{beatname_lc} setup --template{disable_logstash} -E 'output.elasticsearch.hosts=["localhost:9200"]'
 ----
+
+*brew:*
+
+["source","sh",subs="attributes"]
+----
+{beatname_lc} setup --template{disable_logstash} -E 'output.elasticsearch.hosts=["localhost:9200"]'
+----
 endif::mac_os[]
 
 ifdef::linux_os[]
@@ -267,6 +274,13 @@ ifdef::mac_os[]
 ----
 ./{beatname_lc} export template > {beatname_lc}.template.json
 ----
+
+*brew:*
+
+["source","sh",subs="attributes"]
+----
+{beatname_lc} export template > {beatname_lc}.template.json
+----
 endif::mac_os[]
 
 ifdef::linux_os[]

diff --git a/metricbeat/docs/gettingstarted.asciidoc b/metricbeat/docs/gettingstarted.asciidoc
@@ -84,6 +84,8 @@ tar xzvf {beatname_lc}-{version}-darwin-x86_64.tar.gz
 
 endif::[]
 
+include::{libbeat-dir}/docs/shared-brew-install.asciidoc[]
+
 [[linux]]
 *linux:*
 

diff --git a/packetbeat/docs/gettingstarted.asciidoc b/packetbeat/docs/gettingstarted.asciidoc
@@ -83,6 +83,8 @@ tar xzvf packetbeat-{version}-darwin-x86_64.tar.gz
 
 endif::[]
 
+include::{libbeat-dir}/docs/shared-brew-install.asciidoc[]
+
 [[linux]]
 *linux:*