https://github.com/feedzai/terraform-aws-sorry-cypress

A Terraform module for deploying sorry-cypress on AWS ECS
https://github.com/feedzai/terraform-aws-sorry-cypress

aws cypress sorry-cypress terraform terraform-module

Last synced: 11 months ago
JSON representation

A Terraform module for deploying sorry-cypress on AWS ECS

Host: GitHub
URL: https://github.com/feedzai/terraform-aws-sorry-cypress
Owner: feedzai
License: apache-2.0
Created: 2022-06-23T13:30:36.000Z (about 4 years ago)
Default Branch: main
Last Pushed: 2022-10-24T09:36:18.000Z (over 3 years ago)
Last Synced: 2025-07-15T09:20:38.359Z (12 months ago)
Topics: aws, cypress, sorry-cypress, terraform, terraform-module
Language: HCL
Homepage:
Size: 45.9 KB
Stars: 1
Watchers: 3
Forks: 4
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

          # AWS Sorry Cypress Terraform Module

Terraform module that deploys Sorry Cypress on AWS.

## Usage

```hcl

module "sorry_cypress" {

    source = "terraform-aws-sorry-cypress"

    s3_bucket_name = "sorry_cypress_test_results"

    zone_id = "example.com"

    url = "sorrycypress.example.com"

    load_balancer_security_group = "sg-123456789"

    vpc_id = "vpc-123456"

    task_role_arn = "arn::iam::role"

    execution_role_arn = "arn::iam::role"

    subnets = {

        private = []

        public = []

    }

    alb_logs_bucket = "alb_logs_bucket"

    certificate_arn = "arn::acm::..."

    docker_registry_credentials = "secret-name-in-secrets-manager"

}

```

## Requirements

| Name | Version |

|------|---------|

|  [aws](#requirement\_aws) | ~> 4.12.1 |

## Providers

| Name | Version |

|------|---------|

|  [aws](#provider\_aws) | ~> 4.12.1 |

## Modules

No modules.

## Resources

| Name | Type |

|------|------|

| [aws_cloudwatch_log_group.sorry_cypress_log_group](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_log_group) | resource |

| [aws_ecs_cluster.sorry_cypress](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecs_cluster) | resource |

| [aws_ecs_service.sorry_cypress_ecs_service](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecs_service) | resource |

| [aws_ecs_task_definition.sorry_cypress](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecs_task_definition) | resource |

| [aws_lb.sorry_cypress](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lb) | resource |

| [aws_lb_listener.dashboard_listener](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lb_listener) | resource |

| [aws_lb_listener.director_listener](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lb_listener) | resource |

| [aws_lb_listener.http](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lb_listener) | resource |

| [aws_lb_listener.https](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lb_listener) | resource |

| [aws_lb_listener_rule.api_listener_rule](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lb_listener_rule) | resource |

| [aws_lb_listener_rule.https_api](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lb_listener_rule) | resource |

| [aws_lb_target_group.sorry_cypress_api](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lb_target_group) | resource |

| [aws_lb_target_group.sorry_cypress_dashboard](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lb_target_group) | resource |

| [aws_lb_target_group.sorry_cypress_director](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lb_target_group) | resource |

| [aws_route53_record.sorry_cypress](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/route53_record) | resource |

| [aws_s3_bucket.test_results_bucket](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket) | resource |

| [aws_s3_bucket_acl.test_results_acl](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_acl) | resource |

| [aws_s3_bucket_cors_configuration.test_results_bucket_cors](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_cors_configuration) | resource |

| [aws_s3_bucket_lifecycle_configuration.tests_retention_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_lifecycle_configuration) | resource |

| [aws_s3_bucket_policy.allow_access_from_prefix_list](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_policy) | resource |

| [aws_s3_bucket_public_access_block.sorry_cypress](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_public_access_block) | resource |

| [aws_security_group.sorry_cypress_alb](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group) | resource |

| [aws_security_group.sorry_cypress_fargate](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group) | resource |

| [aws_security_group_rule.allow_http_director](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group_rule) | resource |

| [aws_security_group_rule.allow_http_from_alb](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group_rule) | resource |

| [aws_security_group_rule.allow_https_alb](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group_rule) | resource |

| [aws_security_group_rule.allow_https_api](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group_rule) | resource |

| [aws_security_group_rule.allow_https_dashboard](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group_rule) | resource |

| [aws_security_group_rule.allow_https_director](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group_rule) | resource |

| [aws_security_group_rule.allow_inbound_containers](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group_rule) | resource |

| [aws_security_group_rule.allow_outbound](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group_rule) | resource |

| [aws_security_group_rule.allow_outbound_fargate](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group_rule) | resource |

| [aws_ec2_managed_prefix_list.prefix_list](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/ec2_managed_prefix_list) | data source |

| [aws_iam_policy_document.allow_access_from_prefix_list](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |

## Inputs

| Name | Description | Type | Default | Required |

|------|-------------|------|---------|:--------:|

|  [alb\_logs\_bucket](#input\_alb\_logs\_bucket) | An S3 bucket to store ALB access logs | `string` | n/a | yes |

|  [certificate\_arn](#input\_certificate\_arn) | n/a | `string` | n/a | yes |

|  [cpu\_request](#input\_cpu\_request) | Number of cpu units used by the task | `string` | `"1024"` | no |

|  [docker\_registry](#input\_docker\_registry) | The docker registry to pull sorry cypress images from | `string` | n/a | yes |

|  [docker\_registry\_credentials](#input\_docker\_registry\_credentials) | The ARN of the docker registry credentials secret in SecretsManager | `string` | n/a | yes |

|  [execution\_role\_arn](#input\_execution\_role\_arn) | ARN of the task execution role that the Amazon ECS container agent and the Docker daemon can assume | `string` | n/a | yes |

|  [load\_balancer\_security\_group](#input\_load\_balancer\_security\_group) | The load balancer security group | 
object({
    id = string
  }) | n/a | yes |

|  [memory\_request](#input\_memory\_request) | Amount (in MiB) of memory used by the task | `string` | `"2048"` | no |

|  [prefix\_list](#input\_prefix\_list) | An EC2 managed prefix list | `string` | n/a | yes |

|  [s3\_bucket\_name](#input\_s3\_bucket\_name) | S3 bucket name to store test results | `string` | n/a | yes |

|  [subnets](#input\_subnets) | AWS subnet IDs to deploy Sorry Cypress | object({
    private = list(string),
    public  = list(string)
  }) | n/a | yes |

|  [task\_role\_arn](#input\_task\_role\_arn) | ARN of IAM role that allows your Amazon ECS container task to make calls to other AWS services | `string` | n/a | yes |

|  [test\_results\_retention](#input\_test\_results\_retention) | The number of days to keep test results | `number` | `15` | no |

|  [url](#input\_url) | The URL to deploy SorryCypress to | `string` | n/a | yes |

|  [vpc\_id](#input\_vpc\_id) | The VPC ID | `string` | n/a | yes |

|  [zone\_id](#input\_zone\_id) | The route53 zone id | `string` | n/a | yes |

## Outputs

| Name | Description |

|------|-------------|

|  [api\_url](#output\_api\_url) | The Sorry Cypress API endpoint |

|  [dashboard\_url](#output\_dashboard\_url) | The Sorry Cypress dashboard URL |

|  [director\_url](#output\_director\_url) | The Sorry Cypress director URL |

|  [test\_results\_bucket](#output\_test\_results\_bucket) | The S3 bucket where test results are stored |

## References

This modules was based on the [CloudFormation template](https://github.com/sorry-cypress/sorry-cypress/blob/master/cloudformation/sorry-cypress.yml) provided by SorryCypress

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/feedzai/terraform-aws-sorry-cypress

Awesome Lists containing this project

README