Skip to content

chore(assets): make error less ominous#18067

Merged
mergify[bot] merged 2 commits intomasterfrom
huijbers/less-scary-message
Dec 17, 2021
Merged

chore(assets): make error less ominous#18067
mergify[bot] merged 2 commits intomasterfrom
huijbers/less-scary-message

Conversation

@rix0rrr
Copy link
Copy Markdown
Contributor

@rix0rrr rix0rrr commented Dec 17, 2021

cdk-assets tries to opportunistically read the bucket's encryption
settings and mirror those out into the PutObject call, so that a
commonly-used SCP can confirm that there are no unencryped uploads
to S3 buckets, ever. When this read-out fails, we print an error
message at debug severity to let users know what's up.

Unfortunately, the error message was very scary and makes users
wonder what is going on:

Why do I get a debug: ACCES_DENIED error there? Is it a problem?

verbose: [0%] debug: ACCES_DENIED for getting encryption of bucket
'cdk-hnb659fds-assets-111111111111-us-east-1'. Either wrong account
111111111111 or s3:GetEncryptionConfiguration not set for cdk role. Try
"cdk bootstrap" again.

Make the error message more clearly indicate that this is a failure
in an opportunistic code path and there's no direct action required:

Could not read encryption settings of bucket
'cdk-hnb659fds-assets-111111111111-us-east-1': uploading with default
settings ("cdk bootstrap" to version 9 if your organization's policies
prevent a successful upload or to get rid of this message).

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

`cdk-assets` tries to opportunistically read the bucket's encryption
settings and mirror those out into the `PutObject` call, so that a
commonly-used SCP can confirm that there are no unencryped uploads
to S3 buckets, ever. When this read-out fails, we print an error
message at `debug` severity to let users know what's up.

Unfortunately, the error message was very scary and makes users
wonder what is going on:

> Why do I get a debug: ACCES_DENIED error there? Is it a problem?
>
> ```
> verbose: [0%] debug: ACCES_DENIED for getting encryption of bucket
> 'cdk-hnb659fds-assets-111111111111-us-east-1'. Either wrong account
> 111111111111 or s3:GetEncryptionConfiguration not set for cdk role. Try
> "cdk bootstrap" again.
> ```

Make the error message more clearly indicate that this is a failure
in an opportunistic code path and there's no direct action required:

```
Could not read encryption settings of bucket
'cdk-hnb659fds-assets-111111111111-us-east-1': uploading with default
settings ("cdk bootstrap" to version 9 if your organization's policies
prevent a successful upload or to get rid of this message).
```
@rix0rrr rix0rrr requested a review from a team December 17, 2021 10:32
@rix0rrr rix0rrr self-assigned this Dec 17, 2021
@gitpod-io
Copy link
Copy Markdown

gitpod-io bot commented Dec 17, 2021

@github-actions github-actions bot added the @aws-cdk/assets Related to the @aws-cdk/assets package label Dec 17, 2021
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Dec 17, 2021
@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Dec 17, 2021

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@aws-cdk-automation
Copy link
Copy Markdown
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildProject89A8053A-LhjRyN9kxr8o
  • Commit ID: 1079c33
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@mergify mergify bot merged commit 60cf960 into master Dec 17, 2021
@mergify mergify bot deleted the huijbers/less-scary-message branch December 17, 2021 13:26
@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Dec 17, 2021

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

TikiTDO pushed a commit to TikiTDO/aws-cdk that referenced this pull request Feb 21, 2022
`cdk-assets` tries to opportunistically read the bucket's encryption
settings and mirror those out into the `PutObject` call, so that a
commonly-used SCP can confirm that there are no unencryped uploads
to S3 buckets, ever. When this read-out fails, we print an error
message at `debug` severity to let users know what's up.

Unfortunately, the error message was very scary and makes users
wonder what is going on:

> Why do I get a debug: ACCES_DENIED error there? Is it a problem?
>
> ```
> verbose: [0%] debug: ACCES_DENIED for getting encryption of bucket
> 'cdk-hnb659fds-assets-111111111111-us-east-1'. Either wrong account
> 111111111111 or s3:GetEncryptionConfiguration not set for cdk role. Try
> "cdk bootstrap" again.
> ```

Make the error message more clearly indicate that this is a failure
in an opportunistic code path and there's no direct action required:

```
Could not read encryption settings of bucket
'cdk-hnb659fds-assets-111111111111-us-east-1': uploading with default
settings ("cdk bootstrap" to version 9 if your organization's policies
prevent a successful upload or to get rid of this message).
```


----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

@aws-cdk/assets Related to the @aws-cdk/assets package contribution/core This is a PR that came from AWS.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants