Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add section in readme to note it uses the aws-sdk-go and hence honors… #21

Conversation

defond0
Copy link
Contributor

@defond0 defond0 commented Feb 15, 2019

… the AWS_SDK_LOAD_CONFIG variable

Description of changes:
This is just adding mention to the readme about how to configure IAM roles for the daemon. This should be pretty straight forward to anyone looking at the repo and who has worked with the aws_sdk_go. This is mostly because other closed source documentation sources like this make mention of default credential resolutions, without making it clear that it is the go sdk default, not the broader default .

This method addresses the concerns in #19
without changing the behavior of the daemon itself.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.


## Configuration

The Aws X-Ray Daemon follows default credential resolution for the [aws-sdk-go](https://docs.aws.amazon.com/sdk-for-go/api/index.html).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we rename Aws to AWS

@@ -40,6 +40,13 @@ You can also use [Glide](https://github.com/Masterminds/glide) to manage depende
```
glide install
```

## Configuration
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be Credential Configuration, since X-Ray daemon can be configured through cmd or cfg.yaml file.


The Aws X-Ray Daemon follows default credential resolution for the [aws-sdk-go](https://docs.aws.amazon.com/sdk-for-go/api/index.html).

Follow the guidelines [here](https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html) to configure an IAM role for the AWS X-Ray Daemon to run under.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can rephrase to "Follow the configuration guidelines here".
and remove "to configure an IAM role for the AWS X-Ray Daemon to run under.", since the link is generic and not just specific to IAM roles.

@yogiraj07 yogiraj07 merged commit 583c302 into aws:master Apr 8, 2019
@yogiraj07
Copy link
Contributor

Hi @defond0 ,
I have merged the PR. Since the Readme changes requested were nitpicks, I would do it myself.

Thanks.
Yogi

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants