Skip to content

Documenting AWS IAM Role Support for S3 Configuration#2106

Closed
tinder-bharatchandrapenta wants to merge 1 commit intosecureCodeBox:mainfrom
tinder-bharatchandrapenta:patch-1
Closed

Documenting AWS IAM Role Support for S3 Configuration#2106
tinder-bharatchandrapenta wants to merge 1 commit intosecureCodeBox:mainfrom
tinder-bharatchandrapenta:patch-1

Conversation

@tinder-bharatchandrapenta
Copy link
Copy Markdown

By explicitly documenting this option, we make our tool more accessible and user-friendly, especially for those adhering to specific security policies or new to AWS services.

Description

Checklist

  • Test your changes as thoroughly as possible before you commit them. Preferably, automate your test by unit/integration tests.
  • Make sure that all your commits are signed-off and that you are added to the Contributors file.
  • Make sure that all CI finish successfully.
  • Optional (but appreciated): Make sure that all commits are Verified.

By explicitly documenting this option, we make our tool more accessible and user-friendly, especially for those adhering to specific security policies or new to AWS services.

Signed-off-by: Bharat <88349550+tinder-bharatchandrapenta@users.noreply.github.com>
@netlify
Copy link
Copy Markdown

netlify bot commented Nov 19, 2023

Deploy Preview for docs-securecodebox ready!

Name Link
🔨 Latest commit 1d345af
🔍 Latest deploy log https://app.netlify.com/sites/docs-securecodebox/deploys/655a6f221452500008c8ac45
😎 Deploy Preview https://deploy-preview-2106--docs-securecodebox.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@Weltraumschaf Weltraumschaf added the documentation Improvements or additions to documentation label Nov 20, 2023
@Weltraumschaf
Copy link
Copy Markdown
Member

Hi @tinder-bharatchandrapenta,

thanks for your contribution. We'll review it as soon as possible.

In the meantime, would you please register here as a contributor?

@Weltraumschaf Weltraumschaf requested a review from J12934 November 21, 2023 12:21
Copy link
Copy Markdown
Member

@Weltraumschaf Weltraumschaf left a comment

Choose a reason for hiding this comment

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

Thanks for your contribution <3

Please see my comment in the the code.

Also, please add your self to the CONTRIBUTORS.md and sign-off your commits. You can do it in this PR.

keySecret: securecodebox-s3-credentials
```
:::note
If you prefer to use AWS IAM roles instead of access keys for authentication, set s3.authType to aws-irsa and s3.awsStsEndpoint should be configured as https://sts.eu-west-1.amazonaws.com in your helm values. This approach leverages IAM roles for more secure and efficient access management.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

IMO it would be better to use a more generic URL e.g. https://sts.REGION.amazonaws.com to prevent user to simply copy & paste this and accidentally use a bad region. You should also encapsulate the URL with backticks to format it as code, since Docusaurus does not allow plain URLs in markdown anymore.

@sonarqubecloud
Copy link
Copy Markdown

Quality Gate Passed Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@Weltraumschaf
Copy link
Copy Markdown
Member

Weltraumschaf commented Feb 20, 2024

See #2314

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

2 participants