Skip to content

Commit

Permalink
Stardardize obsolete documentation
Browse files Browse the repository at this point in the history
This commit updates the documentation to follow the pattern established in
logstash-plugins/logstash-output-http#147 for
documenting obsolete options.
  • Loading branch information
donoghuc committed Dec 9, 2024
1 parent eb71df9 commit e0ff435
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 43 deletions.
54 changes: 12 additions & 42 deletions docs/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,9 @@ TIP: Set the `target` option to avoid potential schema conflicts.

This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> and the <<plugins-{type}s-{plugin}-deprecated-options>> described later.

NOTE: As of version `5.0.0` of this plugin, a number of previously deprecated settings related to SSL have been removed.
Please check out <<plugins-{type}s-{plugin}-obsolete-options>> for details.

[cols="<,<,<",options="header",]
|=======================================================================
|Setting |Input type|Required
Expand Down Expand Up @@ -610,54 +613,21 @@ option when authenticating to the Elasticsearch server. If set to an
empty string authentication will be disabled.


[id="plugins-{type}s-{plugin}-removed-options"]
==== Elasticsearch Input Removed configuration options
[id="plugins-{type}s-{plugin}-obsolete-options"]
==== Elasticsearch Input Obsolete Configuration Options

The following configurations will be removed in version 5.0.0.
WARNING: As of version `5.0.0` of this plugin, some configuration options have been replaced.
The plugin will fail to start if it contains any of these obsolete options.

WARNING: These options have been deprecated and will be removed in version 5.0.0. Please use their replacements instead.

[cols="<,<,<",options="header",]
[cols="<,<",options="header",]
|=======================================================================
|Setting|Input type|Replaced by
| <<plugins-{type}s-{plugin}-ca_file>> |a valid filesystem path|<<plugins-{type}s-{plugin}-ssl_certificate_authorities>>
| <<plugins-{type}s-{plugin}-ssl>> |<<boolean,boolean>>|<<plugins-{type}s-{plugin}-ssl_enabled>>
| <<plugins-{type}s-{plugin}-ssl_certificate_verification>> |<<boolean,boolean>>|<<plugins-{type}s-{plugin}-ssl_verification_mode>>
|Setting|Replaced by
| ca_file | <<plugins-{type}s-{plugin}-ssl_certificate_authorities>>
| ssl | <<plugins-{type}s-{plugin}-ssl_enabled>>
| ssl_certificate_verification | <<plugins-{type}s-{plugin}-ssl_verification_mode>>
|=======================================================================

[id="plugins-{type}s-{plugin}-ca_file"]
===== `ca_file`
deprecated[4.17.0, Will be removed in 5.0.0, replaced by <<plugins-{type}s-{plugin}-ssl_certificate_authorities>>]

This setting will be removed in 5.0.0. Please use <<plugins-{type}s-{plugin}-ssl_certificate_authorities>> instead.

* Value type is <<path,path>>
* There is no default value for this setting.

SSL Certificate Authority file in PEM encoded format, must also include any chain certificates as necessary.

[id="plugins-{type}s-{plugin}-ssl"]
===== `ssl`
deprecated[4.17.0, Will be removed in 5.0.0, replaced by <<plugins-{type}s-{plugin}-ssl_enabled>>]

This setting will be removed in 5.0.0. Please use <<plugins-{type}s-{plugin}-ssl_enabled>> instead.

* Value type is <<boolean,boolean>>
* Default value is `false`

If enabled, SSL will be used when communicating with the Elasticsearch
server (i.e. HTTPS will be used instead of plain HTTP).


[id="plugins-{type}s-{plugin}-ssl_certificate_verification"]
===== `ssl_certificate_verification`
deprecated[4.17.0, Will be removed in 5.0.0, replaced by <<plugins-{type}s-{plugin}-ssl_verification_mode>>]

This setting will be removed in 5.0.0. Please use <<plugins-{type}s-{plugin}-ssl_verification_mode>> instead.


* Value type is <<boolean,boolean>>
* Default value is `true`

Option to validate the server's certificate. Disabling this severely compromises security.
When certificate validation is disabled, this plugin implicitly trusts the machine
Expand Down
1 change: 0 additions & 1 deletion lib/logstash/inputs/elasticsearch.rb
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,6 @@ class LogStash::Inputs::Elasticsearch < LogStash::Inputs::Base
config :ssl_truststore_password, :validate => :password

# The JKS truststore to validate the server's certificate.
# Use either `:ssl_truststore_path`
config :ssl_truststore_path, :validate => :path

# The format of the truststore file. It must be either jks or pkcs12
Expand Down

0 comments on commit e0ff435

Please sign in to comment.