Skip to content

Commit

Permalink
Address readme feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
RobbieMcKinstry committed Nov 21, 2024
1 parent 7afcbef commit 8b46ca5
Showing 1 changed file with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,17 @@ This section explains how to deploy an AWS Lambda function to AWS API Gateway us
$ aws sts get-caller-identity
```

If you're credentials aren't set, either login with `aws sso login --profile my-profile` or set your Access Key Id and Secret Access Key:
If your credentials aren't set, either login with `aws sso login --profile my-profile` or set your Access Key Id and Secret Access Key:
```bash
$ export AWS_ACCESS_KEY_ID="${MY_ACCESS_KEY}"
$ export AWS_SECRET_ACCESS_KEY="${MY_SECRET_ACCESS_KEY}"
$ export AWS_REGION="us-west-2"
$ export AWS_REGION="us-east-2"
```

2. Next, tell MultiTool Canary which API Gateway, Stage, and Lambda it should deploy it.
```bash
$ export MULTI_GATEWAY_NAME="${MY_API_GATEWAY_NAME}"
$ export MULTI_GATEWAY_STAGE="${PROD}"
$ export MULTI_GATEWAY_STAGE="${MY_STAGE}"
$ export MUTLI_LAMBDA_NAME="${MY_LAMBDA}"
```

Expand All @@ -44,7 +44,7 @@ This section explains how to deploy an AWS Lambda function to AWS API Gateway us
$ canary deploy ./my-release.zip
```

MultiTool Canary will upload function to AWS, cut a canary release, and monitor it, progresssingly ramping up traffic as it gains confidence in the deployment. MultiTool Canary scans your CloudWatch metrics to see how your canary application is performing relative to the baseline, and models release confidence based on how they differ.
MultiTool Canary will upload the function to AWS, cut a canary release, and monitor it, progresssingly ramping up traffic as it gains confidence in the deployment. MultiTool Canary scans your CloudWatch metrics to see how your canary application is performing relative to the baseline, and models release confidence based on how they differ.

## Table of Contents

Expand Down Expand Up @@ -95,12 +95,10 @@ To build MultiTool Canary from source, refer to instructions in [CONTRIBUTING.md

* Automatic application deployment
* Automated rollback
* Cautious Mode (coming soon) and Optimistic Mode: Choose between preventing false positives and false negatives.
* Measure release confidence.
* Cautious Mode (coming soon) and Optimistic Mode: Choose between preventing false positives and false negatives
* Measure release confidence
* Backward and forward traffic ramping



## Platform Support

Currently, MultiTool Canary only supports deploying canaries for AWS Lambda functions running in AWS API Gateway. However, we are currently working on adding support for additional platforms. Our platform roadmap is presented in the table below.
Expand Down

0 comments on commit 8b46ca5

Please sign in to comment.