You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@druid.apache.org by "abhishekrb19 (via GitHub)" <gi...@apache.org> on 2023/08/07 17:06:51 UTC
[PR] Update kinesis docs (druid)
abhishekrb19 opened a new pull request, #14768:
URL: https://github.com/apache/druid/pull/14768
Updates AWS authentication info in kinesis docs. AWS doesn't recommend using long term credentials for security reasons, so move that below the other methods of authentication. Also, fix the policy name `DescribeStream`.
This PR has:
- [x] been self-reviewed.
- [x] added documentation for new or modified features or behaviors.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
Re: [PR] Update kinesis docs (druid)
Posted by "abhishekrb19 (via GitHub)" <gi...@apache.org>.
abhishekrb19 commented on code in PR #14768:
URL: https://github.com/apache/druid/pull/14768#discussion_r1286449193
##########
docs/development/extensions-core/kinesis-ingestion.md:
##########
@@ -428,14 +428,26 @@ This section describes how to use the [Supervisor API](../../api-reference/super
### AWS authentication
-To authenticate with AWS, you must provide your AWS access key and AWS secret key using `runtime.properties`, for example:
+Druid uses AWS access and secret keys to authenticate Kinesis API requests. There are a few ways to provide this information to Druid:
-```text
+1. Using roles or short-term credentials:
Review Comment:
thanks, done!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
Re: [PR] Update kinesis docs (druid)
Posted by "ektravel (via GitHub)" <gi...@apache.org>.
ektravel commented on code in PR #14768:
URL: https://github.com/apache/druid/pull/14768#discussion_r1286441271
##########
docs/development/extensions-core/kinesis-ingestion.md:
##########
@@ -428,14 +428,26 @@ This section describes how to use the [Supervisor API](../../api-reference/super
### AWS authentication
-To authenticate with AWS, you must provide your AWS access key and AWS secret key using `runtime.properties`, for example:
+Druid uses AWS access and secret keys to authenticate Kinesis API requests. There are a few ways to provide this information to Druid:
-```text
+1. Using roles or short-term credentials:
+
+Druid looks for credentials set in [environment variables](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html),
+via [Web Identity Token](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html), in the
+default [profile configuration file](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html), and from the
+EC2 instance profile provider (in this order).
+
+2. Using long-term security credentials:
+
+You can directly provide your AWS access key and AWS secret key in the `common.runtime.properties` file as shown in the example below:
+
+```properties
druid.kinesis.accessKey=AKIAWxxxxxxxxxx4NCKS
druid.kinesis.secretKey=Jbytxxxxxxxxxxx2+555
```
-Druid uses the AWS access key and AWS secret key to authenticate Kinesis API requests. If not provided, the service looks for credentials set in environment variables, via [Web Identity Token](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html), in the default profile configuration file, and from the EC2 instance profile provider (in this order).
+> Note: AWS does not recommend providing long-term security credentials in configuration files since it might pose a security risk.
+If this approach is used, it takes precedence over all other methods of providing credentials.
Review Comment:
```suggestion
If you use this approach, it takes precedence over all other methods of providing credentials.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
Re: [PR] Update kinesis docs (druid)
Posted by "ektravel (via GitHub)" <gi...@apache.org>.
ektravel commented on code in PR #14768:
URL: https://github.com/apache/druid/pull/14768#discussion_r1286440867
##########
docs/development/extensions-core/kinesis-ingestion.md:
##########
@@ -428,14 +428,26 @@ This section describes how to use the [Supervisor API](../../api-reference/super
### AWS authentication
-To authenticate with AWS, you must provide your AWS access key and AWS secret key using `runtime.properties`, for example:
+Druid uses AWS access and secret keys to authenticate Kinesis API requests. There are a few ways to provide this information to Druid:
-```text
+1. Using roles or short-term credentials:
Review Comment:
```suggestion
1. Using roles or short-term credentials:
```
Lines 435-438 do not align with line 433. Consider indenting the first line of the paragraph to align it with line 433. The same suggestion applies to lines 440 and 442.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
Re: [PR] Update kinesis docs (druid)
Posted by "vtlim (via GitHub)" <gi...@apache.org>.
vtlim merged PR #14768:
URL: https://github.com/apache/druid/pull/14768
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
Re: [PR] Update kinesis docs (druid)
Posted by "ektravel (via GitHub)" <gi...@apache.org>.
ektravel commented on code in PR #14768:
URL: https://github.com/apache/druid/pull/14768#discussion_r1286440867
##########
docs/development/extensions-core/kinesis-ingestion.md:
##########
@@ -428,14 +428,26 @@ This section describes how to use the [Supervisor API](../../api-reference/super
### AWS authentication
-To authenticate with AWS, you must provide your AWS access key and AWS secret key using `runtime.properties`, for example:
+Druid uses AWS access and secret keys to authenticate Kinesis API requests. There are a few ways to provide this information to Druid:
-```text
+1. Using roles or short-term credentials:
Review Comment:
```suggestion
1. Using roles or short-term credentials.
```
Lines 435-438 do not align with line 433. Consider indenting the first line of the paragraph to align it with line 433. The same suggestion applies to lines 440 and 442.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org