mirror of
https://github.com/elastic/kibana.git
synced 2025-04-23 09:19:04 -04:00
[DOCS] Adds deprecation admonitions (#95847)
This commit is contained in:
Lisa Cawley
GitHub
parent
16a176af98
commit
e285c7c214
23 changed files with 57 additions and 57 deletions
|
|
@ -4,7 +4,7 @@
|
|||
<titleabbrev>Legacy Create connector</titleabbrev>
|
||||
++++
|
||||
|
||||
WARNING: Deprecated in 7.13.0. Use <<create-connector-api>> instead.
|
||||
deprecated::[7.13.0,Use <<create-connector-api>> instead.]
|
||||
|
||||
Creates a connector.
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<titleabbrev>Legacy Delete connector</titleabbrev>
|
||||
++++
|
||||
|
||||
WARNING: Deprecated in 7.13.0. Use <<delete-connector-api>> instead.
|
||||
deprecated::[7.13.0,Use <<delete-connector-api>> instead.]
|
||||
|
||||
Deletes a connector by ID.
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<titleabbrev>Legacy Execute connector</titleabbrev>
|
||||
++++
|
||||
|
||||
WARNING: Deprecated in 7.13.0. Use <<execute-connector-api>> instead.
|
||||
deprecated::[7.13.0,Use <<execute-connector-api>> instead.]
|
||||
|
||||
Executes a connector by ID.
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<titleabbrev>Legacy Get connector</titleabbrev>
|
||||
++++
|
||||
|
||||
WARNING: Deprecated in 7.13.0. Use <<get-connector-api>> instead.
|
||||
deprecated::[7.13.0,Use <<get-connector-api>> instead.]
|
||||
|
||||
Retrieves a connector by ID.
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<titleabbrev>Legacy Get all connector</titleabbrev>
|
||||
++++
|
||||
|
||||
WARNING: Deprecated in 7.13.0. Use <<get-all-connectors-api>> instead.
|
||||
deprecated::[7.13.0,Use <<get-all-connectors-api>> instead.]
|
||||
|
||||
Retrieves all connectors.
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<titleabbrev>Legacy List all connector types</titleabbrev>
|
||||
++++
|
||||
|
||||
WARNING: Deprecated in 7.13.0. Use <<list-connector-types-api>> instead.
|
||||
deprecated::[7.13.0,Use <<list-connector-types-api>> instead.]
|
||||
|
||||
Retrieves a list of all connector types.
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<titleabbrev>Legacy Update connector</titleabbrev>
|
||||
++++
|
||||
|
||||
WARNING: Deprecated in 7.13.0. Use <<update-connector-api>> instead.
|
||||
deprecated::[7.13.0,Use <<update-connector-api>> instead.]
|
||||
|
||||
Updates the attributes for an existing connector.
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<titleabbrev>Legacy create alert</titleabbrev>
|
||||
++++
|
||||
|
||||
WARNING: Deprecated in 7.13.0. Use <<create-rule-api>> instead.
|
||||
deprecated::[7.13.0,Use <<create-rule-api>> instead.]
|
||||
|
||||
Create {kib} alerts.
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<titleabbrev>Legacy delete alert</titleabbrev>
|
||||
++++
|
||||
|
||||
WARNING: Deprecated in 7.13.0. Use <<delete-rule-api>> instead.
|
||||
deprecated::[7.13.0,Use <<delete-rule-api>> instead.]
|
||||
|
||||
Permanently remove an alert.
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<titleabbrev>Legacy disable alert</titleabbrev>
|
||||
++++
|
||||
|
||||
WARNING: Deprecated in 7.13.0. Use <<disable-rule-api>> instead.
|
||||
deprecated::[7.13.0,Use <<disable-rule-api>> instead.]
|
||||
|
||||
Disable an alert.
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<titleabbrev>Legacy enable alert</titleabbrev>
|
||||
++++
|
||||
|
||||
WARNING: Deprecated in 7.13.0. Use <<enable-rule-api>> instead.
|
||||
deprecated::[7.13.0,Use <<enable-rule-api>> instead.]
|
||||
|
||||
Enable an alert.
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<titleabbrev>Legacy find alerts</titleabbrev>
|
||||
++++
|
||||
|
||||
WARNING: Deprecated in 7.13.0. Use <<find-rules-api>> instead.
|
||||
deprecated::[7.13.0,Use <<find-rules-api>> instead.]
|
||||
|
||||
Retrieve a paginated set of alerts based on condition.
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<titleabbrev>Legacy get alert</titleabbrev>
|
||||
++++
|
||||
|
||||
WARNING: Deprecated in 7.13.0. Use <<get-rule-api>> instead.
|
||||
deprecated::[7.13.0,Use <<get-rule-api>> instead.]
|
||||
|
||||
Retrieve an alert by ID.
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<titleabbrev>Legacy get Alerting framework health</titleabbrev>
|
||||
++++
|
||||
|
||||
WARNING: Deprecated in 7.13.0. Use <<get-alerting-framework-health-api>> instead.
|
||||
deprecated::[7.13.0,Use <<get-alerting-framework-health-api>> instead.]
|
||||
|
||||
Retrieve the health status of the Alerting framework.
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<titleabbrev>Legacy list all alert types</titleabbrev>
|
||||
++++
|
||||
|
||||
WARNING: Deprecated in 7.13.0. Use <<list-rule-types-api>> instead.
|
||||
deprecated::[7.13.0,Use <<list-rule-types-api>> instead.]
|
||||
|
||||
Retrieve a list of all alert types.
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<titleabbrev>Legacy mute alert instance</titleabbrev>
|
||||
++++
|
||||
|
||||
WARNING: Deprecated in 7.13.0. Use <<mute-alert-api>> instead.
|
||||
deprecated::[7.13.0,Use <<mute-alert-api>> instead.]
|
||||
|
||||
Mute an alert instance.
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<titleabbrev>Legacy mute all alert instances</titleabbrev>
|
||||
++++
|
||||
|
||||
WARNING: Deprecated in 7.13.0. Use <<mute-all-alerts-api>> instead.
|
||||
deprecated::[7.13.0,Use <<mute-all-alerts-api>> instead.]
|
||||
|
||||
Mute all alert instances.
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<titleabbrev>Legacy unmute alert instance</titleabbrev>
|
||||
++++
|
||||
|
||||
WARNING: Deprecated in 7.13.0. Use <<unmute-alert-api>> instead.
|
||||
deprecated::[7.13.0,Use <<unmute-alert-api>> instead.]
|
||||
|
||||
Unmute an alert instance.
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<titleabbrev>Legacy unmute all alert instances</titleabbrev>
|
||||
++++
|
||||
|
||||
WARNING: Deprecated in 7.13.0. Use <<unmute-all-alerts-api>> instead.
|
||||
deprecated::[7.13.0,Use <<unmute-all-alerts-api>> instead.]
|
||||
|
||||
Unmute all alert instances.
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<titleabbrev>Legacy update alert</titleabbrev>
|
||||
++++
|
||||
|
||||
WARNING: Deprecated in 7.13.0. Use <<update-rule-api>> instead.
|
||||
deprecated::[7.13.0,Use <<update-rule-api>> instead.]
|
||||
|
||||
Update the attributes for an existing alert.
|
||||
|
||||
|
|
|
|||
|
|
@ -260,19 +260,21 @@ For information about {kib} memory limits, see <<production, using {kib} in a pr
|
|||
|
||||
[cols="2*<"]
|
||||
|===
|
||||
| `xpack.reporting.index`
|
||||
| *deprecated* This setting is deprecated and will be removed in 8.0. Multitenancy by changing
|
||||
`kibana.index` will not be supported starting in 8.0. See https://ela.st/kbn-remove-legacy-multitenancy[8.0 Breaking Changes]
|
||||
for more details. Reporting uses a weekly index in {es} to store the reporting job and
|
||||
the report content. The index is automatically created if it does not already
|
||||
exist. Configure this to a unique value, beginning with `.reporting-`, for every
|
||||
{kib} instance that has a unique <<kibana-index, `kibana.index`>> setting. Defaults to `.reporting`.
|
||||
|
||||
| `xpack.reporting.capture.networkPolicy`
|
||||
| Capturing a screenshot from a {kib} page involves sending out requests for all the linked web assets. For example, a Markdown
|
||||
visualization can show an image from a remote server. You can configure what type of requests to allow or filter by setting a
|
||||
<<reporting-network-policy, network policy>> for Reporting.
|
||||
|
||||
| `xpack.reporting.index`
|
||||
| deprecated:[7.11.0,This setting will be removed in 8.0.] Multitenancy by
|
||||
changing `kibana.index` will not be supported starting in 8.0. See
|
||||
https://ela.st/kbn-remove-legacy-multitenancy[8.0 Breaking Changes] for more
|
||||
details. Reporting uses a weekly index in {es} to store the reporting job and
|
||||
the report content. The index is automatically created if it does not already
|
||||
exist. Configure this to a unique value, beginning with `.reporting-`, for
|
||||
every {kib} instance that has a unique <<kibana-index, `kibana.index`>>
|
||||
setting. Defaults to `.reporting`.
|
||||
|
||||
| `xpack.reporting.roles.allow`
|
||||
| Specifies the roles in addition to superusers that can use reporting.
|
||||
Defaults to `[ "reporting_user" ]`. +
|
||||
|
|
|
|||
|
|
@ -25,12 +25,14 @@ which may cause a delay before pages start being served.
|
|||
Set to `false` to disable Console. *Default: `true`*
|
||||
|
||||
| `cpu.cgroup.path.override:`
|
||||
| *deprecated* This setting has been renamed to <<ops-cGroupOverrides-cpuPath, `ops.cGroupOverrides.cpuPath`>>
|
||||
and the old name will no longer be supported as of 8.0.
|
||||
| deprecated:[7.10.0,"This setting will no longer be supported as of 8.0."]
|
||||
This setting has been renamed to
|
||||
<<ops-cGroupOverrides-cpuPath,`ops.cGroupOverrides.cpuPath`>>.
|
||||
|
||||
| `cpuacct.cgroup.path.override:`
|
||||
| *deprecated* This setting has been renamed to <<ops-cGroupOverrides-cpuAcctPath, `ops.cGroupOverrides.cpuAcctPath`>>
|
||||
and the old name will no longer be supported as of 8.0.
|
||||
| deprecated:[7.10.0,"This setting will no longer be supported as of 8.0."]
|
||||
This setting has been renamed to
|
||||
<<ops-cGroupOverrides-cpuAcctPath, `ops.cGroupOverrides.cpuAcctPath`>>.
|
||||
|
||||
| `csp.rules:`
|
||||
| A https://w3c.github.io/webappsec-csp/[content-security-policy] template
|
||||
|
|
@ -64,10 +66,12 @@ To enable SSL/TLS for outbound connections to {es}, use the `https` protocol
|
|||
in this setting.
|
||||
|
||||
| `elasticsearch.logQueries:`
|
||||
| *deprecated* This setting is no longer used and will get removed in Kibana 8.0. Instead, configure the `elasticsearch.query` logger.
|
||||
This is useful for seeing the query DSL generated by applications that
|
||||
currently do not have an inspector, for example Timelion and Monitoring.
|
||||
*Default: `false`*
|
||||
| deprecated:[7.12.0,"This setting is no longer used and will be removed in Kibana 8.0."]
|
||||
Instead, configure the `elasticsearch.query` logger.
|
||||
+
|
||||
This is useful for seeing the query DSL generated by applications that
|
||||
currently do not have an inspector, for example Timelion and Monitoring.
|
||||
*Default: `false`*
|
||||
|
||||
The following example shows a valid `elasticsearch.query` logger configuration:
|
||||
|===
|
||||
|
|
@ -240,18 +244,22 @@ on the {kib} index at startup. {kib} users still need to authenticate with
|
|||
| Enables use of interpreter in Visualize. *Default: `true`*
|
||||
|
||||
| `kibana.defaultAppId:`
|
||||
| *deprecated* This setting is deprecated and will get removed in Kibana 8.0.
|
||||
Please use the `defaultRoute` advanced setting instead.
|
||||
The default application to load. *Default: `"home"`*
|
||||
| deprecated:[7.9.0,This setting will be removed in Kibana 8.0.]
|
||||
Instead, use the <<defaultroute,`defaultRoute` advanced setting>>.
|
||||
+
|
||||
The default application to load. *Default: `"home"`*
|
||||
|
||||
|[[kibana-index]] `kibana.index:`
|
||||
| *deprecated* This setting is deprecated and will be removed in 8.0. Multitenancy by changing
|
||||
`kibana.index` will not be supported starting in 8.0. See https://ela.st/kbn-remove-legacy-multitenancy[8.0 Breaking Changes]
|
||||
for more details. {kib} uses an index in {es} to store saved searches, visualizations, and
|
||||
dashboards. {kib} creates a new index if the index doesn’t already exist.
|
||||
If you configure a custom index, the name must be lowercase, and conform to the
|
||||
{es} {ref}/indices-create-index.html[index name limitations].
|
||||
*Default: `".kibana"`*
|
||||
| deprecated:[7.11.0,This setting will be removed in 8.0.] Multitenancy by
|
||||
changing `kibana.index` will not be supported starting in 8.0. See
|
||||
https://ela.st/kbn-remove-legacy-multitenancy[8.0 Breaking Changes] for more
|
||||
details.
|
||||
+
|
||||
{kib} uses an index in {es} to store saved searches, visualizations, and
|
||||
dashboards. {kib} creates a new index if the index doesn’t already exist. If
|
||||
you configure a custom index, the name must be lowercase, and conform to the
|
||||
{es} {ref}/indices-create-index.html[index name limitations].
|
||||
*Default: `".kibana"`*
|
||||
|
||||
| `kibana.autocompleteTimeout:` {ess-icon}
|
||||
| Time in milliseconds to wait for autocomplete suggestions from {es}.
|
||||
|
|
|
|||
|
|
@ -4,17 +4,7 @@
|
|||
Instead of using a visual editor to create charts, you define a graph by chaining functions together, using the *Timelion*-specific syntax.
|
||||
The syntax enables some features that classical point series charts don't offer, such as pulling data from different indices or data sources into one graph.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
Timelion app deprecation
|
||||
|
||||
*Timelion* is still supported, the *Timelion app* is deprecated in 7.0, replaced by
|
||||
dashboard features. In 8.0 and later, the *Timelion app* is removed from {kib}.
|
||||
To prepare for the removal of *Timelion app*, you must migrate *Timelion app* worksheets to a dashboard.
|
||||
|
||||
For information on how to migrate *Timelion app* worksheets, refer to the
|
||||
link:https://www.elastic.co/guide/en/kibana/7.10/release-notes-7.10.0.html#deprecation-v7.10.0[7.10.0 Release Notes].
|
||||
====
|
||||
deprecated::[7.0.0,"*Timelion* is still supported. The *Timelion app* is deprecated in 7.0, replaced by dashboard features. In 8.0 and later, the *Timelion app* is removed from {kib}. To prepare for the removal of *Timelion app*, you must migrate *Timelion app* worksheets to a dashboard. For information on how to migrate *Timelion app* worksheets, refer to the link:https://www.elastic.co/guide/en/kibana/7.10/release-notes-7.10.0.html#deprecation-v7.10.0[7.10.0 Release Notes]."]
|
||||
|
||||
[float]
|
||||
==== Timelion expressions
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue