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

In readme, fix Table of contents, add platform support, getting started, and features list. #34

Merged
merged 1 commit into from
Nov 21, 2024
Merged

In readme, fix Table of contents, add platform support, getting started, and features list. #34

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
70 changes: 68 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,52 @@

MultiTool Canary is an agentic deployment tool that quickly detects and rolls back defective deployments. Use the CLI to create and monitor canary deployments, control the amount of traffic they receive, and automatically yank deployments that produce an anomolous number of bad responses. MultiTool Canary improves release confidence by giving you a robust measure of stability, and acting quickly and autonomously when bugs sneak into production.

## Getting Started

This section explains how to deploy an AWS Lambda function to AWS API Gateway using MultiTool Canary. Just point MultiTool Canary to a pre-built Lambda zip, tell it which API Gateway, Stage, and Lambda to deploy to, and it will take care of the rest.

1. First, make sure your AWS credentials are configured:
```bash
$ 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:
RobbieMcKinstry marked this conversation as resolved.
Show resolved Hide resolved
```bash
$ export AWS_ACCESS_KEY_ID="${MY_ACCESS_KEY}"
$ export AWS_SECRET_ACCESS_KEY="${MY_SECRET_ACCESS_KEY}"
$ export AWS_REGION="us-west-2"
RobbieMcKinstry marked this conversation as resolved.
Show resolved Hide resolved
```

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}"
RobbieMcKinstry marked this conversation as resolved.
Show resolved Hide resolved
$ export MUTLI_LAMBDA_NAME="${MY_LAMBDA}"
```

3. Build your Lambda function. This should be a zipfile with your Lambda's source code. For instance, if you're using `cargo-lambda`:
```bash
$ cargo lambda build -o zip --release
$ mv ./target/lambda/my-app/bootstrap.zip ./my-release.zip
```

4. Finally, run MultiTool Canary, pointing to a pre-built zip:
```bash
$ 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.
RobbieMcKinstry marked this conversation as resolved.
Show resolved Hide resolved

## Table of Contents

[TOC]
- [What is MultiTool Canary?](#what-is-multitool-canary-)
- [Getting Started](#getting-started)
- [Table of Contents](#table-of-contents)
- [Installation](#installation)
* [Building from source](#building-from-source)
- [Architecture support](#architecture-support)
- [Mission](#mission)
- [Contributing](#contributing)

## Installation

Expand Down Expand Up @@ -48,7 +91,30 @@ See [Releases](https://github.com/wack/canary/releases) for pre-built binaries,

To build MultiTool Canary from source, refer to instructions in [CONTRIBUTING.md](https://github.com/wack/canary/blob/trunk/README.md).

## Platform support
## Features

* Automatic application deployment
* Automated rollback
* Cautious Mode (coming soon) and Optimistic Mode: Choose between preventing false positives and false negatives.
* Measure release confidence.
RobbieMcKinstry marked this conversation as resolved.
Show resolved Hide resolved
* 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.

| Platform | Support |
| :----------------------------------------------------------: | :----------------------------: |
| **AWS Lambda + API Gateway** | :sparkles: Available! |
| [Vercel](vercel.com) | :eyes: Up next |
| [CloudFlare](https://developers.cloudflare.com/workers/configuration/versions-and-deployments/gradual-deployments/#_top) | :eyes: Up next |
| [AWS Function Aliases](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html) | :watch: Soon |
| [Kubernetes](https://kubernetes.io/) | :hourglass_flowing_sand: Later |
| [Google Cloud Run Functions](https://cloud.google.com/functions) | :hourglass_flowing_sand: Later |

## Architecture support

MultiTool Canary has official builts for 64-bit Windows, macOS (Apple Silicon and x86), and Linux. No official support is provided for 32-bit architectures, but the CLI is expected to work on 32-bit platforms.

Expand Down