Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Alerts][Doc] Added README documentation for API key invalidation configuration options. #92757

Merged
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions x-pack/plugins/alerts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Table of Contents
- [Kibana alerting](#kibana-alerting)
- [Terminology](#terminology)
- [Usage](#usage)
- [Alerts API keys](#alerts-api-keys)
- [Limitations](#limitations)
- [Alert types](#alert-types)
- [Methods](#methods)
Expand Down Expand Up @@ -50,6 +51,17 @@ A Kibana alert detects a condition and executes one or more actions when that co
2. Configure feature level privileges using RBAC
3. Create an alert using the RESTful API [Documentation](https://www.elastic.co/guide/en/kibana/master/alerts-api-update.html) (see alerts -> create).

## Alerts API keys

When we create an alerts we generate a new API key.
YulNaumenko marked this conversation as resolved.
Show resolved Hide resolved

When we change, delete or manage alert availabilty we need to invalidate the old API key and create a new one (except the delete process).
YulNaumenko marked this conversation as resolved.
Show resolved Hide resolved

For managing API keys invalidation process we use additional saved object `api_key_pending_invalidation`, which stores all alerts API keys that was marked for invalidation during the updating or changing alerts.
YulNaumenko marked this conversation as resolved.
Show resolved Hide resolved
For executing security plugin invalidation we schedule a task which runs by default for every 5 mins to check if `api_key_pending_invalidation` saved object contains new API keys which marked for invalidation earlier then configured delay: default value is 5 mins.
YulNaumenko marked this conversation as resolved.
Show resolved Hide resolved
To change the default invalidation task schedule, use kibana.yml configuration option `xpack.alerts.invalidateApiKeysTask.interval: '5m'`.
YulNaumenko marked this conversation as resolved.
Show resolved Hide resolved
To change the default delay for the makrked API key invalidation, use kibana.yml configuration option `xpack.alerts.invalidateApiKeysTask.removalDelay: '5m'`.
YulNaumenko marked this conversation as resolved.
Show resolved Hide resolved

## Limitations

When security is enabled, an SSL connection to Elasticsearch is required in order to use alerting.
Expand Down