Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/frgrisk/terraform-aws-turbo-deploy
https://github.com/frgrisk/terraform-aws-turbo-deploy
aws devops terraform-module
Last synced: 3 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/frgrisk/terraform-aws-turbo-deploy
- Owner: frgrisk
- License: mit
- Created: 2024-06-18T02:03:41.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-10-31T05:16:41.000Z (3 months ago)
- Last Synced: 2024-11-28T16:52:09.560Z (2 months ago)
- Topics: aws, devops, terraform-module
- Language: HCL
- Homepage: https://registry.terraform.io/modules/frgrisk/turbo-deploy/aws/latest
- Size: 56.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# terraform-aws-turbo-deploy
## Description
This is an AWS Terraform module to deploy the Turbo infrastructure, this consists of aws resources such as:
- DynamoDB
- Lambda
- API Gateway
- Elastic Container Repository
- S3
The above is required for the Turbo Application to work properly and is what powers the deployment of ec2 instances.
## Table of Contents
- [Prerequisites](#prerequisites)
- [Variables](#variables)
- [Example](#example)
## Prerequisites
Before deploying the Turbo Infrastructure, there are a set of AWS resources that needs to be deployed manually by the user for this to work.
- ECR Private Registry and associated image
The lambda function that is responsible for the deployment works by retrieving an image from the ecr registry that contains the terraform code to run the instance deployment.
After you have created the ecr registry, the docker image will need to be manually created and pushed to the registry. To do so you may need to install docker and may then use the provided script from this [turbo repository](https://github.com/frgrisk/turbo-deploy) with the following steps:
1. Clone the turbo-deploy repository
`git clone [email protected]:frgrisk/turbo-deploy.git`
2. Change to the ecr-scripts directory
`cd ecr-scripts`
3. Change the following values of the deploy_lambda.sh script to your environment
- ECR_REPOSITORY_NAME=\
- AWS_REGION=\
4. Configure the aws account keys in your terminal
`aws configure`
5. Run the script to create and push the image
`./deploy_lambda.sh`
- Route53 Zone and registered domain
The instances that are deployed through Turbo Deploy are meant to be accessible through the hostname that has been configured by the user, for this to work automatic registration of the hostname in an A record needs to be done.
While it is fine to create the Route53 Zone without registering the domain, it will mean that you cannot access the deployed instance through the hostname and must use other methods.
## Variables
While there are a few variables that can be configured through the module, the below is mandatory for Turbo Deploy to work.
- ecr_repository_name
The name of the ecr registry that you created and contains the image for the lambda function
- s3_tf_bucket_name
The name that you will give to the S3 bucket (must be unique)
- zone_id
The zone id of Route53 Zone
- turbo_deploy_hostname
The hostname of the instance that will host the Turbo Deploy Web Application
- ec2_attributes
By default, server sizes are automatically set but not AMIs and so you need to configure them
- image_filter_groups
The AMIs that are listed in the Turbo Deploy interface is configured through the use of filters that are used by the AWS API, you can look through the full list of filters in this [AWS documentation](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImages.html)
## Example
Here is an example of a terraform deployment of the turbo deploy infrastructure through the module:
```hcl
module "my_turbo_module" {
providers = {
aws = aws
}
source = "../terraform-aws-turbo-deploy"
ecr_repository_name = "turbo-image"
s3_tf_bucket_name = "turbo-deploy-s3"
zone_id = "Z23ABC4XYZL05B"
turbo_deploy_hostname = "turbodeploy-dev"
ec2_attributes = {
ServerSizes = ["t3.medium", "t3.large", "t3.xlarge"]
Amis = ["ami-0583d8c7a9c35822c", "ami-06338d230ffc3fc0c"]
}
image_filter_groups = {
"alma-ami" = [
{
name = "is-public"
values = ["true"]
},
{
name = "name"
values = ["AlmaLinux OS*"]
},
{
name = "state"
values = ["available"]
}
]
"redhat-ami" = [
{
name = "is-public"
values = ["true"]
},
{
name = "name"
values = ["RHEL-9.4.0*"]
},
{
name = "state"
values = ["available"]
}
]
}
}
```