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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rearrange docs to de-emphasize using AWS static credentials #8308

Merged
merged 7 commits into from May 21, 2019

Conversation

Projects
None yet
3 participants
@topfunky
Copy link
Contributor

commented Apr 12, 2019

Moves description of static credentials to the bottom of the authentication docs. This will encourage new practitioners to use environment variables, roles, or other authentication methods rather than hard-coding sensitive AWS creds in their Terraform files.

It also adds a warning to the static credentials section in order to educate the practitioner about the risks of hard-coding static credentials.

Community Note

  • Please vote on this pull request by adding a 馃憤 reaction to the original pull request comment to help the community and maintainers prioritize this request
  • Please do not leave "+1" comments, they generate extra noise for pull request followers and do not help prioritize the request

Changes proposed in this pull request:

  • Moves description of static credentials to the bottom of the authentication docs. This will encourage new practitioners to use environment variables, roles, or other authentication methods rather than hard-coding sensitive AWS creds in their Terraform files.

topfunky added some commits Apr 12, 2019

De-emphasize static credentials
Moves static credentials to bottom in order to better communicate best
practices.
De-emphasize static credentials in docs
Encourages best practices by moving docs on static credentials to the bottom of
the provider.
Show resolved Hide resolved website/docs/index.html.markdown Outdated
Show resolved Hide resolved website/docs/index.html.markdown Outdated
Show resolved Hide resolved website/docs/index.html.markdown Outdated
@bflad

This comment has been minimized.

Copy link
Member

commented Apr 24, 2019

Hi @topfunky 馃憢 Are you planning on adjusting this pull request based on the above feedback or would you like us to?

topfunky added some commits May 20, 2019

List static credentials at top with warning
Keep static credentials at top of list since it's executed first by the provider
code.

A warning is added to keep the practitioner from using this functionality in an
unsafe manner.

@hashibot hashibot bot added size/XS and removed size/S labels May 20, 2019

topfunky added some commits May 20, 2019

Use VPC resource example for stability
A compute instance was shown previously but could easily drift out of date due
to the AMI ID. A VPC is used instead since it is less likely to change.
@topfunky

This comment has been minimized.

Copy link
Contributor Author

commented May 20, 2019

Resolved and ready for review or merge.

@hashibot hashibot bot removed the waiting-response label May 20, 2019

@bflad

bflad approved these changes May 21, 2019

Copy link
Member

left a comment

Thanks for the updates! LGTM 馃殌

@bflad bflad added this to the v2.12.0 milestone May 21, 2019

@bflad bflad merged commit cfad83e into terraform-providers:master May 21, 2019

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can鈥檛 perform that action at this time.