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.

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

Add linux command examples to the docs #9189

Merged
merged 1 commit into from
Nov 26, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
23 changes: 21 additions & 2 deletions auditbeat/docs/getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,25 @@ tar xzvf {beatname_lc}-{version}-darwin-x86_64.tar.gz

endif::[]

[[linux]]
*linux:*

ifeval::["{release-state}"=="unreleased"]

Version {stack-version} of {beatname_uc} has not yet been released.

endif::[]

ifeval::["{release-state}"!="unreleased"]

["source","sh",subs="attributes"]
------------------------------------------------
curl -L -O https://artifacts.elastic.co/downloads/beats/{beatname_lc}/{beatname_lc}-{version}-linux-x86_64.tar.gz
tar xzvf {beatname_lc}-{version}-linux-x86_64.tar.gz
------------------------------------------------

endif::[]

[[docker]]
*docker:*

Expand Down Expand Up @@ -206,12 +225,12 @@ start {beatname_uc} in the foreground.
sudo service {beatname_lc} start
----------------------------------------------------------------------

*mac:*
*mac and linux:*

["source","sh",subs="attributes"]
----------------------------------------------------------------------
sudo chown root {beatname_lc}.yml <1>
sudo ./{beatname_lc} -e -c {beatname_lc}.yml
sudo ./{beatname_lc} -e
----------------------------------------------------------------------
<1> To monitor system files, you'll be running {beatname_uc} as root, so you
need to change ownership of the configuration file, or run {beatname_uc} with
Expand Down
1 change: 1 addition & 0 deletions auditbeat/docs/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
:mac_os:
:docker_platform:
:win_os:
:linux_os:

include::../../libbeat/docs/shared-beats-attributes.asciidoc[]

Expand Down
23 changes: 21 additions & 2 deletions filebeat/docs/getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,25 @@ tar xzvf filebeat-{version}-darwin-x86_64.tar.gz

endif::[]

[[linux]]
*linux:*

ifeval::["{release-state}"=="unreleased"]

Version {version} of {beatname_uc} has not yet been released.

endif::[]

ifeval::["{release-state}"!="unreleased"]

["source","sh",subs="attributes,callouts"]
------------------------------------------------
curl -L -O https://artifacts.elastic.co/downloads/beats/filebeat/filebeat-{version}-linux-x86_64.tar.gz
tar xzvf filebeat-{version}-linux-x86_64.tar.gz
------------------------------------------------

endif::[]

[[docker]]
*docker:*

Expand Down Expand Up @@ -223,12 +242,12 @@ sudo service {beatname_lc} start
docker run {dockerimage}
----------------------------------------------------------------------

*mac:*
*mac and linux:*

[source,shell]
----------------------------------------------------------------------
sudo chown root filebeat.yml <1>
sudo ./filebeat -e -c filebeat.yml
sudo ./filebeat -e
----------------------------------------------------------------------
<1> You'll be running Filebeat as root, so you need to change ownership
of the configuration file, or run Filebeat with `--strict.perms=false`
Expand Down
7 changes: 7 additions & 0 deletions filebeat/docs/include/enable-modules-command.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,13 @@
./{beatname_lc} modules enable {modulename}
----

*linux:*

["source","sh",subs="attributes"]
----
./{beatname_lc} modules enable {modulename}
----

*win:*

["source","sh",subs="attributes"]
Expand Down
7 changes: 7 additions & 0 deletions filebeat/docs/include/list-modules-command.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,13 @@
./{beatname_lc} modules list
----

*linux:*

["source","sh",subs="attributes"]
----
./{beatname_lc} modules list
----

*win:*

["source","sh",subs="attributes"]
Expand Down
7 changes: 7 additions & 0 deletions filebeat/docs/include/run-command.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,13 @@ service {beatname_lc} start
./{beatname_lc} -e
----

*linux:*

["source","sh",subs="attributes"]
----
./{beatname_lc} -e
----

*win:*

["source","sh",subs="attributes"]
Expand Down
7 changes: 7 additions & 0 deletions filebeat/docs/include/set-paths.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,13 @@ must include the module and fileset name. For example:
./{beatname_lc} -e -M "nginx.access.var.paths=[/usr/local/var/log/nginx/access.log*]"
----

*linux:*

["source","sh",subs="attributes"]
----
./{beatname_lc} -e -M "nginx.access.var.paths=[/usr/local/var/log/nginx/access.log*]"
----

*win:*

["source","sh",subs="attributes"]
Expand Down
7 changes: 7 additions & 0 deletions filebeat/docs/include/setup-command.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,13 @@
./{beatname_lc} setup -e
----

*linux:*

["source","sh",subs="attributes"]
----
./{beatname_lc} setup -e
----

*win:*

["source","sh",subs="attributes"]
Expand Down
1 change: 1 addition & 0 deletions filebeat/docs/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
:deb_os:
:rpm_os:
:mac_os:
:linux_os:
:docker_platform:
:win_os:

Expand Down
21 changes: 19 additions & 2 deletions heartbeat/docs/getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,23 @@ tar xzvf heartbeat-{version}-darwin-x86_64.tar.gz

endif::[]

[[linux]]
*linux:*

ifeval::["{release-state}"=="unreleased"]

Version {version} of {beatname_uc} has not yet been released.

endif::[]

ifeval::["{release-state}"!="unreleased"]

["source","sh",subs="attributes"]
------------------------------------------------
curl -L -O {downloads}/heartbeat/heartbeat-{version}-linux-x86_64.tar.gz
tar xzvf heartbeat-{version}-linux-x86_64.tar.gz
------------------------------------------------
endif::[]

[[docker]]
*docker:*
Expand Down Expand Up @@ -230,12 +247,12 @@ start Heartbeat in the foreground.
sudo service {beatname_lc}-elastic start
----------------------------------------------------------------------

*mac:*
*mac and linux:*

["source","sh",subs="attributes"]
----------------------------------------------------------------------
sudo chown root heartbeat.yml <1>
sudo ./heartbeat -e -c heartbeat.yml
sudo ./heartbeat -e
----------------------------------------------------------------------
<1> You'll be running Heartbeat as root, so you need to change ownership of the
configuration file, or run Heartbeat with `--strict.perms=false` specified. See
Expand Down
1 change: 1 addition & 0 deletions heartbeat/docs/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
:deb_os:
:rpm_os:
:mac_os:
:linux_os:
:docker_platform:
:win_os:

Expand Down
1 change: 1 addition & 0 deletions journalbeat/docs/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
:libbeat-docs: Beats Platform Reference
:deb_os:
:rpm_os:
:linux_os:
:no_dashboards:

include::../../libbeat/docs/shared-beats-attributes.asciidoc[]
Expand Down
22 changes: 22 additions & 0 deletions libbeat/docs/dashboards.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,15 @@ ifdef::mac_os[]
----------------------------------------------------------------------
endif::mac_os[]

ifdef::linux_os[]
*linux:*

["source","sh",subs="attributes"]
----------------------------------------------------------------------
./{beatname_lc} setup --dashboards
----------------------------------------------------------------------
endif::linux_os[]

ifdef::docker_platform[]
*docker:*

Expand Down Expand Up @@ -125,6 +134,19 @@ ifdef::mac_os[]
----
endif::mac_os[]

ifdef::linux_os[]
*linux:*

["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::linux_os[]

ifdef::docker_platform[]
*docker:*
Expand Down
5 changes: 2 additions & 3 deletions libbeat/docs/reference-yml.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,8 @@ The following reference file is available with your {beatname_uc} installation.
shows all non-deprecated {beatname_uc} options. You can copy from this file and paste
configurations into the +{beatname_lc}.yml+ file to customize it.

TIP: For rpm and deb, you'll find the reference configuration file at +/etc/{beatname_lc}/{beatname_lc}.reference.yml+. Under
Docker, it's located at +/usr/share/{beatname_lc}/{beatname_lc}.reference.yml+. For mac and win,
look in the archive that you just extracted.
TIP: The reference file is located in the same directory as the
+{beatname_lc}.yml+ file. To locate the file, see <<directory-layout>>.

The contents of the file are included here for your convenience.

Expand Down
45 changes: 42 additions & 3 deletions libbeat/docs/shared-template-load.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -155,14 +155,24 @@ ifdef::mac_os[]
----
endif::mac_os[]

ifdef::mac_os[]
ifdef::linux_os[]
*linux:*

["source","sh",subs="attributes"]
----
./{beatname_lc} setup --template{disable_logstash} -E 'output.elasticsearch.hosts=["localhost:9200"]'
----
endif::linux_os[]


ifdef::docker_platform[]
*docker:*

["source","sh",subs="attributes"]
----------------------------------------------------------------------
docker run {dockerimage} setup --template{disable_logstash} -E 'output.elasticsearch.hosts=["localhost:9200"]'
----------------------------------------------------------------------
endif::mac_os[]
endif::docker_platform[]

ifdef::win_os[]
ifndef::win_only[]
Expand All @@ -187,7 +197,9 @@ endif::win_os[]
If you've already used {beatname_uc} to index data into Elasticsearch,
the index may contain old documents. After you load the index template,
you can delete the old documents from +{beatname_lc}-*+ to force Kibana to look
at the newest documents. Use this command:
at the newest documents.

Use this command:

ifdef::deb_os,rpm_os[]
*deb and rpm:*
Expand All @@ -207,6 +219,15 @@ curl -XDELETE 'http://localhost:9200/{beatname_lc}-*'
----------------------------------------------------------------------
endif::mac_os[]

ifdef::linux_os[]
*linux:*

["source","sh",subs="attributes"]
----------------------------------------------------------------------
curl -XDELETE 'http://localhost:9200/{beatname_lc}-*'
----------------------------------------------------------------------
endif::linux_os[]

ifdef::win_os[]
ifndef::win_only[]
*win:*
Expand Down Expand Up @@ -249,6 +270,15 @@ ifdef::mac_os[]
----
endif::mac_os[]

ifdef::linux_os[]
*linux:*

["source","sh",subs="attributes"]
----
./{beatname_lc} export template > {beatname_lc}.template.json
----
endif::linux_os[]

ifdef::win_os[]
ifndef::win_only[]
*win:*
Expand Down Expand Up @@ -280,6 +310,15 @@ curl -XPUT -H 'Content-Type: application/json' http://localhost:9200/_template/{
----
endif::mac_os[]

ifdef::linux_os[]
*linux:*

["source","sh",subs="attributes"]
----
curl -XPUT -H 'Content-Type: application/json' http://localhost:9200/_template/{beatname_lc}-{stack-version} -d@{beatname_lc}.template.json
----
endif::linux_os[]

ifdef::win_os[]
ifndef::win_only[]
*win:*
Expand Down
Loading