github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 09:19:04 -04:00
Code Issues Projects Releases Packages Wiki Activity

[8.8] [DOCS] Allow users authenticated with API keys to manage alerting rules (#158428) (#158497)

Browse source 
# Backport

This will backport the following commits from `main` to `8.8`:
- [[DOCS] Allow users authenticated with API keys to manage alerting
rules (#158428)](https://github.com/elastic/kibana/pull/158428)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2023-05-25T17:32:11Z","message":"[DOCS]
Allow users authenticated with API keys to manage alerting rules
(#158428)","sha":"4cf817a1abb3ddd657c7c11d75c5bd7f9e8aed27","branchLabelMapping":{"^v8.9.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Feature:Alerting","release_note:skip","Team:ResponseOps","docs","backport:prev-minor","v8.9.0","v8.8.1"],"number":158428,"url":"https://github.com/elastic/kibana/pull/158428","mergeCommit":{"message":"[DOCS]
Allow users authenticated with API keys to manage alerting rules
(#158428)","sha":"4cf817a1abb3ddd657c7c11d75c5bd7f9e8aed27"}},"sourceBranch":"main","suggestedTargetBranches":["8.8"],"targetPullRequestStates":[{"branch":"main","label":"v8.9.0","labelRegex":"^v8.9.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/158428","number":158428,"mergeCommit":{"message":"[DOCS]
Allow users authenticated with API keys to manage alerting rules
(#158428)","sha":"4cf817a1abb3ddd657c7c11d75c5bd7f9e8aed27"}},{"branch":"8.8","label":"v8.8.1","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
This commit is contained in:
Kibana Machine 2023-05-25 13:54:13 -04:00 • committed by GitHub
parent 1b72e4ae6d
commit bc5230735e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 9 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

15
docs/user/alerting/alerting-setup.asciidoc
View file

@ -74,16 +74,16 @@ A rule or connector created in one space will not be visible in another.
[[alerting-authorization]]
=== Authorization
Rules are authorized using an <<api-keys,API key>> associated with the last user
to edit the rule. This API key captures a snapshot of the user's privileges at
the time of the edit. They are subsequently used to run all background tasks
associated with the rule, including condition checks like {es} queries and
triggered actions. The following rule actions will re-generate the API key:
Rules are authorized using an API key.
Its credentials are used to run all background tasks associated with the rule, including condition checks like {es} queries and triggered actions.
You can create API keys and use them in the header of your API calls as described in <<api-keys>>.
If you create or edit a rule in {kib}, an API key is created that captures a snapshot of your privileges at the time of the edit. The following actions regenerate the API key in {kib}:
* Creating a rule
* Updating a rule
When you disable a rule, it retains the associated API key which is re-used when
When you disable a rule, it retains the associated API key which is reused when
the rule is enabled. If the API key is missing when you enable the rule (for
example, in the case of imported rules), it generates a new key that has your
security privileges.
@ -94,10 +94,11 @@ You can update an API key manually in
[IMPORTANT]
==============================================
If a rule requires certain privileges, such as index privileges, to run, and a
If a rule requires certain privileges, such as index privileges, to run and a
user without those privileges updates the rule, the rule will no longer
function. Conversely, if a user with greater or administrator privileges
modifies the rule, it will begin running with increased privileges.
The same behavior occurs when you change the API key in the header of your API calls.
==============================================
[float]

2
docs/user/alerting/troubleshooting/alerting-common-issues.asciidoc
View file

@ -263,7 +263,7 @@ This error happens when the `xpack.encryptedSavedObjects.encryptionKey` value us
| The other {kib} instance might be trying to run the rule using a different encryption key than what the rule was created with. Ensure the encryption keys among all the {kib} instances are the same, and setting <<xpack-encryptedSavedObjects-keyRotation-decryptionOnlyKeys, decryption only keys>> for previously used encryption keys.
| If other scenarios don't apply.
| Generate a new API key for the rule by disabling then enabling the rule.
| Generate a new API key for the rule. For example, in *{stack-manage-app} > {rules-ui}*, select *Update API key* from the action menu.
|===