Skip to content

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

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Feb 25, 2021
Merged

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

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e8a8895
[Alerts][Doc] Added README documentation for API key invalidation con…
YulNaumenko Feb 25, 2021
fdb8ef5
Apply suggestions from code review
YulNaumenko Feb 25, 2021
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
View file
Open in desktop
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 alert, we generate a new API key.

When we update, enable, or disable an alert, we must invalidate the old API key and create a new one.

To manage the invalidation process for API keys, we use the saved object `api_key_pending_invalidation`. This object stores all API keys that were marked for invalidation when alerts were updated.
For security plugin invalidation, we schedule a task to check if the`api_key_pending_invalidation` saved object contains new API keys that are marked for invalidation earlier than the configured delay. The default value for running the task is 5 mins.
To change the schedule for the invalidation task, use the kibana.yml configuration option `xpack.alerts.invalidateApiKeysTask.interval`.
To change the default delay for the API key invalidation, use the kibana.yml configuration option `xpack.alerts.invalidateApiKeysTask.removalDelay`.

## Limitations

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