Skip to content

Commit 9fb2f67

Browse files
authored
Doc: Update deprecation notices to standard (#154)
1 parent 099f085 commit 9fb2f67

File tree

1 file changed

+14
-28
lines changed

1 file changed

+14
-28
lines changed

docs/index.asciidoc

Lines changed: 14 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -91,11 +91,11 @@ This plugin supports the following configuration options plus the <<plugins-{typ
9191
|=======================================================================
9292
|Setting |Input type|Required
9393
| <<plugins-{type}s-{plugin}-additional_codecs>> |<<hash,hash>>|No
94-
| <<plugins-{type}s-{plugin}-cipher_suites>> |<<array,array>>|No
94+
| <<plugins-{type}s-{plugin}-cipher_suites>> |<<array,array>>|__Deprecated__
9595
| <<plugins-{type}s-{plugin}-ecs_compatibility>> | <<string,string>>|No
9696
| <<plugins-{type}s-{plugin}-host>> |<<string,string>>|No
97-
| <<plugins-{type}s-{plugin}-keystore>> |<<path,path>>|No
98-
| <<plugins-{type}s-{plugin}-keystore_password>> |<<password,password>>|No
97+
| <<plugins-{type}s-{plugin}-keystore>> |<<path,path>>|__Deprecated__
98+
| <<plugins-{type}s-{plugin}-keystore_password>> |<<password,password>>|__Deprecated__
9999
| <<plugins-{type}s-{plugin}-password>> |<<password,password>>|No
100100
| <<plugins-{type}s-{plugin}-port>> |<<number,number>>|No
101101
| <<plugins-{type}s-{plugin}-max_pending_requests>> |<<number,number>>|No
@@ -111,10 +111,10 @@ This plugin supports the following configuration options plus the <<plugins-{typ
111111
| <<plugins-{type}s-{plugin}-ssl_supported_protocols>> |<<array,array>>|No
112112
| <<plugins-{type}s-{plugin}-ssl_verify_mode>> |<<string,string>>, one of `["none", "peer", "force_peer"]`|No
113113
| <<plugins-{type}s-{plugin}-threads>> |<<number,number>>|No
114-
| <<plugins-{type}s-{plugin}-tls_max_version>> |<<number,number>>|No
115-
| <<plugins-{type}s-{plugin}-tls_min_version>> |<<number,number>>|No
114+
| <<plugins-{type}s-{plugin}-tls_max_version>> |<<number,number>>|__Deprecated__
115+
| <<plugins-{type}s-{plugin}-tls_min_version>> |<<number,number>>|__Deprecated__
116116
| <<plugins-{type}s-{plugin}-user>> |<<string,string>>|No
117-
| <<plugins-{type}s-{plugin}-verify_mode>> |<<string,string>>, one of `["none", "peer", "force_peer"]`|No
117+
| <<plugins-{type}s-{plugin}-verify_mode>> |<<string,string>>, one of `["none", "peer", "force_peer"]`|__Deprecated__
118118
|=======================================================================
119119

120120
Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
@@ -134,29 +134,24 @@ and no codec for the request's content-type is found
134134

135135
[id="plugins-{type}s-{plugin}-cipher_suites"]
136136
===== `cipher_suites`
137+
deprecated[3.6.0, Replaced by <<plugins-{type}s-{plugin}-ssl_cipher_suites>>]
137138

138139
* Value type is <<array,array>>
139-
* This option is deprecated
140140

141141
The list of cipher suites to use, listed by priorities.
142142

143-
NOTE: This option is deprecated and it will be removed in the next major version of Logstash.
144-
Use `ssl_cipher_suites` instead.
145-
146143
[id="plugins-{type}s-{plugin}-ecs_compatibility"]
147144
===== `ecs_compatibility`
148145

149146
* Value type is <<string,string>>
150147
* Supported values are:
151-
** `disabled`: unstructured connection metadata added at root level
152-
** `v1`,`v8`: headers added under `[@metadata][http][header]`. Some are copied to structured ECS fields `http`, `url`, `user_agent` and `host`
148+
** `disabled`: unstructured connection metadata added at root level
149+
** `v1`,`v8`: headers added under `[@metadata][http][header]`. Some are copied to structured ECS fields `http`, `url`, `user_agent` and `host`
153150

154151
Controls this plugin's compatibility with the
155152
{ecs-ref}[Elastic Common Schema (ECS)].
156153
See <<plugins-{type}s-{plugin}-ecs_metadata>> for detailed information.
157154

158-
Example output:
159-
160155
**Sample output: ECS disabled**
161156
[source,text]
162157
-----
@@ -219,28 +214,22 @@ The host or ip to bind
219214

220215
[id="plugins-{type}s-{plugin}-keystore"]
221216
===== `keystore`
217+
deprecated[3.1.0, Use <<plugins-{type}s-{plugin}-ssl_certificate>> and <<plugins-{type}s-{plugin}-ssl_key>> instead]
222218

223219
* Value type is <<path,path>>
224220
* There is no default value for this setting.
225-
* This option is deprecated
226221

227222
The JKS keystore to validate the client's certificates
228223

229-
Note: This option is deprecated and it will be removed in the next major version of Logstash.
230-
Use `ssl_certificate` and `ssl_key` instead.
231-
232224
[id="plugins-{type}s-{plugin}-keystore_password"]
233225
===== `keystore_password`
226+
deprecated[3.1.0, Use <<plugins-{type}s-{plugin}-ssl_certificate>> and <<plugins-{type}s-{plugin}-ssl_key>> instead]
234227

235228
* Value type is <<password,password>>
236229
* There is no default value for this setting.
237-
* This option is deprecated
238230

239231
Set the truststore password
240232

241-
Note: This option is deprecated and it will be removed in the next major version of Logstash.
242-
Use `ssl_certificate` and `ssl_key` instead.
243-
244233
[id="plugins-{type}s-{plugin}-password"]
245234
===== `password`
246235

@@ -427,18 +416,18 @@ Number of threads to use for both accepting connections and handling requests
427416

428417
[id="plugins-{type}s-{plugin}-tls_max_version"]
429418
===== `tls_max_version`
419+
deprecated[3.6.0]
430420

431421
* Value type is <<number,number>>
432-
* This option is deprecated
433422

434423
The maximum TLS version allowed for the encrypted connections.
435424
The value must be the one of the following: 1.1 for TLS 1.1, 1.2 for TLS 1.2, 1.3 for TLSv1.3
436425

437426
[id="plugins-{type}s-{plugin}-tls_min_version"]
438427
===== `tls_min_version`
428+
deprecated[3.6.0]
439429

440430
* Value type is <<number,number>>
441-
* This option is deprecated
442431

443432
The minimum TLS version allowed for the encrypted connections.
444433
The value must be one of the following: 1.1 for TLS 1.1, 1.2 for TLS 1.2, 1.3 for TLSv1.3
@@ -453,16 +442,13 @@ Username for basic authorization
453442

454443
[id="plugins-{type}s-{plugin}-verify_mode"]
455444
===== `verify_mode`
445+
deprecated[3.6.0, Replaced by <<plugins-{type}s-{plugin}-ssl_verify_mode>>]
456446

457447
* Value can be any of: `none`, `peer`, `force_peer`
458448
* Default value is `"none"`
459-
* This option is deprecated
460449

461450
Set the client certificate verification method. Valid methods: none, peer, force_peer
462451

463-
NOTE: This option is deprecated and it will be removed in the next major version of Logstash.
464-
Use `ssl_verify_mode` instead.
465-
466452

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

0 commit comments

Comments
 (0)