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.

Sign up for GitHub

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

ReadMe Review #2366

Merged
merged 6 commits into from
Dec 18, 2023
Merged

ReadMe Review #2366

Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
684539a
Update README.md
helenktsai Nov 29, 2023
2bbd082
Update README.md
helenktsai Dec 6, 2023
89a59b0
Update README.md
helenktsai Dec 14, 2023
68d0654
Update README.md
helenktsai Dec 17, 2023
4b4a85c
Update README.md
helenktsai Dec 17, 2023
8ab2d86
Update README.md
helenktsai Dec 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 6 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,27 +1,16 @@
# NServiceBus.AmazonSQS

This is an Amazon SQS transport for NServiceBus.
NServiceBus.AmazonSQS is the [Amazon SQS](https://docs.aws.amazon.com/sqs/) transport for NServiceBus.

Feel free to browse and contribute!
It is part of the [Particular Service Platform](https://particular.net/service-platform), which includes [NServiceBus](https://particular.net/nservicebus) and tools to build, monitor, and debug distributed systems.

For more information, including a guide on getting started quickly, see the project documentation at [docs.particular.net](https://docs.particular.net/transports/sqs/).
See the [Amazon SQS Transport documentation](https://docs.particular.net/transports/sqs/) to learn more.

## Running the Acceptance Tests
## Running tests locally

The solution contains the [NServiceBus Acceptance Test suite](https://www.nuget.org/packages/NServiceBus.AcceptanceTests.Sources/) and the [NServiceBus Transport Test suite](https://www.nuget.org/packages/NServiceBus.TransportTests.Sources/).
To run the tests, the Access Key ID and Secret Access Key of an AWS IAM account need to be set in environment variables on the machine running the tests. Full details on how to set this up can be found [here](https://docs.particular.net/transports/sqs/#getting-started-set-up-an-aws-account).

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.
Copy link
Contributor

@soujay soujay Dec 17, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

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}.kms with AWS KMS encryption enabled is also required. For further details review the documentation on configuration options.

Copy link
Member Author

@helenktsai helenktsai Dec 18, 2023 •
edited
Loading

Choose a reason for hiding this comment

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


Additional environment variables required for AWS:

* **AWS_ACCESS_KEY_ID** access key ID to sign programmatic requests that you make to AWS. Provisioned via IAM.
* **AWS_SECRET_ACCESS_KEY** secret access key to sign programmatic requests that you make to AWS. Provisioned via IAM.
* **AWS_REGION** Valid AWS region.
To run the tests, the Access Key ID and Secret Access Key of an AWS IAM account need to be set in environment variables on the machine running the tests. Full details on how to set this up can be found in the [Amazon SQS Transport documentation](https://docs.particular.net/transports/sqs/#prerequisites).

## AWS Permissions

Expand Down Expand Up @@ -58,6 +47,6 @@ This scheme accomplishes the following goals:

## Cleanup scheduled task

This repo has a [GitHub action](/actions/workflows/tests-cleanup.yml) that deletes stale AWS objects created when the tests run. It takes care of deleting S3 buckets older than 24 hours with the cli- prefix in the name. The same GitHub action code can be updated to delete any other AWS object created by the tests that fail to be deleted during the tests cleanup phase.
This repo has a [GitHub action](/.github/workflows/tests-cleanup.yml) that deletes stale AWS objects created when the tests run. It takes care of deleting S3 buckets older than 24 hours with the cli- prefix in the name. The same GitHub action code can be updated to delete any other AWS object created by the tests that fail to be deleted during the tests cleanup phase.

The cleanup workflow requires the same permissions as running the tests.