mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 17:59:23 -04:00
80 lines
No EOL
3.2 KiB
YAML
80 lines
No EOL
3.2 KiB
YAML
# overlays.yaml
|
|
overlay: 1.0.0
|
|
info:
|
|
title: Overlays for the Kibana API document
|
|
version: 0.0.1
|
|
actions:
|
|
# Clean up server definitions
|
|
- target: '$.servers.*'
|
|
description: Remove all servers so we can add our own.
|
|
remove: true
|
|
- target: '$.servers'
|
|
description: Add server into the now empty server array.
|
|
update:
|
|
- url: https://{kibana_url}
|
|
variables:
|
|
kibana_url:
|
|
default: <KIBANA_URL>
|
|
# Add some tag descriptions and displayNames
|
|
- target: '$.tags[?(@.name=="alerting")]'
|
|
description: Change tag description and displayName
|
|
update:
|
|
description: >
|
|
Alerting enables you to define rules, which detect complex conditions within your data.
|
|
When a condition is met, the rule tracks it as an alert and runs the actions that are defined in the rule.
|
|
Actions typically involve the use of connectors to interact with Kibana services or third party integrations.
|
|
externalDocs:
|
|
description: Alerting documentation
|
|
url: https://www.elastic.co/docs/current/serverless/rules
|
|
x-displayName: "Alerting"
|
|
- target: '$.tags[?(@.name=="streams")]'
|
|
description: Change tag description and displayName
|
|
update:
|
|
description: >
|
|
Streams is a new and experimental way to manage your data in Kibana. The API is currently not considered stable and can change at any point.
|
|
x-displayName: "Streams"
|
|
- target: '$.tags[?(@.name=="connectors")]'
|
|
description: Change tag description and displayName
|
|
update:
|
|
description: >
|
|
Connectors provide a central place to store connection information for services and integrations with Elastic or third party systems.
|
|
Alerting rules can use connectors to run actions when rule conditions are met.
|
|
externalDocs:
|
|
description: Connector documentation
|
|
url: https://www.elastic.co/docs/current/serverless/action-connectors
|
|
x-displayName: "Connectors"
|
|
- target: '$.tags[?(@.name=="data views")]'
|
|
description: Change displayName
|
|
update:
|
|
x-displayName: "Data views"
|
|
- target: '$.tags[?(@.name=="ml")]'
|
|
description: Change displayName
|
|
update:
|
|
x-displayName: "Machine learning"
|
|
- target: '$.tags[?(@.name=="roles")]'
|
|
description: Change displayName and description
|
|
update:
|
|
x-displayName: "Roles"
|
|
description: Manage the roles that grant Elasticsearch and Kibana privileges.
|
|
externalDocs:
|
|
description: Kibana role management
|
|
url: https://www.elastic.co/guide/en/kibana/master/kibana-role-management.html
|
|
- target: '$.tags[?(@.name=="slo")]'
|
|
description: Change displayName
|
|
update:
|
|
x-displayName: "Service level objectives"
|
|
- target: '$.tags[?(@.name=="spaces")]'
|
|
description: Change displayName
|
|
update:
|
|
x-displayName: "Spaces"
|
|
description: Manage your Kibana spaces.
|
|
- target: '$.tags[?(@.name=="system")]'
|
|
description: Change displayName and description
|
|
update:
|
|
x-displayName: "System"
|
|
description: >
|
|
Get information about the system status, resource usage, and installed plugins.
|
|
# Remove extra tags from operations
|
|
- target: "$.paths[*][*].tags[1:]"
|
|
description: Remove all but first tag from operations
|
|
remove: true |