ReadMe Review #2366
Merged
ReadMe Review #2366
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
helenktsai
commented
Nov 29, 2023
•
helenktsai
commented
- Apply format template with link to component documentation
- Ensure no dead links
soujay
reviewed
Dec 17, 2023
soujay
reviewed
Dec 17, 2023
soujay
reviewed
Dec 17, 2023
|
|
||
| * **NSERVICEBUS_AMAZONSQS_S3BUCKET** corresponds to the [S3BucketForLargeMessages](https://docs.particular.net/transports/sqs/configuration-options#s3bucketforlargemessages) parameter. Default is no S3 bucket. | ||
|
|
||
| The bucket should not have encryption enabled. An additional bucket `{NSERVICEBUS_AMAZONSQS_S3BUCKET}.kms` with AWS KMS encryption enabled is required. |
There was a problem hiding this comment.
I think it is best to add this back in as the variable is used in ci.yml
- NSERVICEBUS_AMAZONSQS_S3BUCKET corresponds to the S3BucketForLargeMessages parameter. This is disabled by default. When enabled, the bucket should not have encryption enabled. An additional bucket
{NSERVICEBUS_AMAZONSQS_S3BUCKET}.kmswith AWS KMS encryption enabled is also required. For further details review the documentation on configuration options.
Co-authored-by: Jayanthi <[email protected]>
Co-authored-by: Jayanthi <[email protected]>
helenktsai
commented
Dec 18, 2023
README.md
Outdated
Comment on lines
14
to
18
| The transport can be configured using the following environment variables: | ||
|
|
||
| * **NSERVICEBUS_AMAZONSQS_S3BUCKET** corresponds to the [S3BucketForLargeMessages](https://docs.particular.net/transports/sqs/configuration-options#s3bucketforlargemessages) parameter. Default is no S3 bucket. | ||
|
|
||
| The bucket should not have encryption enabled. An additional bucket `{NSERVICEBUS_AMAZONSQS_S3BUCKET}.kms` with AWS KMS encryption enabled is required. |
There was a problem hiding this comment.
- NSERVICEBUS_AMAZONSQS_S3BUCKET enables offloading large messages to S3. This is disabled by default. When enabled, the bucket should not have encryption enabled. For further details review the documentation on configuration options.
soujay
approved these changes
Dec 18, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.