From 684539a0cca9b8b96a635341ee8275736239e0a3 Mon Sep 17 00:00:00 2001 From: Helen T <35390871+helenktsai@users.noreply.github.com> Date: Wed, 29 Nov 2023 12:02:00 -0800 Subject: [PATCH 1/6] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index abe1063d1..31f95f9fb 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,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. From 2bbd08259753726126d1d08655017211690eb985 Mon Sep 17 00:00:00 2001 From: Helen T <35390871+helenktsai@users.noreply.github.com> Date: Wed, 6 Dec 2023 15:02:00 -0800 Subject: [PATCH 2/6] Update README.md --- README.md | 23 +++++++---------------- 1 file changed, 7 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 31f95f9fb..8ca67de9e 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,18 @@ # NServiceBus.AmazonSQS -This is an Amazon SQS transport for NServiceBus. +NServiceBus.AmazonSQS is the Amazon 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/). +# Documentation -## Running the Acceptance Tests +See the [Amazon SQS Transport documentation](https://docs.particular.net/transports/sqs/) for more details on how to use it. -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. +## Running tests locally -The bucket should not have encryption enabled. An additional bucket `{NSERVICEBUS_AMAZONSQS_S3BUCKET}.kms` with AWS KMS encryption enabled is required. - -Additional environment variables required for AWS: +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/). - * **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/). ## AWS Permissions From 89a59b088a764c75fbd0ed747c2392a811460ee6 Mon Sep 17 00:00:00 2001 From: Helen T <35390871+helenktsai@users.noreply.github.com> Date: Wed, 13 Dec 2023 22:52:18 -0800 Subject: [PATCH 3/6] Update README.md --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index 8ca67de9e..c68d97293 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,7 @@ NServiceBus.AmazonSQS is the Amazon SQS transport for NServiceBus. 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. -# Documentation - -See the [Amazon SQS Transport documentation](https://docs.particular.net/transports/sqs/) for more details on how to use it. +See the [Amazon SQS Transport documentation](https://docs.particular.net/transports/sqs/) to learn more. ## Running tests locally From 68d06549ba9265f8e3e4f3d00769537e6f091d61 Mon Sep 17 00:00:00 2001 From: Helen T <35390871+helenktsai@users.noreply.github.com> Date: Sun, 17 Dec 2023 15:28:11 -0800 Subject: [PATCH 4/6] Update README.md Co-authored-by: Jayanthi --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c68d97293..29067ae0c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # NServiceBus.AmazonSQS -NServiceBus.AmazonSQS is the Amazon SQS transport for NServiceBus. +NServiceBus.AmazonSQS is the [Amazon SQS](https://docs.aws.amazon.com/sqs/) transport for NServiceBus. 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. From 4b4a85c5eb86e4ebadcbd3d687e1e12562775563 Mon Sep 17 00:00:00 2001 From: Helen T <35390871+helenktsai@users.noreply.github.com> Date: Sun, 17 Dec 2023 15:30:04 -0800 Subject: [PATCH 5/6] Update README.md Co-authored-by: Jayanthi --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 29067ae0c..60f446db2 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ See the [Amazon SQS Transport documentation](https://docs.particular.net/transpo 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 in the [Amazon SQS Transport documentation](https://docs.particular.net/transports/sqs/). +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 From 8ab2d86bca16e9c9f7d42c8cd89aea90629a2929 Mon Sep 17 00:00:00 2001 From: Helen T <35390871+helenktsai@users.noreply.github.com> Date: Mon, 18 Dec 2023 10:50:21 -0800 Subject: [PATCH 6/6] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 60f446db2..44d0a0a65 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,8 @@ The solution contains the [NServiceBus Acceptance Test suite](https://www.nuget. 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). +**NSERVICEBUS_AMAZONSQS_S3BUCKET** enables [offloading large messages to S3](https://docs.particular.net/transports/sqs/configuration-options#offload-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](https://docs.particular.net/transports/sqs/configuration-options). + ## AWS Permissions In addition to the [permissions required to run the transport](https://docs.particular.net/transports/sqs/#prerequisites), running the tests also requires: