Skip to content
This repository was archived by the owner on Sep 28, 2022. It is now read-only.

Commit 6b84893

Browse files
committed
Updating README file
1 parent eaceb00 commit 6b84893

File tree

1 file changed

+24
-28
lines changed

1 file changed

+24
-28
lines changed

README.md

Lines changed: 24 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Distributed Load Testing Using Fargate
22

3-
This solution walks you through a prescriptive implementation of Distributed Load Testing using
3+
This project launches a solution that runs Distributed Load Tests using
44
[AWS Fargate](https://aws.amazon.com/fargate) and [Taurus](https://gettaurus.org). You can use it to test your
55
services under high stress scenarios and understand it's behavior and scalability.
66

@@ -28,38 +28,32 @@ This sample code is made available under a modified MIT license. See the LICENSE
2828

2929
### 1. Launch Solution
3030

31-
In this step you will launch the `Master` CloudFormation stack that will create a Fargate Cluster, an ECR Docker registry, an IAM
31+
In this step you will launch the `master` CloudFormation stack that will create a Fargate Cluster, an ECR Docker registry, an IAM
3232
Execution Role, a Task Definition, a CloudWatch Log Group, a Security Group, a new VPC, a CodeCommit repository, a CodePipeline
3333
and 2 CodeBuild projects with their associated IAM Roles.
3434

3535
Region Name | Region Code | Launch
3636
------|-----|-----
37-
US East (N. Virginia) | us-east-1 | [![Launch in us-east-1](https://camo.githubusercontent.com/210bb3bfeebe0dd2b4db57ef83837273e1a51891/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f636c6f7564666f726d6174696f6e2d6578616d706c65732f636c6f7564666f726d6174696f6e2d6c61756e63682d737461636b2e706e67)](https://console.aws.amazon.com/cloudformation/home?region=us-east-1#/stacks/new?stackName=DistributedLoadTesting&templateURL=https://s3-us-west-2.amazonaws.com/load-testing-using-aws-fargate/artifacts/templates/master.yaml)
38-
US East (Ohio) | us-east-2 | [![Launch in us-east-2](https://camo.githubusercontent.com/210bb3bfeebe0dd2b4db57ef83837273e1a51891/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f636c6f7564666f726d6174696f6e2d6578616d706c65732f636c6f7564666f726d6174696f6e2d6c61756e63682d737461636b2e706e67)](https://console.aws.amazon.com/cloudformation/home?region=us-east-2#/stacks/new?stackName=DistributedLoadTesting&templateURL=https://s3-us-west-2.amazonaws.com/load-testing-using-aws-fargate/artifacts/templates/master.yaml)
39-
US West (Oregon) | us-west-2 | [![Launch in us-west-2](https://camo.githubusercontent.com/210bb3bfeebe0dd2b4db57ef83837273e1a51891/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f636c6f7564666f726d6174696f6e2d6578616d706c65732f636c6f7564666f726d6174696f6e2d6c61756e63682d737461636b2e706e67)](https://console.aws.amazon.com/cloudformation/home?region=us-west-2#/stacks/new?stackName=DistributedLoadTesting&templateURL=https://s3-us-west-2.amazonaws.com/load-testing-using-aws-fargate/artifacts/templates/master.yaml)
37+
US East (N. Virginia) | us-east-1 | [![Launch in us-east-1](https://camo.githubusercontent.com/210bb3bfeebe0dd2b4db57ef83837273e1a51891/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f636c6f7564666f726d6174696f6e2d6578616d706c65732f636c6f7564666f726d6174696f6e2d6c61756e63682d737461636b2e706e67)](https://console.aws.amazon.com/cloudformation/home?region=us-east-1#/stacks/new?stackName=DistributedLoadTesting&templateURL=https://s3.amazonaws.com/distributed-load-testing-using-aws-fargate/templates/master.yaml)
38+
US East (Ohio) | us-east-2 | [![Launch in us-east-2](https://camo.githubusercontent.com/210bb3bfeebe0dd2b4db57ef83837273e1a51891/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f636c6f7564666f726d6174696f6e2d6578616d706c65732f636c6f7564666f726d6174696f6e2d6c61756e63682d737461636b2e706e67)](https://console.aws.amazon.com/cloudformation/home?region=us-east-2#/stacks/new?stackName=DistributedLoadTesting&templateURL=https://s3.amazonaws.com/distributed-load-testing-using-aws-fargate/templates/master.yaml)
39+
US West (Oregon) | us-west-2 | [![Launch in us-west-2](https://camo.githubusercontent.com/210bb3bfeebe0dd2b4db57ef83837273e1a51891/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f636c6f7564666f726d6174696f6e2d6578616d706c65732f636c6f7564666f726d6174696f6e2d6c61756e63682d737461636b2e706e67)](https://console.aws.amazon.com/cloudformation/home?region=us-west-2#/stacks/new?stackName=DistributedLoadTesting&templateURL=https://s3.amazonaws.com/distributed-load-testing-using-aws-fargate/templates/master.yaml)
4040

41-
After launching it, notice that the CloudFormation stack expands itself into 3 additional nested stacks: The master stack,
42-
which takes care of creating resources that will be shared across regions like the ECR Registry and the CodePipeline;
43-
The VPC nested stack, which creates the network configuration and subnets; The Fargate nested stack which creates the cluster
44-
and task definition and the Pipeline nested stack that creates the CodeCommit repository and the CodeBuild projects to
45-
build and run the load tests in Fargate.
41+
You will notice that the CloudFormation `master` stack expands itself into 4 stacks: The master one, which takes care of
42+
creating resources that will be shared across regions like the ECR Registry and the CodePipeline; The VPC nested stack,
43+
which creates the network configuration and subnets; The Fargate nested stack which creates the cluster and task definition
44+
and the Pipeline nested stack that creates the CodeCommit repository and the CodeBuild projects to build and run the
45+
load tests in Fargate.
4646

4747
### 2. Clone this repository
4848

4949
```bash
5050
git clone https://github.com/aws-samples/distributed-load-testing-using-aws-fargate.git
5151
```
5252

53-
Switch to the latest release so you have a stable code base.
54-
55-
```bash
56-
git checkout tags/v1.0-beta
57-
```
58-
5953
### 3. Modify the load test scenario
6054

61-
Configure your test scenario by editing the `examples/http/taurus.yml` file.
62-
To learn more about the syntax of this file, check the Taurus docs: https://gettaurus.org/kb/Index .
55+
Configure your test scenario by editing the `examples/http/taurus.yml` file. The default example shown below runs a load test
56+
for 5 minutes with 5 concurrent requests per second against https://aws.amazon.com with a ramp-up time of 1 minute.
6357

6458
```yaml
6559
execution:
@@ -71,15 +65,17 @@ execution:
7165
scenarios:
7266
aws-website-test:
7367
requests:
74-
- http://aws.amazon.com
68+
- https://aws.amazon.com
7569
```
7670
71+
To learn more about the syntax of this file, check the Taurus docs: https://gettaurus.org/kb/Index.
72+
7773
### 4. Push to CodeCommit
7874
79-
One of the resources that got created when deploying this solution is a CodeCommit repository to store this project along
80-
with your load test scenarios. It also created a CodePipeline connected to this repository, such that when you push a
81-
new commit the pipeline will be triggered automatically, build your load test scenarios into a Docker image, push the
82-
image to the ECR registry and then run the tests into the Fargate cluster; all of this automatically!
75+
One of the resources that gets created when deploying this solution is a CodeCommit repository that stores your
76+
your load test scenarios. A CodePipeline was also created and connected to the CodeCommit repository, such that when you
77+
push a new commit the pipeline will be triggered automatically, build your load test scenarios into a Docker image, push
78+
the image to the ECR registry and then run the tests into the Fargate cluster; all of this automatically!
8379
8480
First, remove the current Git origin of the project because you just cloned it from Github.
8581
@@ -93,8 +89,8 @@ Now, set the origin to be your new CodeCommit repository.
9389
git remote add origin {code_commit_repository_url}
9490
```
9591

96-
Finally, push the project to the repository. Note that after you push this, the deployment pipeline will be triggered
97-
automatically and therefore the load tests will be run on the Fargate cluster.
92+
Finally, push the code. Note that after you push this, the deployment pipeline will be triggered automatically
93+
and therefore running the load tests scenarios in the Fargate cluster(s).
9894

9995
```bash
10096
git push -u origin master
@@ -141,9 +137,9 @@ Use the following buttons to launch the solution in the desired additional regio
141137

142138
Additional Region | Region Code | Launch
143139
------|-----|-----
144-
US East (N. Virginia) | us-east-1 | [![Launch in us-east-1](https://camo.githubusercontent.com/210bb3bfeebe0dd2b4db57ef83837273e1a51891/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f636c6f7564666f726d6174696f6e2d6578616d706c65732f636c6f7564666f726d6174696f6e2d6c61756e63682d737461636b2e706e67)](https://console.aws.amazon.com/cloudformation/home?region=us-east-1#/stacks/new?stackName=WildRydes-Cloud9&templateURL=https://s3-us-west-2.amazonaws.com/load-testing-using-aws-fargate/artifacts/templates/additional-region.yaml)
145-
US East (Ohio) | us-east-2 | [![Launch in us-east-2](https://camo.githubusercontent.com/210bb3bfeebe0dd2b4db57ef83837273e1a51891/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f636c6f7564666f726d6174696f6e2d6578616d706c65732f636c6f7564666f726d6174696f6e2d6c61756e63682d737461636b2e706e67)](https://console.aws.amazon.com/cloudformation/home?region=us-east-2#/stacks/new?stackName=WildRydes-Cloud9&templateURL=https://s3-us-west-2.amazonaws.com/load-testing-using-aws-fargate/artifacts/templates/additional-region.yaml)
146-
US West (Oregon) | us-west-2 | [![Launch in us-west-2](https://camo.githubusercontent.com/210bb3bfeebe0dd2b4db57ef83837273e1a51891/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f636c6f7564666f726d6174696f6e2d6578616d706c65732f636c6f7564666f726d6174696f6e2d6c61756e63682d737461636b2e706e67)](https://console.aws.amazon.com/cloudformation/home?region=us-west-2#/stacks/new?stackName=WildRydes-Cloud9&templateURL=https://s3-us-west-2.amazonaws.com/load-testing-using-aws-fargate/artifacts/templates/additional-region.yaml)
140+
US East (N. Virginia) | us-east-1 | [![Launch in us-east-1](https://camo.githubusercontent.com/210bb3bfeebe0dd2b4db57ef83837273e1a51891/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f636c6f7564666f726d6174696f6e2d6578616d706c65732f636c6f7564666f726d6174696f6e2d6c61756e63682d737461636b2e706e67)](https://console.aws.amazon.com/cloudformation/home?region=us-east-1#/stacks/new?stackName=DistributedLoadTesting&templateURL=https://s3.amazonaws.com/distributed-load-testing-using-aws-fargate/templates/additional-region.yaml)
141+
US East (Ohio) | us-east-2 | [![Launch in us-east-2](https://camo.githubusercontent.com/210bb3bfeebe0dd2b4db57ef83837273e1a51891/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f636c6f7564666f726d6174696f6e2d6578616d706c65732f636c6f7564666f726d6174696f6e2d6c61756e63682d737461636b2e706e67)](https://console.aws.amazon.com/cloudformation/home?region=us-east-2#/stacks/new?stackName=DistributedLoadTesting&templateURL=https://s3.amazonaws.com/distributed-load-testing-using-aws-fargate/templates/additional-region.yaml)
142+
US West (Oregon) | us-west-2 | [![Launch in us-west-2](https://camo.githubusercontent.com/210bb3bfeebe0dd2b4db57ef83837273e1a51891/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f636c6f7564666f726d6174696f6e2d6578616d706c65732f636c6f7564666f726d6174696f6e2d6c61756e63682d737461636b2e706e67)](https://console.aws.amazon.com/cloudformation/home?region=us-west-2#/stacks/new?stackName=DistributedLoadTesting&templateURL=https://s3.amazonaws.com/distributed-load-testing-using-aws-fargate/templates/additional-region.yaml)
147143

148144

149145
## Run Locally

0 commit comments

Comments
 (0)