[6.7] Backport: Reconcile duplicated attributes (#11397)

* Reconcile duplicated attributes (#10956) * Replace libbeat with beats-ref * Replace metricbeat with metricbeat-ref * Replace filebeat with filebeat-ref * Replace auditbeat with auditbeat-ref * Replace logstashdoc with logstash-ref * Replace elasticsearch with ref * Replace elasticsearch-plugins with plugins * Replace securitydoc with stack-ov * Replace monitoringdoc with stack-ov * Remove unused attributes * Replace doc-branch with branch * Replace remaining attributes
elastic · Mar 22, 2019 · bb5f63a · bb5f63a
1 parent d92d2e9
commit bb5f63a
Show file tree

Hide file tree

Showing 70 changed files with 102 additions and 117 deletions.
diff --git a/auditbeat/docs/configuring-howto.asciidoc b/auditbeat/docs/configuring-howto.asciidoc
@@ -14,7 +14,7 @@ There's also a full example configuration file at
 options. For mac and win, look in the archive that you extracted.
 
 The {beatname_uc} configuration file uses http://yaml.org/[YAML] for its syntax.
-See the {libbeat}/config-file-format.html[Config File Format] section of the
+See the {beats-ref}/config-file-format.html[Config File Format] section of the
 _Beats Platform Reference_ for more about the structure of the config file.
 
 The following topics describe how to configure {beatname_uc}:

diff --git a/auditbeat/docs/getting-started.asciidoc b/auditbeat/docs/getting-started.asciidoc
@@ -238,7 +238,7 @@ 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
 `--strict.perms=false` specified. See
-{libbeat}/config-file-permissions.html[Config File Ownership and Permissions]
+{beats-ref}/config-file-permissions.html[Config File Ownership and Permissions]
 in the _Beats Platform Reference_.
 
 If you see a warning about too many open files, you need to increase the

diff --git a/auditbeat/docs/reload-configuration.asciidoc b/auditbeat/docs/reload-configuration.asciidoc
@@ -44,4 +44,4 @@ definitions. For example:
 
 NOTE: On systems with POSIX file permissions, all Beats configuration files are
 subject to ownership and file permission checks. If you encounter config loading
-errors related to file ownership, see {libbeat}/config-file-permissions.html.
+errors related to file ownership, see {beats-ref}/config-file-permissions.html.
diff --git a/docs/devguide/create-metricset.asciidoc b/docs/devguide/create-metricset.asciidoc
@@ -272,7 +272,7 @@ NOTE: Make sure that you run `make collect` after updating the config file
 so that your changes are also applied to the global configuration file and the docs.
 
 For more details about the Metricbeat configuration file, see the topic about
-{metricbeat}/configuration-metricbeat.html[Modules] in the Metricbeat
+{metricbeat-ref}/configuration-metricbeat.html[Modules] in the Metricbeat
 documentation.
 
 

diff --git a/docs/devguide/creating-beat-from-metricbeat.asciidoc b/docs/devguide/creating-beat-from-metricbeat.asciidoc
@@ -26,12 +26,12 @@ go get github.com/elastic/beats/metricbeat
 ----
 
 This will clone the beats repository into `GOPATH`. By default `go get`  fetches the master branch. To build your beat
-on a specific version of libbeat, check out the specific branch ({doc-branch} in the example below):
+on a specific version of libbeat, check out the specific branch ({branch} in the example below):
 
 ["source","sh",subs="attributes"]
 ----
 cd ${GOPATH}/src/github.com/elastic/beats
-git checkout {doc-branch}
+git checkout {branch}
 ----
 
 Note: If you have multiple go paths use `${GOPATH%%:*}`instead of `${GOPATH}`.

diff --git a/docs/devguide/modules-dev-guide.asciidoc b/docs/devguide/modules-dev-guide.asciidoc
@@ -274,7 +274,7 @@ used to construct the `paths` list for the input `paths` option.
 Any template files that you add to the `config/` folder need to generate a valid
 Filebeat input configuration in YAML format. The options accepted by the
 input configuration are documented in the
-{filebeat}/configuration-filebeat-options.html[Filebeat Inputs] section of
+{filebeat-ref}/configuration-filebeat-options.html[Filebeat Inputs] section of
 the Filebeat documentation.
 
 The template files use the templating language defined by the
@@ -304,12 +304,12 @@ variables to dynamically switch between configurations.
 ==== ingest/*.json
 
 The `ingest/` folder contains Elasticsearch
-{elasticsearch}/ingest.html[Ingest Node] pipeline configurations. The Ingest
+{ref}/ingest.html[Ingest Node] pipeline configurations. The Ingest
 Node pipelines are responsible for parsing the log lines and doing other
 manipulations on the data.
 
 The files in this folder are JSON documents representing
-{elasticsearch}/pipeline.html[pipeline definitions]. Just like with the `config/`
+{ref}/pipeline.html[pipeline definitions]. Just like with the `config/`
 folder, you can define multiple pipelines, but a single one is loaded at runtime
 based on the information from `manifest.yml`.
 
@@ -332,9 +332,9 @@ The generator creates a JSON object similar to this one:
 
 From here, you would typically add processors to the `processors` array to do
 the actual parsing. For details on how to use ingest node processors, see the
-{elasticsearch}/ingest-processors.html[ingest node documentation]. In
+{ref}/ingest-processors.html[ingest node documentation]. In
 particular, you will likely find the
-{elasticsearch}/grok-processor.html[Grok processor] to be useful for parsing.
+{ref}/grok-processor.html[Grok processor] to be useful for parsing.
 Here is an example for parsing the Nginx access logs.
 
 [source,json]
@@ -412,7 +412,7 @@ ingest_pipeline:
 ----
 
 While developing the pipeline definition, we recommend making use of the
-{elasticsearch}/simulate-pipeline-api.html[Simulate Pipeline API] for testing
+{ref}/simulate-pipeline-api.html[Simulate Pipeline API] for testing
 and quick iteration.
 
 By default Filebeat does not update Ingest pipelines if already loaded. If you

diff --git a/docs/devguide/newbeat.asciidoc b/docs/devguide/newbeat.asciidoc
@@ -50,12 +50,12 @@ git clone https://github.com/elastic/beats ${GOPATH}/src/github.com/elastic/beat
 ----------------------------------------------------------------------
 
 To build your beat
-on a specific version of libbeat, check out the specific branch ({doc-branch} in the example below):
+on a specific version of libbeat, check out the specific branch ({branch} in the example below):
 
 ["source","sh",subs="attributes"]
 ----
 cd ${GOPATH}/src/github.com/elastic/beats
-git checkout {doc-branch}
+git checkout {branch}
 ----
 
 NOTE: If you have multiple go paths, use `${GOPATH%%:*}` instead of `${GOPATH}`.
@@ -494,4 +494,4 @@ func main() {
 === Sharing Your Beat with the Community
 
 When you're done with your new Beat, how about letting everyone know? Open
-a pull request to add your link to the {libbeat}/community-beats.html[Community Beats] list.
+a pull request to add your link to the {beats-ref}/community-beats.html[Community Beats] list.
diff --git a/filebeat/docs/configuring-howto.asciidoc b/filebeat/docs/configuring-howto.asciidoc
@@ -14,7 +14,7 @@ There's also a full example configuration file at
 options. For mac and win, look in the archive that you extracted.
 
 The {beatname_uc} configuration file uses http://yaml.org/[YAML] for its syntax.
-See the {libbeat}/config-file-format.html[Config File Format] section of the
+See the {beats-ref}/config-file-format.html[Config File Format] section of the
 _Beats Platform Reference_ for more about the structure of the config file.
 
 include::../../libbeat/docs/shared-cm-tip.asciidoc[]

diff --git a/filebeat/docs/faq.asciidoc b/filebeat/docs/faq.asciidoc
@@ -96,7 +96,7 @@ The index template might not be loaded correctly. See <<filebeat-template>>.
 
 If you have recently performed an operation that loads or parses custom, structured logs,
 you might need to refresh the index to make the fields available in Kibana. To refresh
-the index, use the {elasticsearch}/indices-refresh.html[refresh API]. For example:
+the index, use the {ref}/indices-refresh.html[refresh API]. For example:
 
 ["source","sh"]
 ----------------------------------------------------------------------

diff --git a/filebeat/docs/getting-started.asciidoc b/filebeat/docs/getting-started.asciidoc
@@ -243,7 +243,7 @@ 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`
 specified. See
-{libbeat}/config-file-permissions.html[Config File Ownership and Permissions]
+{beats-ref}/config-file-permissions.html[Config File Ownership and Permissions]
 in the _Beats Platform Reference_.
 
 *win:*
@@ -276,7 +276,7 @@ To populate the example dashboards with data, you need to either
 <<configuring-ingest-node,define ingest node pipelines>> or use Logstash to
 parse the data into the fields expected by the dashboards. If you are using
 Logstash, see the
-{logstashdoc}/logstash-config-for-filebeat-modules.html[configuration examples]
+{logstash-ref}/logstash-config-for-filebeat-modules.html[configuration examples]
 in the Logstash documentation for help parsing the log formats supported
 by the dashboards.
 

diff --git a/filebeat/docs/include/run-command.asciidoc b/filebeat/docs/include/run-command.asciidoc
@@ -32,7 +32,7 @@ If the module is configured correctly, you'll see
 
 NOTE: Depending on how you've installed {beatname_uc}, you might see errors
 related to file ownership or permissions when you try to run {beatname_uc}
-modules. See {libbeat}/config-file-permissions.html[Config File Ownership and
+modules. See {beats-ref}/config-file-permissions.html[Config File Ownership and
 Permissions] in the _Beats Platform Reference_ for more information.
 
 --
diff --git a/filebeat/docs/migration.asciidoc b/filebeat/docs/migration.asciidoc
@@ -12,7 +12,7 @@ to use for tailing log files and forwarding them to Logstash.
 * The registry file, which stores the state of the currently read files, was
   changed.
 * Command line options were removed and moved to the configuration file.
-* Configuration options for outputs are now inherited from libbeat. For details, see the {libbeat}/index.html[Beats Platform Reference].
+* Configuration options for outputs are now inherited from libbeat. For details, see the {beats-ref}/index.html[Beats Platform Reference].
 * The {logstash-ref}/plugins-inputs-beats.html[Beats input plugin for Logstash] is required.
 
 The following topics describe how to migrate from

diff --git a/filebeat/docs/modules-overview.asciidoc b/filebeat/docs/modules-overview.asciidoc
@@ -13,7 +13,7 @@ the following:
   The {beatname_uc} configuration is also responsible with stitching together
   multiline events when needed.
 
-* Elasticsearch {elasticsearch}/ingest.html[Ingest Node] pipeline definition,
+* Elasticsearch {ref}/ingest.html[Ingest Node] pipeline definition,
   which is used to parse the log lines.
 
 * Fields definitions, which are used to configure Elasticsearch with the

diff --git a/filebeat/docs/modules/apache2.asciidoc b/filebeat/docs/modules/apache2.asciidoc
@@ -17,8 +17,8 @@ include::../include/what-happens.asciidoc[]
 === Compatibility
 
 With Elasticsearch < 6.7, this module requires the
-{elasticsearch-plugins}/ingest-user-agent.html[ingest-user-agent] and
-{elasticsearch-plugins}/ingest-geoip.html[ingest-geoip] Elasticsearch plugins.
+{plugins}/ingest-user-agent.html[ingest-user-agent] and
+{plugins}/ingest-geoip.html[ingest-geoip] Elasticsearch plugins.
 
 
 The +{modulename}+ module was tested with logs from versions 2.2.22 and 2.4.23.

diff --git a/filebeat/docs/modules/iis.asciidoc b/filebeat/docs/modules/iis.asciidoc
@@ -17,8 +17,8 @@ include::../include/what-happens.asciidoc[]
 === Compatibility
 
 With Elasticsearch < 6.7, this module requires the
-{elasticsearch-plugins}/ingest-user-agent.html[ingest-user-agent] and
-{elasticsearch-plugins}/ingest-geoip.html[ingest-geoip] Elasticsearch plugins.
+{plugins}/ingest-user-agent.html[ingest-user-agent] and
+{plugins}/ingest-geoip.html[ingest-geoip] Elasticsearch plugins.
 
 The IIS module was tested with logs from version 7.5 and version 10.
 

diff --git a/filebeat/docs/modules/iptables.asciidoc b/filebeat/docs/modules/iptables.asciidoc
@@ -28,7 +28,7 @@ When you run the module, it performs a few tasks under the hood:
 [float]
 === Compatibility
 
-This module requires the {elasticsearch-plugins}/ingest-geoip.html[ingest-geoip]
+This module requires the {plugins}/ingest-geoip.html[ingest-geoip]
 Elasticsearch plugins.
 
 include::../include/running-modules.asciidoc[]

diff --git a/filebeat/docs/modules/logstash.asciidoc b/filebeat/docs/modules/logstash.asciidoc
@@ -20,7 +20,7 @@ The +{modulename}+ module has two filesets:
 
 
 For the `slowlog` fileset, make sure to configure the
-{logstashdoc}/logging.html#_slowlog[Logstash slowlog option].
+{logstash-ref}/logging.html#_slowlog[Logstash slowlog option].
 
 [float]
 === Compatibility

diff --git a/filebeat/docs/modules/nginx.asciidoc b/filebeat/docs/modules/nginx.asciidoc
@@ -18,8 +18,8 @@ include::../include/what-happens.asciidoc[]
 === Compatibility
 
 With Elasticsearch < 6.7, this module requires the
-{elasticsearch-plugins}/ingest-user-agent.html[ingest-user-agent] and
-{elasticsearch-plugins}/ingest-geoip.html[ingest-geoip] Elasticsearch plugins.
+{plugins}/ingest-user-agent.html[ingest-user-agent] and
+{plugins}/ingest-geoip.html[ingest-geoip] Elasticsearch plugins.
 
 The Nginx module was tested with logs from version 1.10.
 

diff --git a/filebeat/docs/modules/suricata.asciidoc b/filebeat/docs/modules/suricata.asciidoc
@@ -19,8 +19,8 @@ include::../include/what-happens.asciidoc[]
 [float]
 === Compatibility
 
-This module requires the {elasticsearch-plugins}/ingest-geoip.html[ingest-geoip]
-and {elasticsearch-plugins}/ingest-user-agent.html[ingest-user-agent]
+This module requires the {plugins}/ingest-geoip.html[ingest-geoip]
+and {plugins}/ingest-user-agent.html[ingest-user-agent]
 Elasticsearch plugins.
 
 This module has been developed against Suricata v4.0.4, but is expected to work

diff --git a/filebeat/docs/modules/system.asciidoc b/filebeat/docs/modules/system.asciidoc
@@ -20,8 +20,8 @@ This module was tested with logs from OSes like Ubuntu 12.04, Centos 7, and
 macOS Sierra.
 
 With Elasticsearch < 6.7, this module requires the
-{elasticsearch-plugins}/ingest-user-agent.html[ingest-user-agent] and
-{elasticsearch-plugins}/ingest-geoip.html[ingest-geoip] Elasticsearch plugins.
+{plugins}/ingest-user-agent.html[ingest-user-agent] and
+{plugins}/ingest-geoip.html[ingest-geoip] Elasticsearch plugins.
 
 This module is not available for Windows.
 

diff --git a/filebeat/docs/modules/traefik.asciidoc b/filebeat/docs/modules/traefik.asciidoc
@@ -17,8 +17,8 @@ include::../include/what-happens.asciidoc[]
 === Compatibility
 
 With Elasticsearch < 6.7, this module requires the
-{elasticsearch-plugins}/ingest-user-agent.html[ingest-user-agent] and
-{elasticsearch-plugins}/ingest-geoip.html[ingest-geoip] Elasticsearch plugins.
+{plugins}/ingest-user-agent.html[ingest-user-agent] and
+{plugins}/ingest-geoip.html[ingest-geoip] Elasticsearch plugins.
 
 include::../include/running-modules.asciidoc[]
 

diff --git a/filebeat/docs/running-on-kubernetes.asciidoc b/filebeat/docs/running-on-kubernetes.asciidoc
@@ -29,7 +29,7 @@ To download the manifest file, run:
 
 ["source", "sh", subs="attributes"]
 ------------------------------------------------
-curl -L -O https://raw.githubusercontent.com/elastic/beats/{doc-branch}/deploy/kubernetes/filebeat-kubernetes.yaml
+curl -L -O https://raw.githubusercontent.com/elastic/beats/{branch}/deploy/kubernetes/filebeat-kubernetes.yaml
 ------------------------------------------------
 
 [WARNING]

diff --git a/filebeat/docs/upgrading.asciidoc b/filebeat/docs/upgrading.asciidoc
@@ -3,5 +3,5 @@
 
 For information about upgrading to a new version, see the following topics in the _Beats Platform Reference_:
 
-* {libbeat}/breaking-changes.html[Breaking Changes]
-* {libbeat}/upgrading.html[Upgrading]
+* {beats-ref}/breaking-changes.html[Breaking Changes]
+* {beats-ref}/upgrading.html[Upgrading]
diff --git a/filebeat/module/apache2/_meta/docs.asciidoc b/filebeat/module/apache2/_meta/docs.asciidoc
@@ -12,8 +12,8 @@ include::../include/what-happens.asciidoc[]
 === Compatibility
 
 With Elasticsearch < 6.7, this module requires the
-{elasticsearch-plugins}/ingest-user-agent.html[ingest-user-agent] and
-{elasticsearch-plugins}/ingest-geoip.html[ingest-geoip] Elasticsearch plugins.
+{plugins}/ingest-user-agent.html[ingest-user-agent] and
+{plugins}/ingest-geoip.html[ingest-geoip] Elasticsearch plugins.
 
 
 The +{modulename}+ module was tested with logs from versions 2.2.22 and 2.4.23.

diff --git a/filebeat/module/iis/_meta/docs.asciidoc b/filebeat/module/iis/_meta/docs.asciidoc
@@ -12,8 +12,8 @@ include::../include/what-happens.asciidoc[]
 === Compatibility
 
 With Elasticsearch < 6.7, this module requires the
-{elasticsearch-plugins}/ingest-user-agent.html[ingest-user-agent] and
-{elasticsearch-plugins}/ingest-geoip.html[ingest-geoip] Elasticsearch plugins.
+{plugins}/ingest-user-agent.html[ingest-user-agent] and
+{plugins}/ingest-geoip.html[ingest-geoip] Elasticsearch plugins.
 
 The IIS module was tested with logs from version 7.5 and version 10.
 

diff --git a/filebeat/module/logstash/_meta/docs.asciidoc b/filebeat/module/logstash/_meta/docs.asciidoc
@@ -15,7 +15,7 @@ The +{modulename}+ module has two filesets:
 
 
 For the `slowlog` fileset, make sure to configure the
-{logstashdoc}/logging.html#_slowlog[Logstash slowlog option].
+{logstash-ref}/logging.html#_slowlog[Logstash slowlog option].
 
 [float]
 === Compatibility

diff --git a/filebeat/module/nginx/_meta/docs.asciidoc b/filebeat/module/nginx/_meta/docs.asciidoc
@@ -13,8 +13,8 @@ include::../include/what-happens.asciidoc[]
 === Compatibility
 
 With Elasticsearch < 6.7, this module requires the
-{elasticsearch-plugins}/ingest-user-agent.html[ingest-user-agent] and
-{elasticsearch-plugins}/ingest-geoip.html[ingest-geoip] Elasticsearch plugins.
+{plugins}/ingest-user-agent.html[ingest-user-agent] and
+{plugins}/ingest-geoip.html[ingest-geoip] Elasticsearch plugins.
 
 The Nginx module was tested with logs from version 1.10.
 

diff --git a/filebeat/module/system/_meta/docs.asciidoc b/filebeat/module/system/_meta/docs.asciidoc
@@ -15,8 +15,8 @@ This module was tested with logs from OSes like Ubuntu 12.04, Centos 7, and
 macOS Sierra.
 
 With Elasticsearch < 6.7, this module requires the
-{elasticsearch-plugins}/ingest-user-agent.html[ingest-user-agent] and
-{elasticsearch-plugins}/ingest-geoip.html[ingest-geoip] Elasticsearch plugins.
+{plugins}/ingest-user-agent.html[ingest-user-agent] and
+{plugins}/ingest-geoip.html[ingest-geoip] Elasticsearch plugins.
 
 This module is not available for Windows.
 

diff --git a/filebeat/module/traefik/_meta/docs.asciidoc b/filebeat/module/traefik/_meta/docs.asciidoc
@@ -12,8 +12,8 @@ include::../include/what-happens.asciidoc[]
 === Compatibility
 
 With Elasticsearch < 6.7, this module requires the
-{elasticsearch-plugins}/ingest-user-agent.html[ingest-user-agent] and
-{elasticsearch-plugins}/ingest-geoip.html[ingest-geoip] Elasticsearch plugins.
+{plugins}/ingest-user-agent.html[ingest-user-agent] and
+{plugins}/ingest-geoip.html[ingest-geoip] Elasticsearch plugins.
 
 include::../include/running-modules.asciidoc[]
 

diff --git a/heartbeat/docs/configuring-howto.asciidoc b/heartbeat/docs/configuring-howto.asciidoc
@@ -16,7 +16,7 @@ extracted.
 
 The Heartbeat configuration file uses http://yaml.org/[YAML] for its syntax.
 See the
-{libbeat}/config-file-format.html[Config File Format] section of the
+{beats-ref}/config-file-format.html[Config File Format] section of the
 _Beats Platform Reference_ for more about the structure of the config file.
 
 The following topics describe how to configure Heartbeat:

diff --git a/heartbeat/docs/getting-started.asciidoc b/heartbeat/docs/getting-started.asciidoc
@@ -243,7 +243,7 @@ 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
-{libbeat}/config-file-permissions.html[Config File Ownership and Permissions]
+{beats-ref}/config-file-permissions.html[Config File Ownership and Permissions]
 in the _Beats Platform Reference_.
 
 *win:*

diff --git a/heartbeat/docs/overview.asciidoc b/heartbeat/docs/overview.asciidoc
@@ -7,7 +7,7 @@
 
 Heartbeat is a lightweight daemon that you install on a remote server
 to periodically check the status of your services and determine whether they are
-available. Unlike {metricbeat}/index.html[Metricbeat], which only tells you if
+available. Unlike {metricbeat-ref}/index.html[Metricbeat], which only tells you if
 your servers are up or down, Heartbeat tells you whether your services are
 reachable.
 

diff --git a/journalbeat/docs/getting-started.asciidoc b/journalbeat/docs/getting-started.asciidoc
@@ -196,7 +196,7 @@ sudo ./{beatname_lc} -e
 <1> You'll be running {beatname_uc} as root, so you need to change ownership
 of the configuration file, or run {beatname_uc} with `--strict.perms=false`
 specified. See
-{libbeat}/config-file-permissions.html[Config File Ownership and Permissions]
+{beats-ref}/config-file-permissions.html[Config File Ownership and Permissions]
 in the _Beats Platform Reference_.
 
 {beatname_uc} is now ready to send journal events to the defined output.

diff --git a/libbeat/docs/breaking.asciidoc b/libbeat/docs/breaking.asciidoc
@@ -15,7 +15,7 @@ See the following topics for a description of breaking changes:
 * <<breaking-changes-6.2>>
 * <<breaking-changes-6.1>>
 * <<breaking-changes-6.0>>
-* {auditbeat}/auditbeat-breaking-changes.html[Breaking changes in Auditbeat 6.2]
+* {auditbeat-ref}/auditbeat-breaking-changes.html[Breaking changes in Auditbeat 6.2]
 
 [[breaking-changes-6.3]]
 === Breaking changes in 6.3
@@ -287,7 +287,7 @@ templates will not be applied.
 
 The `document_type` setting, from the prospector configuration, was removed
 because the `_type` concept is being
-{elasticsearch}/removal-of-types.html[removed from Elasticsearch]. Instead of
+{ref}/removal-of-types.html[removed from Elasticsearch]. Instead of
 the `document_type` setting, you can use a custom field.
 
 This has led also to the rename of the `input_type` configuration setting to