Skip to content

Commit

Permalink
[awsfirehose] Update documentation around restricted API key permissi…
Browse files Browse the repository at this point in the history
…ons (elastic#11991)

* Update documentation around restricted API key permissions
  • Loading branch information
kaiyan-sheng authored Dec 4, 2024
1 parent 5c36dcf commit bf16c33
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 11 deletions.
14 changes: 9 additions & 5 deletions packages/awsfirehose/_dev/build/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,9 +85,11 @@ This is a current limitation in Firehose, which we are working with AWS to resol
This endpoint can be found in the Elastic Cloud console. An example is https://my-deployment-28u274.es.eu-west-1.aws.found.io.

2. **API key** should be a Base64 encoded Elastic API key, which can be created in Kibana by following the
instructions under API Keys. If you are using an API key with “Restrict privileges”, be sure to review the Indices
instructions under API Keys. If you are using an API key with “Restricted privileges”, be sure to review the Indices
privileges to provide at least "auto_configure" & "write" permissions for the indices you will be using with this
delivery stream.
delivery stream. By default, logs will be stored in `logs-awsfirehose-default` index and metrics will be stored in
`metrics-aws.cloudwatch-default` index. Therefore, Elastic highly recommends giving `logs-awsfirehose-default` and
`metrics-aws.cloudwatch-default` indices with "write" privilege.

3. We recommend leaving **Content encoding** set to **GZIP** for improved network efficiency.

Expand All @@ -101,9 +103,11 @@ This is a current limitation in Firehose, which we are working with AWS to resol

7. **Parameters**

1. Elastic recommends setting the `es_datastream_name` parameter to `logs-awsfirehose-default` in order to
leverage the routing rules defined in this integration. If this parameter is not specified, data is sent to the
`logs-generic-default` data stream by default.
1. Elastic recommends only setting the `es_datastream_name` parameter when ingesting logs that are not supported
by this Firehose integration. If this parameter is not specified, data is sent to the `logs-awsfirehose-default`
index by default and the routing rules defined in this integration will be applied automatically.
Please make sure the index specified with this `es_datastream_name` parameter has the proper permission given by
the API key.
![Firehose Destination Settings](../img/destination-settings.png)

2. The **include_cw_extracted_fields** parameter is optional and can be set when using a CloudWatch logs subscription
Expand Down
5 changes: 5 additions & 0 deletions packages/awsfirehose/changelog.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# newer versions go on top
- version: "1.3.1"
changes:
- description: Update documentation about restrict API key permissions
type: enhancement
link: https://github.com/elastic/integrations/pull/11991
- version: "1.3.0"
changes:
- description: Add aws.firehose.arn and aws.firehose.request_id fields.
Expand Down
14 changes: 9 additions & 5 deletions packages/awsfirehose/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,9 +85,11 @@ This is a current limitation in Firehose, which we are working with AWS to resol
This endpoint can be found in the Elastic Cloud console. An example is https://my-deployment-28u274.es.eu-west-1.aws.found.io.

2. **API key** should be a Base64 encoded Elastic API key, which can be created in Kibana by following the
instructions under API Keys. If you are using an API key with “Restrict privileges”, be sure to review the Indices
instructions under API Keys. If you are using an API key with “Restricted privileges”, be sure to review the Indices
privileges to provide at least "auto_configure" & "write" permissions for the indices you will be using with this
delivery stream.
delivery stream. By default, logs will be stored in `logs-awsfirehose-default` index and metrics will be stored in
`metrics-aws.cloudwatch-default` index. Therefore, Elastic highly recommends giving `logs-awsfirehose-default` and
`metrics-aws.cloudwatch-default` indices with "write" privilege.

3. We recommend leaving **Content encoding** set to **GZIP** for improved network efficiency.

Expand All @@ -101,9 +103,11 @@ This is a current limitation in Firehose, which we are working with AWS to resol

7. **Parameters**

1. Elastic recommends setting the `es_datastream_name` parameter to `logs-awsfirehose-default` in order to
leverage the routing rules defined in this integration. If this parameter is not specified, data is sent to the
`logs-generic-default` data stream by default.
1. Elastic recommends only setting the `es_datastream_name` parameter when ingesting logs that are not supported
by this Firehose integration. If this parameter is not specified, data is sent to the `logs-awsfirehose-default`
index by default and the routing rules defined in this integration will be applied automatically.
Please make sure the index specified with this `es_datastream_name` parameter has the proper permission given by
the API key.
![Firehose Destination Settings](../img/destination-settings.png)

2. The **include_cw_extracted_fields** parameter is optional and can be set when using a CloudWatch logs subscription
Expand Down
Binary file modified packages/awsfirehose/img/destination-settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion packages/awsfirehose/manifest.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
format_version: "3.1.0"
name: awsfirehose
title: Amazon Data Firehose
version: 1.3.0
version: 1.3.1
description: Stream logs and metrics from Amazon Data Firehose into Elastic Cloud.
type: integration
categories:
Expand Down

0 comments on commit bf16c33

Please sign in to comment.