Skip to content

Commit 3807fdb

Browse files
[DOCS][ResponseOps][Alerting][8.19]: Fixes the note about CCS priv requirements for reporting and updates Kib 8.19 release notes (#245182)
## Summary Contributes to http://github.com/elastic/docs-content-internal/issues/514 by updating the 8.19 reporting docs and Kibana release notes. More specifically, this PR: - Modifies the the third sentence in note about CCS priv requirements for reporting. Replaces the term "leader" with "local". - Adds breaking change entries to the 8.19 Kibana release notes and the Kibana upgrade notes. This should make the change more visible to users who are upgrading to 8.19. ### Corresponding fixes - 9.1 reporting docs: elastic/docs-content#4211 - 9.1 Kibana release notes: #245183 ## Previews - [Automatically generate reports](https://kibana_bk_245182.docs-preview.app.elstc.co/guide/en/kibana/8.19/automating-report-generation.html) - Updated note - [Configure reporting in Kibana | Grant users access to reporting](https://kibana_bk_245182.docs-preview.app.elstc.co/guide/en/kibana/8.19/secure-reporting.html#grant-user-access) - Updated second note in the intro section of the page - [Upgrade notes | Breaking changes | Kibana platform](https://kibana_bk_245182.docs-preview.app.elstc.co/guide/en/kibana/8.19/breaking-changes-summary.html#_kibana_platform) - Added entry titled "[Sharing & Reporting] API keys are used for authenticating report generation requests. (8.19)" - [Kibana 8.19.0 | Breaking changes](https://kibana_bk_245182.docs-preview.app.elstc.co/guide/en/kibana/8.19/release-notes-8.19.0.html#breaking-changes-8.19.0) - Added entry titled "API keys are used for authenticating report generation requests" --------- Co-authored-by: Ying Mao <ying.mao@elastic.co>
1 parent 34d202b commit 3807fdb

4 files changed

Lines changed: 40 additions & 2 deletions

File tree

docs/CHANGELOG.asciidoc

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -480,6 +480,19 @@ Before you upgrade to 8.19.0, review the breaking changes, then mitigate the imp
480480
Fields and functions variables are now described with `??` in {esql} queries. For value variables, you can continue to use `?` ({kibana-pull}213916[#213916]).
481481
====
482482

483+
[discrete]
484+
.API keys are used for authenticating report generation requests
485+
[%collapsible]
486+
====
487+
*Details* +
488+
489+
Starting in 8.19.0, report generation requests are authenticated by API keys instead of session cookies. There are several key differences between the authentication methods. API keys capture your role privileges, whereas session cookie are based on your user credentials. API keys are also longer-lived, compared to session cookies, which have a shorter lifespan ({kibana-pull}216558[#216558]).
490+
491+
If you have a cross-cluster search environment and want to generate reports from remote clusters, you must have the appropriate cluster and index privileges on the remote cluster and local cluster. For example, if requests are authenticated with an API key, the API key requires certain privileges on the local cluster that contains the local index, in addition to the remote. For more information and examples, refer to {ref}/remote-clusters-cert.html#remote-clusters-privileges-cert[Configure roles and users for remote clusters].
492+
493+
====
494+
495+
483496
[float]
484497
[[deprecations-8.19.0]]
485498
=== Deprecations

docs/setup/configuring-reporting.asciidoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,10 @@ For security, you grant users access to the {report-features} and secure the rep
2525
[NOTE]
2626
============
2727
28-
In 8.19.0, API keys are used to authenticate requests to generate reports. If you have a cross-cluster search environment and want to generate reports from remote clusters, you must have the appropriate cluster and index privileges on the remote cluster and local cluster. For example, if requests are authenticated with an API key, the API key requires certain privileges on the local cluster that contains the leader index, instead of the remote. For more information and examples, refer to {ref}/remote-clusters-cert.html#remote-clusters-privileges-cert[Configure roles and users for remote clusters].
28+
Starting in 8.19.0, report generation requests are authenticated by API keys instead of session cookies. There are several key differences between the authentication methods. API keys capture your role privileges, whereas session cookie are based on your user credentials. API keys are also longer-lived, compared to session cookies, which have a shorter lifespan.
29+
30+
If you have a cross-cluster search environment and want to generate reports from remote clusters, you must have the appropriate cluster and index privileges on the remote cluster and local cluster. For example, if requests are authenticated with an API key, the API key requires certain privileges on the local cluster that contains the local index, in addition to the remote. For more information and examples, refer to {ref}/remote-clusters-cert.html#remote-clusters-privileges-cert[Configure roles and users for remote clusters].
31+
2932
============
3033

3134
* <<grant-user-access>>

docs/upgrade-notes.asciidoc

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1104,6 +1104,21 @@ logging:
11041104

11051105
// Sharing and reporting
11061106

1107+
1108+
[discrete]
1109+
[[breaking-216558]]
1110+
.[Sharing & Reporting] API keys are used for authenticating report generation requests. (8.19)
1111+
[%collapsible]
1112+
====
1113+
1114+
*Details* +
1115+
1116+
Starting in 8.19.0, report generation requests are authenticated by API keys instead of session cookies. There are several key differences between the authentication methods. API keys capture your role privileges, whereas session cookie are based on your user credentials. API keys are also longer-lived, compared to session cookies, which have a shorter lifespan ({kibana-pull}216558[#216558]).
1117+
1118+
If you have a cross-cluster search environment and want to generate reports from remote clusters, you must have the appropriate cluster and index privileges on the remote cluster and local cluster. For example, if requests are authenticated with an API key, the API key requires certain privileges on the local cluster that contains the local index, in addition to the remote. For more information and examples, refer to {ref}/remote-clusters-cert.html#remote-clusters-privileges-cert[Configure roles and users for remote clusters].
1119+
1120+
====
1121+
11071122
[discrete]
11081123
[[breaking-162288]]
11091124
.[Sharing & Reporting] The Download CSV endpoint has changed. (8.10)

docs/user/reporting/automating-report-generation.asciidoc

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,14 @@
44

55
To automatically generate PDF and CSV reports, generate a POST URL, then submit an HTTP `POST` request using {watcher} or a script. Alternatively, use {kib} to generate reports on a recurring schedule and share them with a list of emails that you specify.
66

7-
NOTE: In 8.19.0, API keys are used to authenticate requests to generate reports. If you have a cross-cluster search environment and want to generate reports from remote clusters, you must have the appropriate cluster and index privileges on the remote cluster and local cluster. For example, if requests are authenticated with an API key, the API key requires certain privileges on the local cluster that contains the leader index, instead of the remote. For more information and examples, refer to {ref}/remote-clusters-cert.html#remote-clusters-privileges-cert[Configure roles and users for remote clusters].
7+
[NOTE]
8+
============
9+
10+
Starting in 8.19.0, report generation requests are authenticated by API keys instead of session cookies. There are several key differences between the authentication methods. API keys capture your role privileges, whereas session cookie are based on your user credentials. API keys are also longer-lived, compared to session cookies, which have a shorter lifespan.
11+
12+
If you have a cross-cluster search environment and want to generate reports from remote clusters, you must have the appropriate cluster and index privileges on the remote cluster and local cluster. For example, if requests are authenticated with an API key, the API key requires certain privileges on the local cluster that contains the local index, in addition to the remote. For more information and examples, refer to {ref}/remote-clusters-cert.html#remote-clusters-privileges-cert[Configure roles and users for remote clusters].
13+
14+
============
815

916
[float]
1017
[[create-a-post-url]]

0 commit comments

Comments
 (0)