Skip to content

Commit c2bd0e6

Browse files
committed
Stardardize obsolete documentation
This commit updates the documentation to follow the pattern established in logstash-plugins/logstash-output-http#147 for documenting obsolete options.
1 parent 75ffe8d commit c2bd0e6

File tree

1 file changed

+12
-42
lines changed

1 file changed

+12
-42
lines changed

docs/index.asciidoc

Lines changed: 12 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,9 @@ TIP: Set the `target` option to avoid potential schema conflicts.
9898

9999
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.
100100

101+
NOTE: As of version `5.0.0` of this plugin, a number of previously deprecated settings related to SSL have been removed.
102+
Please check out <<plugins-{type}s-{plugin}-obsolete-options>> for details.
103+
101104
[cols="<,<,<",options="header",]
102105
|=======================================================================
103106
|Setting |Input type|Required
@@ -610,54 +613,21 @@ option when authenticating to the Elasticsearch server. If set to an
610613
empty string authentication will be disabled.
611614

612615

613-
[id="plugins-{type}s-{plugin}-removed-options"]
614-
==== Elasticsearch Input Removed configuration options
616+
[id="plugins-{type}s-{plugin}-obsolete-options"]
617+
==== HTTP Output Obsolete Configuration Options
615618

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

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

620-
[cols="<,<,<",options="header",]
623+
[cols="<,<",options="header",]
621624
|=======================================================================
622-
|Setting|Input type|Replaced by
623-
| <<plugins-{type}s-{plugin}-ca_file>> |a valid filesystem path|<<plugins-{type}s-{plugin}-ssl_certificate_authorities>>
624-
| <<plugins-{type}s-{plugin}-ssl>> |<<boolean,boolean>>|<<plugins-{type}s-{plugin}-ssl_enabled>>
625-
| <<plugins-{type}s-{plugin}-ssl_certificate_verification>> |<<boolean,boolean>>|<<plugins-{type}s-{plugin}-ssl_verification_mode>>
625+
|Setting|Replaced by
626+
| ca_file | <<plugins-{type}s-{plugin}-ssl_certificate_authorities>>
627+
| ssl | <<plugins-{type}s-{plugin}-ssl_enabled>>
628+
| ssl_certificate_verification | <<plugins-{type}s-{plugin}-ssl_verification_mode>>
626629
|=======================================================================
627630

628-
[id="plugins-{type}s-{plugin}-ca_file"]
629-
===== `ca_file`
630-
deprecated[4.17.0, Will be removed in 5.0.0, replaced by <<plugins-{type}s-{plugin}-ssl_certificate_authorities>>]
631-
632-
This setting will be removed in 5.0.0. Please use <<plugins-{type}s-{plugin}-ssl_certificate_authorities>> instead.
633-
634-
* Value type is <<path,path>>
635-
* There is no default value for this setting.
636-
637-
SSL Certificate Authority file in PEM encoded format, must also include any chain certificates as necessary.
638-
639-
[id="plugins-{type}s-{plugin}-ssl"]
640-
===== `ssl`
641-
deprecated[4.17.0, Will be removed in 5.0.0, replaced by <<plugins-{type}s-{plugin}-ssl_enabled>>]
642-
643-
This setting will be removed in 5.0.0. Please use <<plugins-{type}s-{plugin}-ssl_enabled>> instead.
644-
645-
* Value type is <<boolean,boolean>>
646-
* Default value is `false`
647-
648-
If enabled, SSL will be used when communicating with the Elasticsearch
649-
server (i.e. HTTPS will be used instead of plain HTTP).
650-
651-
652-
[id="plugins-{type}s-{plugin}-ssl_certificate_verification"]
653-
===== `ssl_certificate_verification`
654-
deprecated[4.17.0, Will be removed in 5.0.0, replaced by <<plugins-{type}s-{plugin}-ssl_verification_mode>>]
655-
656-
This setting will be removed in 5.0.0. Please use <<plugins-{type}s-{plugin}-ssl_verification_mode>> instead.
657-
658-
659-
* Value type is <<boolean,boolean>>
660-
* Default value is `true`
661631

662632
Option to validate the server's certificate. Disabling this severely compromises security.
663633
When certificate validation is disabled, this plugin implicitly trusts the machine

0 commit comments

Comments
 (0)