Skip to content

Commit 397f222

Browse files
nastasha-solomonnaemono
authored andcommitted
[DOCS][ResponseOps][Reporting][9.1 & Serv] Add documentation about required privileges with API key authentication (elastic#2885)
Contributes to elastic#2679 by adding a note about the new API authentication key method that was implemented for report generation in 8.19. The note also explains the specific cluster and index privileges that users with cross-cluster search environments must have. Previews: - [Automatically generate reports](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/2885/explore-analyze/report-and-share/automating-report-generation) - [Configure reporting in Kibana | Configuration overview](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/2885/deploy-manage/kibana-reporting-configuration#configuration-overview) **Corresponding 8.19 doc updates:** elastic/kibana#234255
1 parent 789a83c commit 397f222

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

deploy-manage/kibana-reporting-configuration.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,11 @@ Before upgrading {{kib}} in a production environment, we encourage you to test y
3636

3737
To secure {{report-features}}, you must grant users access to reporting functionality and protect the reporting endpoints with TLS/SSL encryption. Additionally, you can install graphical packages on the operating system to enable screenshot capabilities in the {{kib}} server.
3838

39+
:::{note}
40+
:applies_to: {stack: ga, serverless: unavailable}
41+
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 [Configure roles and users for remote clusters](../deploy-manage/remote-clusters/remote-clusters-cert.md#remote-clusters-privileges-cert).
42+
:::
43+
3944
Configuring reporting in your environment involves two main areas:
4045

4146
### Granting users access to {{report-features}}

explore-analyze/report-and-share/automating-report-generation.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,11 @@ products:
1212

1313
To automatically generate PDF and CSV reports, generate a POST URL, then submit an HTTP `POST` request using {{watcher}} or a script. In {{stack}} 9.1 and Serverless, you can use {{kib}} to generate reports on a recurring schedule and share them with a list of emails that you specify.
1414

15+
:::{note}
16+
:applies_to: {stack: ga, serverless: unavailable}
17+
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 [Configure roles and users for remote clusters](../../deploy-manage/remote-clusters/remote-clusters-cert.md#remote-clusters-privileges-cert).
18+
:::
19+
1520
## Create a POST URL [create-a-post-url]
1621

1722
Create the POST URL that triggers a report to generate PDF and CSV reports.

0 commit comments

Comments
 (0)