Skip to content

VPR: Add branch attr to prevent broken links at 8.0 cutover #1289

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

Merged
merged 2 commits into from
Jan 27, 2022
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
32 changes: 17 additions & 15 deletions docs/versioned-plugins/outputs/elasticsearch-v10.7.3.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
:plugin: elasticsearch
:type: output
:no_codec:
:branch: 7.10

///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
Expand Down Expand Up @@ -29,8 +30,8 @@ This output only speaks the HTTP protocol as it is the preferred protocol for
interacting with Elasticsearch. In previous versions it was possible to
communicate with Elasticsearch through the transport protocol, which is now
reserved for internal cluster communication between nodes
https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-transport.html[communication between nodes].
Using the https://www.elastic.co/guide/en/elasticsearch/reference/current/java-clients.html[transport protocol]
https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-transport.html[communication between nodes].
Using the https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/java-clients.html[transport protocol]
to communicate with the cluster has been deprecated in Elasticsearch 7.0.0 and
will be removed in 8.0.0

Expand Down Expand Up @@ -105,7 +106,7 @@ Example:

You can use the `mutate` filter and conditionals to add a `[@metadata]` field
(see
https://www.elastic.co/guide/en/logstash/current/event-dependent-configuration.html#metadata)
https://www.elastic.co/guide/en/logstash/{branch}/event-dependent-configuration.html#metadata)
to set the destination index for each event. The `[@metadata]` fields will not
be sent to Elasticsearch.

Expand Down Expand Up @@ -166,7 +167,7 @@ The Index Lifecycle Management feature requires plugin version `9.3.1` or higher
[NOTE]
This feature requires an Elasticsearch instance of 6.6.0 or higher with at least a Basic license

Logstash can use {ref}/index-lifecycle-management.html[Index Lifecycle Management] to automate the management of indices over time.
Logstash can use https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index-lifecycle-management.html[Index Lifecycle Management] to automate the management of indices over time.

The use of Index Lifecycle Management is controlled by the `ilm_enabled`
setting. By default, this setting detects whether the Elasticsearch instance
Expand All @@ -182,7 +183,7 @@ a default policy will also be created. The default policy is configured to rollo
The default rollover alias is called `logstash`, with a default pattern for the rollover index of `{now/d}-00001`,
which will name indices on the date that the index is rolled over, followed by an incrementing number. Note that the pattern must end with a dash and a number that will be incremented.

See the {ref}/indices-rollover-index.html#_using_date_math_with_the_rollover_api[Rollover API documentation] for more details on naming.
See the https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-rollover-index.html#_using_date_math_with_the_rollover_api[Rollover API documentation] for more details on naming.

The rollover alias, ilm pattern and policy can be modified.

Expand Down Expand Up @@ -227,7 +228,7 @@ enabled by default for HTTP and for Elasticsearch versions 5.0 and later.
You don't have to set any configs in Elasticsearch for it to send back a
compressed response. For versions before 5.0, or if HTTPS is enabled,
`http.compression` must be set to `true`
https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-http.html#modules-http[in
https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-http.html#modules-http[in
Elasticsearch] to take advantage of response compression when using this plugin.

For requests compression, regardless of the Elasticsearch version, enable the
Expand Down Expand Up @@ -335,7 +336,7 @@ The Elasticsearch action to perform. Valid actions are:
- A sprintf style string to change the action based on the content of the event. The value `%{[foo]}`
would use the foo field for the action

For more details on actions, check out the http://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html[Elasticsearch bulk API documentation]
For more details on actions, check out the http://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-bulk.html[Elasticsearch bulk API documentation]

[id="{version}-plugins-{type}s-{plugin}-api_key"]
===== `api_key`
Expand All @@ -345,7 +346,7 @@ For more details on actions, check out the http://www.elastic.co/guide/en/elasti

Authenticate using Elasticsearch API key. Note that this option also requires enabling the `ssl` option.

Format is `id:api_key` where `id` and `api_key` are as returned by the Elasticsearch https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html[Create API key API].
Format is `id:api_key` where `id` and `api_key` are as returned by the Elasticsearch https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-create-api-key.html[Create API key API].

[id="{version}-plugins-{type}s-{plugin}-bulk_path"]
===== `bulk_path`
Expand All @@ -372,7 +373,7 @@ The .cer or .pem file to validate the server's certificate

Cloud authentication string ("<username>:<password>" format) is an alternative for the `user`/`password` pair.

For more details, check out the https://www.elastic.co/guide/en/logstash/current/connecting-to-cloud.html[Logstash-to-Cloud documentation]
For more details, check out the https://www.elastic.co/guide/en/logstash/{branch}/connecting-to-cloud.html[Logstash-to-Cloud documentation]

[id="{version}-plugins-{type}s-{plugin}-cloud_id"]
===== `cloud_id`
Expand All @@ -382,7 +383,7 @@ For more details, check out the https://www.elastic.co/guide/en/logstash/current

Cloud ID, from the Elastic Cloud web console. If set `hosts` should not be used.

For more details, check out the https://www.elastic.co/guide/en/logstash/current/connecting-to-cloud.html[Logstash-to-Cloud documentation]
For more details, check out the https://www.elastic.co/guide/en/logstash/{branch}/connecting-to-cloud.html[Logstash-to-Cloud documentation]

[id="{version}-plugins-{type}s-{plugin}-doc_as_upsert"]
===== `doc_as_upsert`
Expand Down Expand Up @@ -480,7 +481,7 @@ If you have custom firewall rules you may need to change this
* Default value is `[//127.0.0.1]`

Sets the host(s) of the remote instance. If given an array it will load balance requests across the hosts specified in the `hosts` parameter.
Remember the `http` protocol uses the http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-http.html#modules-http[http] address (eg. 9200, not 9300).
Remember the `http` protocol uses the http://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-http.html#modules-http[http] address (eg. 9200, not 9300).

Examples:

Expand All @@ -491,7 +492,7 @@ Examples:
`["https://127.0.0.1:9200/mypath"]` (If using a proxy on a subpath)

Exclude
http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-node.html[dedicated
http://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-node.html[dedicated
master nodes] from the `hosts` list to prevent Logstash from sending bulk
requests to the master nodes. This parameter should reference only data or
client nodes in Elasticsearch.
Expand Down Expand Up @@ -531,14 +532,14 @@ NOTE: This feature requires a Basic License or above to be installed on an Elast
Pattern used for generating indices managed by Index Lifecycle Management. The value specified in the pattern will be appended to
the write alias, and incremented automatically when a new index is created by ILM.

Date Math can be used when specifying an ilm pattern, see {ref}/indices-rollover-index.html#_using_date_math_with_the_rollover_api[Rollover API docs] for details
Date Math can be used when specifying an ilm pattern, see https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-rollover-index.html#_using_date_math_with_the_rollover_api[Rollover API docs] for details

NOTE: Updating the pattern will require the index template to be rewritten

NOTE: The pattern must finish with a dash and a number that will be automatically incremented when indices rollover.

NOTE: The pattern is a 6-digit string padded by zeros, regardless of prior index name. Example: 000001.
See {ref}/indices-rollover-index.html#rollover-index-api-path-params[Rollover path parameters API docs] for details.
See https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-rollover-index.html#rollover-index-api-path-params[Rollover path parameters API docs] for details.

[id="{version}-plugins-{type}s-{plugin}-ilm_policy"]
===== `ilm_policy`
Expand Down Expand Up @@ -963,11 +964,12 @@ See https://www.elastic.co/blog/elasticsearch-versioning-support.

The version_type to use for indexing.
See https://www.elastic.co/blog/elasticsearch-versioning-support.
See also https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html#_version_types
See also https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-index_.html#_version_types



[id="{version}-plugins-{type}s-{plugin}-common-options"]
include::{include_path}/{type}.asciidoc[]

:branch: current
:no_codec!:
32 changes: 17 additions & 15 deletions docs/versioned-plugins/outputs/elasticsearch-v10.8.0.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
:plugin: elasticsearch
:type: output
:no_codec:
:branch: 7.11

///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
Expand Down Expand Up @@ -29,8 +30,8 @@ This output only speaks the HTTP protocol as it is the preferred protocol for
interacting with Elasticsearch. In previous versions it was possible to
communicate with Elasticsearch through the transport protocol, which is now
reserved for internal cluster communication between nodes
https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-transport.html[communication between nodes].
Using the https://www.elastic.co/guide/en/elasticsearch/reference/current/java-clients.html[transport protocol]
https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-transport.html[communication between nodes].
Using the https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/java-clients.html[transport protocol]
to communicate with the cluster has been deprecated in Elasticsearch 7.0.0 and
will be removed in 8.0.0

Expand Down Expand Up @@ -105,7 +106,7 @@ Example:

You can use the `mutate` filter and conditionals to add a `[@metadata]` field
(see
https://www.elastic.co/guide/en/logstash/current/event-dependent-configuration.html#metadata)
https://www.elastic.co/guide/en/logstash/{branch}/event-dependent-configuration.html#metadata)
to set the destination index for each event. The `[@metadata]` fields will not
be sent to Elasticsearch.

Expand Down Expand Up @@ -166,7 +167,7 @@ The Index Lifecycle Management feature requires plugin version `9.3.1` or higher
[NOTE]
This feature requires an Elasticsearch instance of 6.6.0 or higher with at least a Basic license

Logstash can use {ref}/index-lifecycle-management.html[Index Lifecycle Management] to automate the management of indices over time.
Logstash can use https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index-lifecycle-management.html[Index Lifecycle Management] to automate the management of indices over time.

The use of Index Lifecycle Management is controlled by the `ilm_enabled`
setting. By default, this setting detects whether the Elasticsearch instance
Expand All @@ -182,7 +183,7 @@ a default policy will also be created. The default policy is configured to rollo
The default rollover alias is called `logstash`, with a default pattern for the rollover index of `{now/d}-00001`,
which will name indices on the date that the index is rolled over, followed by an incrementing number. Note that the pattern must end with a dash and a number that will be incremented.

See the {ref}/indices-rollover-index.html#_using_date_math_with_the_rollover_api[Rollover API documentation] for more details on naming.
See the https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-rollover-index.html#_using_date_math_with_the_rollover_api[Rollover API documentation] for more details on naming.

The rollover alias, ilm pattern and policy can be modified.

Expand Down Expand Up @@ -227,7 +228,7 @@ enabled by default for HTTP and for Elasticsearch versions 5.0 and later.
You don't have to set any configs in Elasticsearch for it to send back a
compressed response. For versions before 5.0, or if HTTPS is enabled,
`http.compression` must be set to `true`
https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-http.html#modules-http[in
https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-http.html#modules-http[in
Elasticsearch] to take advantage of response compression when using this plugin.

For requests compression, regardless of the Elasticsearch version, enable the
Expand Down Expand Up @@ -335,7 +336,7 @@ The Elasticsearch action to perform. Valid actions are:
- A sprintf style string to change the action based on the content of the event. The value `%{[foo]}`
would use the foo field for the action

For more details on actions, check out the http://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html[Elasticsearch bulk API documentation]
For more details on actions, check out the http://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-bulk.html[Elasticsearch bulk API documentation]

[id="{version}-plugins-{type}s-{plugin}-api_key"]
===== `api_key`
Expand All @@ -345,7 +346,7 @@ For more details on actions, check out the http://www.elastic.co/guide/en/elasti

Authenticate using Elasticsearch API key. Note that this option also requires enabling the `ssl` option.

Format is `id:api_key` where `id` and `api_key` are as returned by the Elasticsearch https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html[Create API key API].
Format is `id:api_key` where `id` and `api_key` are as returned by the Elasticsearch https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-create-api-key.html[Create API key API].

[id="{version}-plugins-{type}s-{plugin}-bulk_path"]
===== `bulk_path`
Expand All @@ -372,7 +373,7 @@ The .cer or .pem file to validate the server's certificate

Cloud authentication string ("<username>:<password>" format) is an alternative for the `user`/`password` pair.

For more details, check out the https://www.elastic.co/guide/en/logstash/current/connecting-to-cloud.html[Logstash-to-Cloud documentation]
For more details, check out the https://www.elastic.co/guide/en/logstash/{branch}/connecting-to-cloud.html[Logstash-to-Cloud documentation]

[id="{version}-plugins-{type}s-{plugin}-cloud_id"]
===== `cloud_id`
Expand All @@ -382,7 +383,7 @@ For more details, check out the https://www.elastic.co/guide/en/logstash/current

Cloud ID, from the Elastic Cloud web console. If set `hosts` should not be used.

For more details, check out the https://www.elastic.co/guide/en/logstash/current/connecting-to-cloud.html[Logstash-to-Cloud documentation]
For more details, check out the https://www.elastic.co/guide/en/logstash/{branch}/connecting-to-cloud.html[Logstash-to-Cloud documentation]

[id="{version}-plugins-{type}s-{plugin}-doc_as_upsert"]
===== `doc_as_upsert`
Expand Down Expand Up @@ -480,7 +481,7 @@ If you have custom firewall rules you may need to change this
* Default value is `[//127.0.0.1]`

Sets the host(s) of the remote instance. If given an array it will load balance requests across the hosts specified in the `hosts` parameter.
Remember the `http` protocol uses the http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-http.html#modules-http[http] address (eg. 9200, not 9300).
Remember the `http` protocol uses the http://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-http.html#modules-http[http] address (eg. 9200, not 9300).

Examples:

Expand All @@ -491,7 +492,7 @@ Examples:
`["https://127.0.0.1:9200/mypath"]` (If using a proxy on a subpath)

Exclude
http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-node.html[dedicated
http://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-node.html[dedicated
master nodes] from the `hosts` list to prevent Logstash from sending bulk
requests to the master nodes. This parameter should reference only data or
client nodes in Elasticsearch.
Expand Down Expand Up @@ -531,14 +532,14 @@ NOTE: This feature requires a Basic License or above to be installed on an Elast
Pattern used for generating indices managed by Index Lifecycle Management. The value specified in the pattern will be appended to
the write alias, and incremented automatically when a new index is created by ILM.

Date Math can be used when specifying an ilm pattern, see {ref}/indices-rollover-index.html#_using_date_math_with_the_rollover_api[Rollover API docs] for details
Date Math can be used when specifying an ilm pattern, see https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-rollover-index.html#_using_date_math_with_the_rollover_api[Rollover API docs] for details

NOTE: Updating the pattern will require the index template to be rewritten

NOTE: The pattern must finish with a dash and a number that will be automatically incremented when indices rollover.

NOTE: The pattern is a 6-digit string padded by zeros, regardless of prior index name. Example: 000001.
See {ref}/indices-rollover-index.html#rollover-index-api-path-params[Rollover path parameters API docs] for details.
See https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-rollover-index.html#rollover-index-api-path-params[Rollover path parameters API docs] for details.

[id="{version}-plugins-{type}s-{plugin}-ilm_policy"]
===== `ilm_policy`
Expand Down Expand Up @@ -963,11 +964,12 @@ See https://www.elastic.co/blog/elasticsearch-versioning-support.

The version_type to use for indexing.
See https://www.elastic.co/blog/elasticsearch-versioning-support.
See also https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html#_version_types
See also https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-index_.html#_version_types



[id="{version}-plugins-{type}s-{plugin}-common-options"]
include::{include_path}/{type}.asciidoc[]

:branch: current
:no_codec!:
Loading