Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
marjet26 committed Jun 10, 2023
1 parent 1c85e0a commit a2047a8
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,11 @@
The objective of this code is to remove as many difficulties as possible when trying to deploy canaries with terraform.

## Overview
See this AWS prescriptive document for more details: [Deploy CloudWatch Synthetics canaries by using Terraform](https://docs.aws.amazon.com/prescriptive-guidance/latest/patterns/deploy-cloudwatch-synthetics-canaries-by-using-terraform.html).
This repo is composed of two modules: one to setup the [common infrastructure](./modules/canary-infra/README.md) required for all canaries and [one to setup a canary](./modules/canary/README.md) testing a specific API.
The canary module has been designed to deploy a canary testing an API only privately available.
The canary must run in the VPC where the API is deployed and have a security group allowing to call the API.
An example terraform script using the two modules has been provided in: [main.tf](main.tf).
An example terraform script using the two modules has been provided in: [main.tf](main.tf).

## Security

Expand Down

0 comments on commit a2047a8

Please sign in to comment.