Skip to content

Commit 1cc4ea3

Browse files
committed
Moving limitations to user docs
1 parent bf82ccd commit 1cc4ea3

2 files changed

Lines changed: 6 additions & 24 deletions

File tree

docs/user/alerting/alerting-getting-started.asciidoc

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -216,20 +216,17 @@ For security reasons you may wish to limit the extent to which {kib} can connect
216216
[[alerting-limitations]]
217217
=== Limitations
218218

219-
* Users who create alerts will need the `manage_api_key` cluster privilege.
219+
Users who create alerts will need the `manage_api_key` cluster privilege.
220220

221221
[IMPORTANT]
222222
==============================================
223-
Note that the `manage_own_api_key` cluster privilege is not enough - it can be used to create API keys, but cannot be used invalidate them. Alerts must be able to both create and invalidate API keys.
223+
Note that the `manage_own_api_key` cluster privilege is not enough - it can be used to create API keys, but cannot be used invalidate them. Alerting must be able to both create and invalidate API keys.
224224
==============================================
225225

226-
// When an alert is created by a user with the `manage_own_api_key` but not the `manage_api_key` cluster privilege, you may see the following error message in the {kib} logs:
226+
When an alert is created by a user with the `manage_own_api_key` but not the `manage_api_key` cluster privilege, you will see the following error message in the {kib} logs:
227227

228-
// [source,text]
229-
// --
230-
// [error][alerting][plugins] Failed to invalidate API Key: [security_exception] \
231-
// action [cluster:admin/xpack/security/api_key/invalidate] \
232-
// is unauthorized for user [user-name-here]
233-
// --
228+
```bash
229+
[error][alerting][plugins] Failed to invalidate API Key: [security_exception] action [cluster:admin/xpack/security/api_key/invalidate] is unauthorized for user [user-name-here]
230+
```
234231

235232
--

x-pack/plugins/alerting/README.md

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ Table of Contents
1414
- [Terminology](#terminology)
1515
- [Usage](#usage)
1616
- [Alerts API keys](#alerts-api-keys)
17-
- [Limitations](#limitations)
1817
- [Plugin status](#plugin-status)
1918
- [Alert types](#alert-types)
2019
- [Methods](#methods)
@@ -67,20 +66,6 @@ For security plugin invalidation, we schedule a task to check if the`api_key_pen
6766
To change the schedule for the invalidation task, use the kibana.yml configuration option `xpack.alerting.invalidateApiKeysTask.interval`.
6867
To change the default delay for the API key invalidation, use the kibana.yml configuration option `xpack.alerting.invalidateApiKeysTask.removalDelay`.
6968

70-
## Limitations
71-
72-
When security is enabled, an SSL connection to Elasticsearch is required in order to use alerting.
73-
74-
When security is enabled, users who create alerts will need the `manage_api_key` cluster privilege. There is currently work in progress to remove this requirement.
75-
76-
Note that the `manage_own_api_key` cluster privilege is not enough - it can be used to create API keys, but not invalidate them, and the alerting plugin currently both creates and invalidates APIs keys as part of it's processing. When using only the `manage_own_api_key` privilege, you will see the following message logged in the server when the alerting plugin attempts to invalidate an API key:
77-
78-
```
79-
[error][alerting][plugins] Failed to invalidate API Key: [security_exception] \
80-
action [cluster:admin/xpack/security/api_key/invalidate] \
81-
is unauthorized for user [user-name-here]
82-
```
83-
8469
## Plugin status
8570

8671
The plugin status of an alert is customized by including information about checking failures for the framework decryption:

0 commit comments

Comments
 (0)