diff --git a/docs/plugins/outputs/elasticsearch.asciidoc b/docs/plugins/outputs/elasticsearch.asciidoc index 9c7816d5..40aa5b64 100644 --- a/docs/plugins/outputs/elasticsearch.asciidoc +++ b/docs/plugins/outputs/elasticsearch.asciidoc @@ -326,8 +326,10 @@ When a string value on an event contains one or more byte sequences that are not [id="plugins-{type}s-{plugin}-options"] ==== Elasticsearch Output Configuration Options -This plugin supports the following configuration options plus the -<> and the <> described later. +This plugin supports these configuration options plus the <> described later. + +NOTE: As of version 12.0.0 of this plugin, a number of previously deprecated SSL settings have been removed. +Please check out <> for details. [cols="<,<,<",options="header",] |======================================================================= @@ -442,7 +444,7 @@ For more details on actions, check out the {ref}/docs-bulk.html[Elasticsearch bu * There is no default value for this setting. Authenticate using Elasticsearch API key. -Note that this option also requires SSL/TLS, which can be enabled by supplying a <>, a list of HTTPS <>, or by setting < true`>>. +Note that this option also requires SSL/TLS, which can be enabled by supplying a <>, a list of HTTPS <>, or by setting < true`>>. Format is `id:api_key` where `id` and `api_key` are as returned by the Elasticsearch {ref}/security-api-create-api-key.html[Create API key API]. @@ -1325,98 +1327,24 @@ https://www.elastic.co/blog/elasticsearch-versioning-support[versioning support blog] and {ref}/docs-index_.html#_version_types[Version types] in the Elasticsearch documentation. -[id="plugins-{type}s-{plugin}-deprecated-options"] -==== Elasticsearch Output Deprecated Configuration Options - -This plugin supports the following deprecated configurations. +[id="plugins-{type}s-{plugin}-obsolete-options"] +==== Elasticsearch Output Obsolete Configuration Options -WARNING: Deprecated options are subject to removal in future releases. +WARNING: As of version `12.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. -[cols="<,<,<",options="header",] +[cols="<,<",options="header",] |======================================================================= -|Setting|Input type|Replaced by -| <> |a valid filesystem path|<> -| <> |a valid filesystem path|<> -| <> |<>|<> -| <> |<>|<> -| <> |<>|<> -| <> |a valid filesystem path|<> -| <> |<>|<> +|Setting|Replaced by +| cacert | <> +| keystore | <> +| keystore_password | <> +| ssl | <> +| ssl_certificate_verification | <> +| truststore | <> +| truststore_password | <> |======================================================================= - -[id="plugins-{type}s-{plugin}-cacert"] -===== `cacert` -deprecated[11.14.0, Replaced by <>] - -* Value type is a list of <> -* There is no default value for this setting. - -The .cer or .pem file to validate the server's certificate. - -[id="plugins-{type}s-{plugin}-keystore"] -===== `keystore` -deprecated[11.14.0, Replaced by <>] - -* Value type is <> -* There is no default value for this setting. - -The keystore used to present a certificate to the server. -It can be either .jks or .p12 - -NOTE: You cannot use this setting and <> at the same time. - -[id="plugins-{type}s-{plugin}-keystore_password"] -===== `keystore_password` -deprecated[11.14.0, Replaced by <>] - -* Value type is <> -* There is no default value for this setting. - -Set the keystore password - -[id="plugins-{type}s-{plugin}-ssl"] -===== `ssl` -deprecated[11.14.0, Replaced by <>] - -* Value type is <> -* There is no default value for this setting. - -Enable SSL/TLS secured communication to Elasticsearch cluster. -Leaving this unspecified will use whatever scheme is specified in the URLs listed in <> or extracted from the <>. -If no explicit protocol is specified plain HTTP will be used. - -[id="plugins-{type}s-{plugin}-ssl_certificate_verification"] -===== `ssl_certificate_verification` -deprecated[11.14.0, Replaced by <>] - -* Value type is <> -* Default value is `true` - -Option to validate the server's certificate. Disabling this severely compromises security. -For more information on disabling certificate verification please read -https://www.cs.utexas.edu/~shmat/shmat_ccs12.pdf - -[id="plugins-{type}s-{plugin}-truststore"] -===== `truststore` -deprecated[11.14.0, Replaced by <>] - -* Value type is <> -* There is no default value for this setting. - -The truststore to validate the server's certificate. -It can be either `.jks` or `.p12`. -Use either `:truststore` or `:cacert`. - -[id="plugins-{type}s-{plugin}-truststore_password"] -===== `truststore_password` -deprecated[11.14.0, Replaced by <>] - -* Value type is <> -* There is no default value for this setting. - -Set the truststore password - [id="plugins-{type}s-{plugin}-common-options"] include::{include_path}/{type}.asciidoc[]