update docs

elastic · Jun 15, 2018 · 43ea772 · 43ea772
1 parent 157a9e5
commit 43ea772
Show file tree

Hide file tree

Showing 10 changed files with 35 additions and 70 deletions.
diff --git a/docs/copied-from-beats/command-reference.asciidoc b/docs/copied-from-beats/command-reference.asciidoc
@@ -397,10 +397,10 @@ ifeval::["{beatname_lc}"=="filebeat"]
 
 *`--once`*::
 When the `--once` flag is used, {beatname_uc} starts all configured harvesters
-and inputs, and runs each input until the harvesters are closed. If you set the
-`--once` flag, you should also set `close_eof` so the harvester is closed when
-the end of the file is reached. By default harvesters are closed after
-`close_inactive` is reached.
+and prospectors, and runs each prospector until the harvesters are closed. If
+you set the `--once` flag, you should also set `close_eof` so the harvester is
+closed when the end of the file is reached. By default harvesters are closed
+after `close_inactive` is reached.
 
 endif::[]
 
@@ -481,9 +481,6 @@ ifeval::["{beatname_lc}"=="filebeat"]
 Specifies a comma-separated list of modules. Use this flag to avoid errors when
 there are no modules defined in the +{beatname_lc}.yml+ file.
 
-*`--pipelines`*::
-Sets up ingest pipelines for configured filesets.
-
 endif::[]
 
 *`--template`*::

diff --git a/docs/copied-from-beats/dashboards.asciidoc b/docs/copied-from-beats/dashboards.asciidoc
@@ -18,7 +18,7 @@ command (as described here) or
 +{beatname_lc}.yml+ config file.
 
 This requires a Kibana endpoint configuration. If you didn't already configure
-a Kibana endpoint, see <<{beatname_lc}-configuration,configure {beatname_uc}>>. 
+a Kibana endpoint, see <<{beatname_lc}-configuration,configured {beatname_uc}>> 
 
 Make sure Kibana is running before you perform this step. If you are accessing a
 secured Kibana instance, make sure you've configured credentials as described in
@@ -67,12 +67,13 @@ endif::[]
 endif::allplatforms[]
 
 Open a PowerShell prompt as an Administrator (right-click the PowerShell icon
-and select *Run As Administrator*).
+and select *Run As Administrator*). If you are running Windows XP, you may need
+to download and install PowerShell.
 
 From the PowerShell prompt, change to the directory where you installed {beatname_uc},
 and run:
 
-["source","sh",subs="attributes"]
+["source","sh",subs="attributes,callouts"]
 ----------------------------------------------------------------------
-PS > .{backslash}{beatname_lc}.exe setup --dashboards
+PS > {beatname_lc} setup --dashboards
 ----------------------------------------------------------------------
diff --git a/docs/copied-from-beats/keystore.asciidoc b/docs/copied-from-beats/keystore.asciidoc
@@ -10,11 +10,7 @@
 //////////////////////////////////////////////////////////////////////////
 
 [[keystore]]
-=== Secrets keystore for secure settings
-
-++++
-<titleabbrev>Secrets keystore</titleabbrev>
-++++
+=== Secrets keystore
 
 When you configure {beatname_uc}, you might need to specify sensitive settings,
 such as passwords. Rather than relying on file system permissions to protect

diff --git a/docs/copied-from-beats/outputconfig.asciidoc b/docs/copied-from-beats/outputconfig.asciidoc
@@ -81,9 +81,7 @@ output.elasticsearch:
 
 ==== Compatibility
 
-This output works with all compatible versions of Elasticsearch. See the
-https://www.elastic.co/support/matrix#matrix_compatibility[Elastic Support
-Matrix].
+This output works with all compatible versions of Elasticsearch. See "Supported Beats Versions" in the https://www.elastic.co/support/matrix#show_compatibility[Elastic Support Matrix].
 
 ==== Configuration options
 
@@ -258,7 +256,7 @@ Example elasticsearch output with `pipelines`:
 
 ["source","yaml"]
 ------------------------------------------------------------------------------
-filebeat.inputs:
+filebeat.prospectors:
 - type: log
   paths: ["/var/log/app/normal/*.log"]
   fields:
@@ -403,9 +401,7 @@ will be similar to events directly indexed by Beats into Elasticsearch.
 
 ==== Compatibility
 
-This output works with all compatible versions of Logstash. See the
-https://www.elastic.co/support/matrix#matrix_compatibility[Elastic Support
-Matrix].
+This output works with all compatible versions of Logstash. See "Supported Beats Versions" in the https://www.elastic.co/support/matrix#show_compatibility[Elastic Support Matrix].
 
 ==== Configuration options
 

diff --git a/docs/copied-from-beats/security/basic-auth.asciidoc b/docs/copied-from-beats/security/basic-auth.asciidoc
@@ -43,7 +43,7 @@ following request creates a ++{beat_default_index_prefix}_internal++ user that h
 ---------------------------------------------------------------
 POST /_xpack/security/user/{beat_default_index_prefix}_internal
 {
-  "password" : "test-password",
+  "password" : "x-pack-test-password",
   "roles" : [ "{beat_default_index_prefix}_writer"],
   "full_name" : "Internal {beatname_uc} User"
 }
@@ -76,7 +76,7 @@ output.elasticsearch:
     hosts: ["localhost:9200"]
     index: "{beat_default_index_prefix}"
     username: "{beat_default_index_prefix}_internal"
-    password: "test-password"
+    password: "x-pack-test-password"
 --------------------------------------------------
 
 .. To use PKI authentication, configure the `certificate` and

diff --git a/docs/copied-from-beats/security/user-access.asciidoc b/docs/copied-from-beats/security/user-access.asciidoc
@@ -39,7 +39,7 @@ example, the following request grants ++{beat_default_index_prefix}_user++ the
 ---------------------------------------------------------------
 POST /_xpack/security/user/{beat_default_index_prefix}_user
 {
-  "password" : "test-password",
+  "password" : "x-pack-test-password",
   "roles" : [ "{beat_default_index_prefix}_reader"],
   "full_name" : "{beatname_uc} User"
 }

diff --git a/docs/copied-from-beats/shared-configuring.asciidoc b/docs/copied-from-beats/shared-configuring.asciidoc
@@ -1,24 +1,24 @@
 //Added conditional coding to support Beats that don't offer all of these install options
 
-To configure {beatname_uc}, you edit the configuration file. 
-
 ifeval::["{beatname_lc}"!="auditbeat"]
-For rpm and deb, you'll find the configuration file at +/etc/{beatname_lc}/{beatname_lc}.yml+. 
-For mac and win, look in the archive that you just extracted.
-Under Docker, it's located at +/usr/share/{beatname_lc}/{beatname_lc}.yml+.
+
+To configure {beatname_uc}, you edit the configuration file. For rpm and deb,
+you'll find the configuration file at +/etc/{beatname_lc}/{beatname_lc}.yml+. Under
+Docker, it's located at +/usr/share/{beatname_lc}/{beatname_lc}.yml+. For mac and win,
+look in the archive that you just extracted.
+
 endif::[]
 
 ifeval::["{beatname_lc}"=="auditbeat"]
-For rpm and deb, you'll find the configuration file at +/etc/{beatname_lc}/{beatname_lc}.yml+. 
-For mac and win, look in the archive that you just extracted.
-endif::[]
 
+To configure {beatname_uc}, you edit the configuration file. For rpm and deb,
+you'll find the configuration file at +/etc/{beatname_lc}/{beatname_lc}.yml+.
+For mac and win, look in the archive that you just extracted. There’s also a
+full example configuration file called +{beatname_lc}.reference.yml+ that shows
+all non-deprecated options.
 
-ifeval::["{beatname_lc}"!="apm-server"]
-There’s also a full example configuration file called +{beatname_lc}.reference.yml+ 
-that shows all non-deprecated options.
 endif::[]
 
-TIP: See the
+See the
 {libbeat}/config-file-format.html[Config File Format] section of the
 _Beats Platform Reference_ for more about the structure of the config file.
diff --git a/docs/copied-from-beats/shared-ssl-config.asciidoc b/docs/copied-from-beats/shared-ssl-config.asciidoc
@@ -168,17 +168,3 @@ are `never`, `once`, and `freely`. The default value is never.
 * `never` - Disables renegotiation.
 * `once` - Allows a remote server to request renegotiation once per connection.
 * `freely` - Allows a remote server to repeatedly request renegotiation.
-
-ifeval::["{beatname_lc}" == "filebeat"]
-[float]
-==== `client_authentication`
-
-This configures what types of client authentication are supported. The valid options
-are `none`, `optional`, and `required`. The default value is required.
-
-NOTE: This option is only valid with the TCP or the Syslog input.
-
-* `none` - Disables client authentification.
-* `optional` - When a client certificate is given, the server will verify it.
-* `required` - Will require clients to provide a valid certificate.
-endif::[]
diff --git a/docs/copied-from-beats/shared-template-load.asciidoc b/docs/copied-from-beats/shared-template-load.asciidoc
@@ -176,14 +176,15 @@ endif::[]
 endif::allplatforms[]
 
 Open a PowerShell prompt as an Administrator (right-click the PowerShell icon
-and select *Run As Administrator*).
+and select *Run As Administrator*). If you are running Windows XP, you may need
+to download and install PowerShell.
 
 From the PowerShell prompt, change to the directory where you installed {beatname_uc},
 and run:
 
-["source","sh",subs="attributes"]
+["source","sh",subs="attributes,callouts"]
 ----------------------------------------------------------------------
-PS > .{backslash}{beatname_lc}.exe setup --template{disable_logstash} -E 'output.elasticsearch.hosts=["localhost:9200"]'
+PS > .{backslash}{beatname_lc} setup --template{disable_logstash} -E 'output.elasticsearch.hosts=["localhost:9200"]'
 ----------------------------------------------------------------------
 
 
@@ -238,12 +239,12 @@ ifdef::allplatforms[]
 ./{beatname_lc} export template > {beatname_lc}.template.json
 ----
 +
-*win:*
+*win*:
 +
 endif::allplatforms[]
 ["source","sh",subs="attributes"]
 ----
-PS > .{backslash}{beatname_lc}.exe export template --es.version {stack-version} | Out-File -Encoding UTF8 {beatname_lc}.template.json
+PS> .{backslash}{beatname_lc}.exe export template --es.version {stack-version} | Out-File -Encoding UTF8 {beatname_lc}.template.json
 ----
 
 . Install the template:
@@ -255,7 +256,7 @@ PS > .{backslash}{beatname_lc}.exe export template --es.version {stack-version}
 curl -XPUT -H 'Content-Type: application/json' http://localhost:9200/_template/{beatname_lc}-{stack-version} -d@{beatname_lc}.template.json
 ----
 +
-*win:*
+*win*:
 +
 ["source","sh",subs="attributes"]
 ----

diff --git a/docs/copied-from-beats/template-config.asciidoc b/docs/copied-from-beats/template-config.asciidoc
@@ -87,16 +87,4 @@ ifeval::["{beatname_lc}"!="apm-server"]
 
 NOTE: With append_fields only new fields can be added an no existing one overwritten or changed. This is especially useful if data is collected through the http/json metricset where the data structure is not known in advance. Changing the config of append_fields means the template has to be overwritten and only applies to new indices. If there are 2 Beats with different append_fields configs the last one writing the template will win. Any changes will also have an affect on the Kibana Index pattern.
 
-*`setup.template.json.enabled`*:: Set to true to load a json based template file. Specify the path to your Elasticsearch
-index template file and set the name of the template. experimental[]
-
-["source","yaml",subs="attributes"]
-----------------------------------------------------------------------
-setup.template.json.enabled: true
-setup.template.json.path: "template.json"
-setup.template.json.name: "template-name
-----------------------------------------------------------------------
-
-NOTE: If the JSON template is used, the fields.yml is skipped for the template generation.
-
 endif::[]