Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
alismx committed Oct 15, 2024
1 parent 8282e97 commit 6f74a20
Show file tree
Hide file tree
Showing 8 changed files with 20 additions and 24 deletions.
10 changes: 5 additions & 5 deletions terraform/implementation/ecs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

| Name | Version |
|------|---------|
| <a name="provider_aws"></a> [aws](#provider\_aws) | 5.56.1 |
| <a name="provider_aws"></a> [aws](#provider\_aws) | =5.56.1 |

## Modules

Expand All @@ -28,17 +28,17 @@

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| <a name="input_availability_zones"></a> [availability\_zones](#input\_availability\_zones) | The availability zones to use | `list(string)` | <pre>[<br/> "us-east-1a",<br/> "us-east-1b",<br/> "us-east-1c"<br/>]</pre> | no |
| <a name="input_availability_zones"></a> [availability\_zones](#input\_availability\_zones) | The availability zones to use | `list(string)` | <pre>[<br> "us-east-1a",<br> "us-east-1b",<br> "us-east-1c"<br>]</pre> | no |
| <a name="input_create_internet_gateway"></a> [create\_internet\_gateway](#input\_create\_internet\_gateway) | Flag to determine if an internet gateway should be created | `bool` | `false` | no |
| <a name="input_ecr_viewer_database_schema"></a> [ecr\_viewer\_database\_schema](#input\_ecr\_viewer\_database\_schema) | The database schema used for the eCR data tables | `string` | `"core"` | no |
| <a name="input_ecr_viewer_database_type"></a> [ecr\_viewer\_database\_type](#input\_ecr\_viewer\_database\_type) | The SQL variant used for the eCR data tables | `string` | `"postgres"` | no |
| <a name="input_ecs_alb_sg"></a> [ecs\_alb\_sg](#input\_ecs\_alb\_sg) | The security group for the Application Load Balancer | `string` | `"ecs-albsg"` | no |
| <a name="input_enable_nat_gateway"></a> [enable\_nat\_gateway](#input\_enable\_nat\_gateway) | Enable NAT Gateway | `bool` | `false` | no |
| <a name="input_owner"></a> [owner](#input\_owner) | The owner of the infrastructure | `string` | `"skylight"` | no |
| <a name="input_phdi_version"></a> [phdi\_version](#input\_phdi\_version) | PHDI container image version | `string` | `"v1.4.4"` | no |
| <a name="input_private_subnets"></a> [private\_subnets](#input\_private\_subnets) | The private subnets | `list(string)` | <pre>[<br/> "176.24.1.0/24",<br/> "176.24.3.0/24"<br/>]</pre> | no |
| <a name="input_project"></a> [project](#input\_project) | The project name | `string` | `"dibbs-ce"` | no |
| <a name="input_public_subnets"></a> [public\_subnets](#input\_public\_subnets) | The public subnets | `list(string)` | <pre>[<br/> "176.24.2.0/24",<br/> "176.24.4.0/24"<br/>]</pre> | no |
| <a name="input_private_subnets"></a> [private\_subnets](#input\_private\_subnets) | The private subnets | `list(string)` | <pre>[<br> "176.24.1.0/24",<br> "176.24.3.0/24"<br>]</pre> | no |
| <a name="input_project"></a> [project](#input\_project) | The project name | `string` | `"dibbs"` | no |
| <a name="input_public_subnets"></a> [public\_subnets](#input\_public\_subnets) | The public subnets | `list(string)` | <pre>[<br> "176.24.2.0/24",<br> "176.24.4.0/24"<br>]</pre> | no |
| <a name="input_region"></a> [region](#input\_region) | AWS region | `string` | `"us-east-1"` | no |
| <a name="input_single_nat_gateway"></a> [single\_nat\_gateway](#input\_single\_nat\_gateway) | Single NAT Gateway | `bool` | `false` | no |
| <a name="input_vpc"></a> [vpc](#input\_vpc) | The name of the VPC | `string` | `"ecs-vpc"` | no |
Expand Down
2 changes: 1 addition & 1 deletion terraform/implementation/ecs/_variable.tf
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ variable "private_subnets" {
variable "project" {
description = "The project name"
type = string
default = "dibbs-ce"
default = "dibbs"
}

variable "public_subnets" {
Expand Down
14 changes: 5 additions & 9 deletions terraform/implementation/setup/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
<!-- BEGIN_TF_DOCS -->
## Requirements

No requirements.
| Name | Version |
|------|---------|
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | =5.70.0 |

## Providers

| Name | Version |
|------|---------|
| <a name="provider_aws"></a> [aws](#provider\_aws) | 5.70.0 |
| <a name="provider_local"></a> [local](#provider\_local) | 2.5.2 |
| <a name="provider_random"></a> [random](#provider\_random) | 3.6.3 |

Expand All @@ -16,17 +17,12 @@ No requirements.
| Name | Source | Version |
|------|--------|---------|
| <a name="module_oidc"></a> [oidc](#module\_oidc) | ../../modules/oidc | n/a |
| <a name="module_tfstate"></a> [tfstate](#module\_tfstate) | ../../modules/tfstate | n/a |

## Resources

| Name | Type |
|------|------|
| [aws_dynamodb_table.tfstate_lock](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/dynamodb_table) | resource |
| [aws_s3_bucket.tfstate](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket) | resource |
| [aws_s3_bucket_public_access_block.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_public_access_block) | resource |
| [aws_s3_bucket_server_side_encryption_configuration.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_server_side_encryption_configuration) | resource |
| [aws_s3_bucket_versioning.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_versioning) | resource |
| [local_file.ecs_env](https://registry.terraform.io/providers/hashicorp/local/latest/docs/resources/file) | resource |
| [local_file.setup_env](https://registry.terraform.io/providers/hashicorp/local/latest/docs/resources/file) | resource |
| [random_string.setup](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/string) | resource |

Expand All @@ -36,7 +32,7 @@ No requirements.
|------|-------------|------|---------|:--------:|
| <a name="input_oidc_github_repo"></a> [oidc\_github\_repo](#input\_oidc\_github\_repo) | The GitHub repository for OIDC | `string` | `""` | no |
| <a name="input_owner"></a> [owner](#input\_owner) | The owner of the project | `string` | `"skylight"` | no |
| <a name="input_project"></a> [project](#input\_project) | The name of the project | `string` | `"dibbs-ce"` | no |
| <a name="input_project"></a> [project](#input\_project) | The name of the project | `string` | `"dibbs"` | no |
| <a name="input_region"></a> [region](#input\_region) | The AWS region where resources are created | `string` | `"us-east-1"` | no |

## Outputs
Expand Down
2 changes: 1 addition & 1 deletion terraform/implementation/setup/_variable.tf
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ variable "owner" {
variable "project" {
description = "The name of the project"
type = string
default = "dibbs-ce"
default = "dibbs"
}

variable "region" {
Expand Down
10 changes: 5 additions & 5 deletions terraform/implementation/setup/main.tf
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ resource "random_string" "setup" {
}

module "tfstate" {
source = "../../modules/tfstate"
source = "../../modules/tfstate"
identifier = random_string.setup.result
owner = var.owner
project = var.project
region = var.region
owner = var.owner
project = var.project
region = var.region
}

# GitHub OIDC for prod
Expand All @@ -28,7 +28,7 @@ module "oidc" {
workspace = "prod"

# state_bucket_arn = module.tfstate.aws_s3_bucket.tfstate.arn
state_bucket_arn = module.tfstate.state_bucket.arn
state_bucket_arn = module.tfstate.state_bucket.arn
# dynamodb_table_arn = aws_dynamodb_table.tfstate_lock.arn
dynamodb_table_arn = module.tfstate.dynamodb_table.arn
}
Expand Down
2 changes: 1 addition & 1 deletion terraform/modules/ecs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ No modules.
| <a name="input_region"></a> [region](#input\_region) | The AWS region where resources are created | `string` | n/a | yes |
| <a name="input_s3_viewer_bucket_name"></a> [s3\_viewer\_bucket\_name](#input\_s3\_viewer\_bucket\_name) | Name of the S3 bucket for the viewer | `string` | `""` | no |
| <a name="input_s3_viewer_bucket_role_name"></a> [s3\_viewer\_bucket\_role\_name](#input\_s3\_viewer\_bucket\_role\_name) | Name of the IAM role for the ecr-viewer bucket | `string` | `""` | no |
| <a name="input_service_data"></a> [service\_data](#input\_service\_data) | Data for the DIBBS services | <pre>map(object({<br/> short_name = string<br/> fargate_cpu = number<br/> fargate_memory = number<br/> app_count = number<br/> app_image = string<br/> app_version = string<br/> container_port = number<br/> host_port = number<br/> public = bool<br/> registry_url = string<br/> env_vars = list(object({<br/> name = string<br/> value = string<br/> }))<br/> }))</pre> | `{}` | no |
| <a name="input_service_data"></a> [service\_data](#input\_service\_data) | Data for the DIBBS services | <pre>map(object({<br> short_name = string<br> fargate_cpu = number<br> fargate_memory = number<br> app_count = number<br> app_image = string<br> app_version = string<br> container_port = number<br> host_port = number<br> public = bool<br> registry_url = string<br> env_vars = list(object({<br> name = string<br> value = string<br> }))<br> }))</pre> | `{}` | no |
| <a name="input_tags"></a> [tags](#input\_tags) | Tags to apply to resources | `map(string)` | `{}` | no |
| <a name="input_vpc_id"></a> [vpc\_id](#input\_vpc\_id) | ID of the VPC | `string` | n/a | yes |

Expand Down
2 changes: 1 addition & 1 deletion terraform/modules/oidc/_variable.tf
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ variable "region" {
type = string
description = "The AWS region where resources are created"
default = ""
validation {
validation {
condition = can(regex("^(us|eu|ap|sa|ca|cn|af|me|eu)-[[:alnum:]]{2,10}-[0-9]$", var.region))
error_message = "region must be a valid AWS region"
}
Expand Down
2 changes: 1 addition & 1 deletion terraform/modules/tfstate/_variable.tf
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ variable "region" {
type = string
description = "The AWS region where resources are created"
default = ""
validation {
validation {
condition = can(regex("^(us)-[[:alnum:]]{2,10}-[0-9]$", var.region))
error_message = "region must be a valid AWS region"
}
Expand Down

0 comments on commit 6f74a20

Please sign in to comment.