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

Fix AWS secret key environment variable name in docs #5566

Merged
merged 1 commit into from
Jun 17, 2021

Conversation

sandratiffin
Copy link

Signed-off-by: Sandra Tiffin sandra.tiffin@progress.com

The AWS platform support instructions give the wrong environment variable name for the secret access key, this fixes it.

Description

If you follow the AWS Command Line Interface Docs link on this page, it leads you to https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html which gives the correct variable name -- AWS_SECRET_ACCESS_KEY instead of AWS_SECRET_KEY_ID.

The same info is also in the ruby AWS SDK docs at https://docs.aws.amazon.com/sdk-for-ruby/v3/developer-guide/setup-config.html#aws-ruby-sdk-credentials-environment.

Related Issue

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New content (non-breaking change)
  • Breaking change (a content change which would break existing functionality or processes)

Checklist:

  • I have read the CONTRIBUTING document.

Signed-off-by: Sandra Tiffin <sandra.tiffin@progress.com>
@netlify
Copy link

netlify bot commented Jun 16, 2021

✔️ Deploy Preview for chef-inspec ready!

🔨 Explore the source changes: 71222c0

🔍 Inspect the deploy log: https://app.netlify.com/sites/chef-inspec/deploys/60c9d58e631f9c0007689da2

😎 Browse the preview: https://deploy-preview-5566--chef-inspec.netlify.app/inspec/platforms

@chef-expeditor
Copy link
Contributor

Hello sandratiffin! Thanks for the pull request!

Here is what will happen next:

  1. Your PR will be reviewed by the maintainers.
  2. Possible Outcomes
    a. If everything looks good, one of them will approve it, and your PR will be merged.
    b. The maintainer may request follow-on work (e.g. code fix, linting, etc). We would encourage you to address this work in 2-3 business days to keep the conversation going and to get your contribution in sooner.
    c. Cases exist where a PR is neither aligned to Chef InSpec's product roadmap, or something the team can own or maintain long-term. In these cases, the maintainer will provide justification and close out the PR.

Thank you for contributing!

@sandratiffin sandratiffin changed the title Fix AWS secret key environment variable name Fix AWS secret key environment variable name in docs Jun 16, 2021
Copy link
Contributor

@clintoncwolfe clintoncwolfe left a comment

Choose a reason for hiding this comment

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

Good catch, thanks!

@clintoncwolfe clintoncwolfe merged commit 2fa42ea into inspec:master Jun 17, 2021
@sandratiffin sandratiffin deleted the aws_creds branch June 17, 2021 15:51
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

3 participants