diff --git a/.github/workflows/terraform-plan.yaml b/.github/workflows/terraform-plan.yaml index b12990a..216c2b9 100644 --- a/.github/workflows/terraform-plan.yaml +++ b/.github/workflows/terraform-plan.yaml @@ -42,3 +42,25 @@ jobs: with: path: terraform backend_config_file: terraform/prod.backend.tfvars + + terraform-docs: + name: Generate Terraform Docs + runs-on: ubuntu-latest + + permissions: + contents: write + pull-requests: write + + steps: + - uses: actions/checkout@v3 + with: + ref: ${{ github.event.pull_request.head.ref }} + + - name: Render terraform docs inside the README.md and push changes back to PR branch + uses: terraform-docs/gh-actions@v1.4.1 + with: + find-dir: "terraform" + output-file: README.md + output-method: inject + git-push: "true" + git-commit-message: "terraform-docs: automated updates to Terraform modules README.md" \ No newline at end of file diff --git a/terraform/README.md b/terraform/README.md new file mode 100644 index 0000000..c36cc2b --- /dev/null +++ b/terraform/README.md @@ -0,0 +1,43 @@ + +## Requirements + +| Name | Version | +|------|---------| +| [terraform](#requirement\_terraform) | ~> 1.12 | +| [postgresql](#requirement\_postgresql) | 1.25.0 | + +## Providers + +| Name | Version | +|------|---------| +| [aws](#provider\_aws) | n/a | + +## Modules + +| Name | Source | Version | +|------|--------|---------| +| [civic-tech-index](#module\_civic-tech-index) | ./projects/civic-tech-index | n/a | +| [civic-tech-jobs](#module\_civic-tech-jobs) | ./projects/civic-tech-jobs | n/a | +| [home-unite-us](#module\_home-unite-us) | ./projects/home-unite-us | n/a | +| [people-depot](#module\_people-depot) | ./projects/people-depot | n/a | +| [vrms](#module\_vrms) | ./projects/vrms | n/a | + +## Resources + +| Name | Type | +|------|------| +| [aws_db_instance.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/db_instance) | resource | +| [aws_iam_policy.incubator_builder](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource | +| [aws_caller_identity.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) | data source | + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:--------:| +| [pghost](#input\_pghost) | n/a | `string` | n/a | yes | +| [pgpassword](#input\_pgpassword) | n/a | `string` | n/a | yes | + +## Outputs + +No outputs. + \ No newline at end of file diff --git a/terraform/modules/cicd_integration/README.md b/terraform/modules/cicd_integration/README.md new file mode 100644 index 0000000..bb8394d --- /dev/null +++ b/terraform/modules/cicd_integration/README.md @@ -0,0 +1,36 @@ + +## Requirements + +No requirements. + +## Providers + +| Name | Version | +|------|---------| +| [aws](#provider\_aws) | n/a | + +## Modules + +No modules. + +## Resources + +| Name | Type | +|------|------| +| [aws_iam_role.builder](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource | +| [aws_iam_role_policy_attachment.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource | +| [aws_caller_identity.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) | data source | + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:--------:| +| [project\_name](#input\_project\_name) | n/a | `string` | n/a | yes | +| [repository\_name](#input\_repository\_name) | n/a | `string` | n/a | yes | + +## Outputs + +| Name | Description | +|------|-------------| +| [role\_name](#output\_role\_name) | n/a | + \ No newline at end of file diff --git a/terraform/modules/container/README.md b/terraform/modules/container/README.md new file mode 100644 index 0000000..f5ab0df --- /dev/null +++ b/terraform/modules/container/README.md @@ -0,0 +1,57 @@ + +## Requirements + +No requirements. + +## Providers + +| Name | Version | +|------|---------| +| [aws](#provider\_aws) | n/a | + +## Modules + +No modules. + +## Resources + +| Name | Type | +|------|------| +| [aws_cloudwatch_log_group.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_log_group) | resource | +| [aws_ecs_service.fargate](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecs_service) | resource | +| [aws_ecs_task_definition.task](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecs_task_definition) | resource | +| [aws_iam_policy.container_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource | +| [aws_iam_role.instance](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource | +| [aws_iam_role_policy_attachment.task_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource | +| [aws_lb_listener_rule.static](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lb_listener_rule) | resource | +| [aws_lb_target_group.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lb_target_group) | resource | +| [aws_security_group.container](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group) | resource | +| [aws_vpc_security_group_egress_rule.allow_all_traffic](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/vpc_security_group_egress_rule) | resource | +| [aws_vpc_security_group_ingress_rule.container_ingress_port](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/vpc_security_group_ingress_rule) | resource | + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:--------:| +| [additional\_host\_urls](#input\_additional\_host\_urls) | n/a | `list(string)` | `[]` | no | +| [application\_type](#input\_application\_type) | defines what type of application is running, fullstack, client, backend, etc. will be used for cloudwatch logs | `string` | n/a | yes | +| [container\_cpu](#input\_container\_cpu) | n/a | `number` | `512` | no | +| [container\_environment](#input\_container\_environment) | n/a | 
list(object({
    name = string
    value = string
  }))
| n/a | yes | +| [container\_environment\_secrets](#input\_container\_environment\_secrets) | n/a | 
list(object({
    name = string
    valueFrom = string
  }))
| `[]` | no | +| [container\_image](#input\_container\_image) | n/a | `string` | n/a | yes | +| [container\_memory](#input\_container\_memory) | n/a | `number` | `1024` | no | +| [container\_port](#input\_container\_port) | n/a | `number` | n/a | yes | +| [environment](#input\_environment) | n/a | `string` | n/a | yes | +| [health\_check\_path](#input\_health\_check\_path) | n/a | `string` | `"/"` | no | +| [hostname](#input\_hostname) | n/a | `string` | n/a | yes | +| [listener\_priority](#input\_listener\_priority) | n/a | `number` | n/a | yes | +| [path](#input\_path) | n/a | `string` | `null` | no | +| [project\_name](#input\_project\_name) | The overall name of the project using this infrastructure; used to group related resources by | `any` | n/a | yes | + +## Outputs + +| Name | Description | +|------|-------------| +| [task\_role\_arn](#output\_task\_role\_arn) | n/a | +| [task\_role\_name](#output\_task\_role\_name) | n/a | + \ No newline at end of file diff --git a/terraform/modules/database/README.md b/terraform/modules/database/README.md index 9c3d561..c60eeda 100644 --- a/terraform/modules/database/README.md +++ b/terraform/modules/database/README.md @@ -1,61 +1,62 @@ -# Database +## Requirements -Add description. +| Name | Version | +|------|---------| +| [postgresql](#requirement\_postgresql) | 1.25.0 | +## Providers +| Name | Version | +|------|---------| +| [aws](#provider\_aws) | n/a | +| [postgresql](#provider\_postgresql) | 1.25.0 | + +## Modules + +| Name | Source | Version | +|------|--------|---------| +| [db\_owner\_password](#module\_db\_owner\_password) | ../secret | n/a | +| [db\_owner\_username](#module\_db\_owner\_username) | ../secret | n/a | +| [db\_user\_password](#module\_db\_user\_password) | ../secret | n/a | +| [db\_user\_username](#module\_db\_user\_username) | ../secret | n/a | +| [db\_viewer\_password](#module\_db\_viewer\_password) | ../secret | n/a | +| [db\_viewer\_username](#module\_db\_viewer\_username) | ../secret | n/a | ## Resources | Name | Type | |------|------| -| [aws_ssm_parameter.rds_dbowner_password](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ssm_parameter) | resource | -| [aws_ssm_parameter.rds_dbuser_password](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ssm_parameter) | resource | -| [aws_ssm_parameter.rds_dbviewer_password](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ssm_parameter) | resource | -| [postgresql_database.db](https://registry.terraform.io/providers/cyrilgdn/postgresql/latest/docs/resources/database) | resource | -| [postgresql_grant.user](https://registry.terraform.io/providers/cyrilgdn/postgresql/latest/docs/resources/grant) | resource | -| [postgresql_grant.viewer](https://registry.terraform.io/providers/cyrilgdn/postgresql/latest/docs/resources/grant) | resource | -| [postgresql_role.db_owner](https://registry.terraform.io/providers/cyrilgdn/postgresql/latest/docs/resources/role) | resource | -| [postgresql_role.db_user](https://registry.terraform.io/providers/cyrilgdn/postgresql/latest/docs/resources/role) | resource | -| [postgresql_role.db_viewer](https://registry.terraform.io/providers/cyrilgdn/postgresql/latest/docs/resources/role) | resource | +| [postgresql_database.db](https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/database) | resource | +| [postgresql_grant.user](https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/grant) | resource | +| [postgresql_grant.viewer](https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/grant) | resource | +| [postgresql_role.db_owner](https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role) | resource | +| [postgresql_role.db_user](https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role) | resource | +| [postgresql_role.db_viewer](https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role) | resource | | [aws_db_instance.shared](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/db_instance) | data source | -| [aws_secretsmanager_random_password.db_password_init](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/secretsmanager_random_password) | data source | + ## Inputs | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| -| [db\_name](#input\_db\_name) | n/a | `string` | n/a | yes | +| [application\_type](#input\_application\_type) | n/a | `string` | n/a | yes | | [environment](#input\_environment) | n/a | `string` | n/a | yes | -| [owner\_name](#input\_owner\_name) | n/a | `string` | n/a | yes | -| [shared\_configuration](#input\_shared\_configuration) | Configuration object from shared resources | 
object({
    alb_arn                 = string
    alb_https_listener_arn  = string
    cluster_id              = string
    cluster_name            = string
    task_execution_role_arn = string
    db_identifier           = string
    vpc_id                  = string
    public_subnet_ids       = set(string)
  })
| n/a | yes | -| [user\_name](#input\_user\_name) | n/a | `string` | `""` | no | -| [viewer\_name](#input\_viewer\_name) | n/a | `string` | `""` | no | +| [project\_name](#input\_project\_name) | n/a | `string` | n/a | yes | + ## Outputs | Name | Description | |------|-------------| | [database](#output\_database) | n/a | | [host](#output\_host) | n/a | -| [owner](#output\_owner) | n/a | +| [owner\_password](#output\_owner\_password) | n/a | | [owner\_password\_arn](#output\_owner\_password\_arn) | n/a | +| [owner\_username](#output\_owner\_username) | n/a | | [port](#output\_port) | n/a | -| [user](#output\_user) | n/a | +| [user\_password](#output\_user\_password) | n/a | | [user\_password\_arn](#output\_user\_password\_arn) | n/a | -| [viewer](#output\_viewer) | n/a | +| [user\_username](#output\_user\_username) | n/a | +| [viewer\_password](#output\_viewer\_password) | n/a | | [viewer\_password\_arn](#output\_viewer\_password\_arn) | n/a | -## Providers - -| Name | Version | -|------|---------| -| [aws](#provider\_aws) | n/a | -| [postgresql](#provider\_postgresql) | ~> 1.21.0 | -## Requirements - -| Name | Version | -|------|---------| -| [postgresql](#requirement\_postgresql) | ~> 1.21.0 | - -To automatically update this documentation, install terraform-docs on your local machine run the following: - cd - terraform-docs -c .terraform.docs.yml . +| [viewer\_username](#output\_viewer\_username) | n/a | \ No newline at end of file diff --git a/terraform/modules/dns-entry/README.md b/terraform/modules/dns-entry/README.md new file mode 100644 index 0000000..3e13f65 --- /dev/null +++ b/terraform/modules/dns-entry/README.md @@ -0,0 +1,36 @@ + +## Requirements + +No requirements. + +## Providers + +| Name | Version | +|------|---------| +| [aws](#provider\_aws) | n/a | + +## Modules + +No modules. + +## Resources + +| Name | Type | +|------|------| +| [aws_route53_record.www](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/route53_record) | resource | +| [aws_lb.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/lb) | data source | +| [aws_route53_zone.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/route53_zone) | data source | + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:--------:| +| [subdomain](#input\_subdomain) | n/a | `string` | n/a | yes | +| [zone\_id](#input\_zone\_id) | n/a | `string` | n/a | yes | + +## Outputs + +| Name | Description | +|------|-------------| +| [full\_dns\_name](#output\_full\_dns\_name) | n/a | + \ No newline at end of file diff --git a/terraform/modules/ecr/README.md b/terraform/modules/ecr/README.md index 83442ad..8439afb 100644 --- a/terraform/modules/ecr/README.md +++ b/terraform/modules/ecr/README.md @@ -1,30 +1,34 @@ -# ECR +## Requirements -Add description. +No requirements. +## Providers +| Name | Version | +|------|---------| +| [aws](#provider\_aws) | n/a | + +## Modules + +No modules. ## Resources | Name | Type | |------|------| | [aws_ecr_repository.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecr_repository) | resource | + ## Inputs | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| -| [environment](#input\_environment) | n/a | `string` | n/a | yes | | [project\_name](#input\_project\_name) | The overall name of the project using this infrastructure; used to group related resources by | `string` | n/a | yes | -## Providers - -| Name | Version | -|------|---------| -| [aws](#provider\_aws) | n/a | - +## Outputs -To automatically update this documentation, install terraform-docs on your local machine run the following: - cd - terraform-docs -c .terraform.docs.yml . +| Name | Description | +|------|-------------| +| [arn](#output\_arn) | n/a | +| [repository\_url](#output\_repository\_url) | n/a | \ No newline at end of file diff --git a/terraform/modules/legacy/README.md b/terraform/modules/legacy/README.md new file mode 100644 index 0000000..ef2fa69 --- /dev/null +++ b/terraform/modules/legacy/README.md @@ -0,0 +1,25 @@ + +## Requirements + +No requirements. + +## Providers + +No providers. + +## Modules + +No modules. + +## Resources + +No resources. + +## Inputs + +No inputs. + +## Outputs + +No outputs. + \ No newline at end of file diff --git a/terraform/modules/legacy/acm/README.md b/terraform/modules/legacy/acm/README.md index fbb7d6a..abe7699 100644 --- a/terraform/modules/legacy/acm/README.md +++ b/terraform/modules/legacy/acm/README.md @@ -1,34 +1,34 @@ -# ACM +## Requirements -Add description here +No requirements. +## Providers + +| Name | Version | +|------|---------| +| [aws](#provider\_aws) | n/a | + +## Modules +No modules. ## Resources | Name | Type | |------|------| | [aws_acm_certificate.issued](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/acm_certificate) | data source | + ## Inputs | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| | [domain\_names](#input\_domain\_names) | The domains where the applications will be deployed | `list(string)` | n/a | yes | -| [tags](#input\_tags) | n/a | `map(any)` | 
{
  "terraform_managed": "true"
}
| no | +| [tags](#input\_tags) | n/a | `map(any)` | 
{
  "terraform_managed": "true"
}
| no | + ## Outputs | Name | Description | |------|-------------| | [acm\_certificate\_arns](#output\_acm\_certificate\_arns) | n/a | -## Providers - -| Name | Version | -|------|---------| -| [aws](#provider\_aws) | n/a | - - -To automatically update this documentation, install terraform-docs on your local machine run the following: - cd - terraform-docs -c .terraform.docs.yml . \ No newline at end of file diff --git a/terraform/modules/legacy/applicationlb/README.md b/terraform/modules/legacy/applicationlb/README.md index 933ca0b..c88f936 100644 --- a/terraform/modules/legacy/applicationlb/README.md +++ b/terraform/modules/legacy/applicationlb/README.md @@ -1,9 +1,17 @@ -# Applicationlb +## Requirements -Add description here. +No requirements. +## Providers + +| Name | Version | +|------|---------| +| [aws](#provider\_aws) | n/a | + +## Modules +No modules. ## Resources @@ -14,6 +22,7 @@ Add description here. | [aws_lb_listener.ssl](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lb_listener) | resource | | [aws_lb_listener_certificate.example](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lb_listener_certificate) | resource | | [aws_security_group.alb](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group) | resource | + ## Inputs | Name | Description | Type | Default | Required | @@ -24,8 +33,9 @@ Add description here. | [public\_subnet\_ids](#input\_public\_subnet\_ids) | Public Subnets for which the ALB will be associated with | `list(string)` | n/a | yes | | [region](#input\_region) | n/a | `string` | n/a | yes | | [resource\_name](#input\_resource\_name) | The overall name of the shared resources | `string` | n/a | yes | -| [tags](#input\_tags) | n/a | `map(any)` | 
{
  "terraform_managed": "true"
}
| no | +| [tags](#input\_tags) | n/a | `map(any)` | 
{
  "terraform_managed": "true"
}
| no | | [vpc\_id](#input\_vpc\_id) | VPC ID | `string` | n/a | yes | + ## Outputs | Name | Description | @@ -38,14 +48,4 @@ Add description here. | [lb\_dns\_name](#output\_lb\_dns\_name) | n/a | | [lb\_zone\_id](#output\_lb\_zone\_id) | n/a | | [security\_group\_id](#output\_security\_group\_id) | n/a | -## Providers - -| Name | Version | -|------|---------| -| [aws](#provider\_aws) | n/a | - - -To automatically update this documentation, install terraform-docs on your local machine run the following: - cd - terraform-docs -c .terraform.docs.yml . \ No newline at end of file diff --git a/terraform/modules/legacy/bastion/README.md b/terraform/modules/legacy/bastion/README.md index 46dfa30..90e7f92 100644 --- a/terraform/modules/legacy/bastion/README.md +++ b/terraform/modules/legacy/bastion/README.md @@ -1,9 +1,17 @@ -# Bastion +## Requirements -Add description here. +No requirements. +## Providers + +| Name | Version | +|------|---------| +| [aws](#provider\_aws) | n/a | + +## Modules +No modules. ## Resources @@ -19,12 +27,13 @@ Add description here. | [aws_security_group_rule.bastion_all_egress](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group_rule) | resource | | [aws_security_group_rule.ssh_ingress](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group_rule) | resource | | [aws_ami.ami](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/ami) | data source | + ## Inputs | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| | [additional\_user\_data\_script](#input\_additional\_user\_data\_script) | n/a | `string` | `""` | no | -| [bastion\_github\_file](#input\_bastion\_github\_file) | n/a | `map(string)` | 
{
  "github_branch": "main",
  "github_filepath": "bastion_github_users",
  "github_repo_name": "Infrastructure",
  "github_repo_owner": "codeforsanjose"
}
| no | +| [bastion\_github\_file](#input\_bastion\_github\_file) | n/a | `map(string)` | 
{
  "github_branch": "main",
  "github_filepath": "bastion_github_users",
  "github_repo_name": "Infrastructure",
  "github_repo_owner": "codeforsanjose"
}
| no | | [bastion\_hostname](#input\_bastion\_hostname) | The hostname bastion, must be a subdomain of the domain\_name | `string` | n/a | yes | | [bastion\_instance\_type](#input\_bastion\_instance\_type) | The ec2 instance type of the bastion server | `string` | `"t2.micro"` | no | | [cron\_key\_update\_schedule](#input\_cron\_key\_update\_schedule) | The cron schedule that public keys are synced from the bastion s3 bucket to the server; default to once every hour | `string` | `"5,0,*,* * * * *"` | no | @@ -34,22 +43,13 @@ Add description here. | [public\_subnet\_ids](#input\_public\_subnet\_ids) | public subnet ids for where to place bastion | `list(string)` | n/a | yes | | [resource\_name](#input\_resource\_name) | The overall name of the shared resources | `string` | n/a | yes | | [ssh\_user](#input\_ssh\_user) | -------------------------- user\_data.sh Variables -------------------------- | `string` | `"ubuntu"` | no | -| [tags](#input\_tags) | n/a | `map(any)` | 
{
  "terraform_managed": "true"
}
| no | +| [tags](#input\_tags) | n/a | `map(any)` | 
{
  "terraform_managed": "true"
}
| no | | [vpc\_id](#input\_vpc\_id) | VPC ID | `any` | n/a | yes | + ## Outputs | Name | Description | |------|-------------| | [bastion\_hostname](#output\_bastion\_hostname) | The URL to access the bastion server | | [security\_group\_id](#output\_security\_group\_id) | the security group id of the bastion server. Add this id to other services that run within the vpc to which you want to access externally. | -## Providers - -| Name | Version | -|------|---------| -| [aws](#provider\_aws) | n/a | - - -To automatically update this documentation, install terraform-docs on your local machine run the following: - cd - terraform-docs -c .terraform.docs.yml . \ No newline at end of file diff --git a/terraform/modules/legacy/cognito/README.md b/terraform/modules/legacy/cognito/README.md new file mode 100644 index 0000000..a57427a --- /dev/null +++ b/terraform/modules/legacy/cognito/README.md @@ -0,0 +1,37 @@ + +## Requirements + +No requirements. + +## Providers + +| Name | Version | +|------|---------| +| [aws](#provider\_aws) | n/a | + +## Modules + +No modules. + +## Resources + +| Name | Type | +|------|------| +| [aws_cognito_user_pool.main](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cognito_user_pool) | resource | +| [aws_cognito_user_pool_client.main](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cognito_user_pool_client) | resource | + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:--------:| +| [client\_name](#input\_client\_name) | Name of the Cognito User Pool Client | `string` | `""` | no | +| [region](#input\_region) | AWS region | `string` | `"us-west-2"` | no | +| [user\_pool\_name](#input\_user\_pool\_name) | Name of the Cognito User Pool | `string` | `""` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| [user\_pool\_client\_id](#output\_user\_pool\_client\_id) | The ID of the Cognito User Pool Client | +| [user\_pool\_id](#output\_user\_pool\_id) | The ID of the Cognito User Pool | + \ No newline at end of file diff --git a/terraform/modules/legacy/ecs-task/README.md b/terraform/modules/legacy/ecs-task/README.md index b588049..00df8f8 100644 --- a/terraform/modules/legacy/ecs-task/README.md +++ b/terraform/modules/legacy/ecs-task/README.md @@ -1,14 +1,20 @@ -# ECS-Task +## Requirements -Add description. +No requirements. +## Providers + +| Name | Version | +|------|---------| +| [aws](#provider\_aws) | n/a | ## Modules | Name | Source | Version | |------|--------|---------| | [application\_container\_def](#module\_application\_container\_def) | cloudposse/ecs-container-definition/aws | 0.56.0 | + ## Resources | Name | Type | @@ -22,6 +28,7 @@ Add description. | [aws_lb_listener_rule.static](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lb_listener_rule) | resource | | [aws_lb_target_group.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lb_target_group) | resource | | [aws_service_discovery_service.internal](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/service_discovery_service) | resource | + ## Inputs | Name | Description | Type | Default | Required | @@ -44,17 +51,10 @@ Add description. | [project\_name](#input\_project\_name) | The overall name of the project using this infrastructure; used to group related resources by | `any` | n/a | yes | | [region](#input\_region) | n/a | `string` | n/a | yes | | [service\_discovery\_dns\_namespace\_id](#input\_service\_discovery\_dns\_namespace\_id) | n/a | `string` | n/a | yes | -| [shared\_configuration](#input\_shared\_configuration) | Configuration object from shared resources | 
object({
    alb_https_listener_arn = string
    cluster_id             = string
    cluster_name           = string
    vpc_id                 = string
    public_subnet_ids      = set(string)
  })
| n/a | yes | +| [shared\_configuration](#input\_shared\_configuration) | Configuration object from shared resources | 
object({
    alb_https_listener_arn = string
    cluster_id             = string
    cluster_name           = string
    vpc_id                 = string
    public_subnet_ids      = set(string)
  })
| n/a | yes | | [task\_role\_arn](#input\_task\_role\_arn) | n/a | `string` | n/a | yes | -## Providers - -| Name | Version | -|------|---------| -| [aws](#provider\_aws) | n/a | - +## Outputs -To automatically update this documentation, install terraform-docs on your local machine run the following: - cd - terraform-docs -c .terraform.docs.yml . +No outputs. \ No newline at end of file diff --git a/terraform/modules/legacy/ecs/README.md b/terraform/modules/legacy/ecs/README.md index 2a82408..98bb820 100644 --- a/terraform/modules/legacy/ecs/README.md +++ b/terraform/modules/legacy/ecs/README.md @@ -1,14 +1,20 @@ -# ECS +## Requirements -Add description. +No requirements. +## Providers + +| Name | Version | +|------|---------| +| [aws](#provider\_aws) | n/a | ## Modules | Name | Source | Version | |------|--------|---------| | [asg](#module\_asg) | terraform-aws-modules/autoscaling/aws | ~> 5.0 | + ## Resources | Name | Type | @@ -25,6 +31,7 @@ Add description. | [aws_security_group.ecs_instance](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group) | resource | | [aws_caller_identity.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) | data source | | [aws_ssm_parameter.ec2-ecs-ami](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/ssm_parameter) | data source | + ## Inputs | Name | Description | Type | Default | Required | @@ -36,9 +43,10 @@ Add description. | [key\_name](#input\_key\_name) | pre-created SSH in AWS for access to the ECS EC2 Instance | `string` | n/a | yes | | [public\_subnet\_ids](#input\_public\_subnet\_ids) | n/a | `list(string)` | n/a | yes | | [resource\_name](#input\_resource\_name) | The overall name of the shared resources | `string` | n/a | yes | -| [tags](#input\_tags) | n/a | `map(any)` | 
{
  "terraform_managed": "true"
}
| no | +| [tags](#input\_tags) | n/a | `map(any)` | 
{
  "terraform_managed": "true"
}
| no | | [vpc\_cidr](#input\_vpc\_cidr) | n/a | `string` | `"10.1.0.0/16"` | no | | [vpc\_id](#input\_vpc\_id) | n/a | `string` | n/a | yes | + ## Outputs | Name | Description | @@ -51,14 +59,4 @@ Add description. | [task\_execution\_role\_arn](#output\_task\_execution\_role\_arn) | n/a | | [userdata](#output\_userdata) | n/a | | [userdata64](#output\_userdata64) | n/a | -## Providers - -| Name | Version | -|------|---------| -| [aws](#provider\_aws) | n/a | - - -To automatically update this documentation, install terraform-docs on your local machine run the following: - cd - terraform-docs -c .terraform.docs.yml . \ No newline at end of file diff --git a/terraform/modules/legacy/multi-container-service/README.md b/terraform/modules/legacy/multi-container-service/README.md index 25343eb..15a101e 100644 --- a/terraform/modules/legacy/multi-container-service/README.md +++ b/terraform/modules/legacy/multi-container-service/README.md @@ -1,14 +1,20 @@ -# Multi-Container-Service +## Requirements -Add description. +No requirements. +## Providers + +| Name | Version | +|------|---------| +| [aws](#provider\_aws) | n/a | ## Modules | Name | Source | Version | |------|--------|---------| | [ecs-task](#module\_ecs-task) | ../ecs-task | n/a | + ## Resources | Name | Type | @@ -22,28 +28,22 @@ Add description. | [aws_service_discovery_private_dns_namespace.internal](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/service_discovery_private_dns_namespace) | resource | | [aws_lb.lb](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/lb) | data source | | [aws_route53_zone.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/route53_zone) | data source | + ## Inputs | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| | [application\_type](#input\_application\_type) | defines what type of application is running, fullstack, client, backend, etc. will be used for cloudwatch logs | `string` | n/a | yes | -| [containers](#input\_containers) | Per container service configuration. Note that subdomains are used (e.g. 'www' not 'www.example.com') | 
map(object({
    tag               = optional(string, "latest")
    desired_count     = optional(number, 1)
    launch_type       = optional(string, "FARGATE")
    cpu               = optional(number, 0)
    memory            = optional(number, 0)
    port              = optional(number, 80)
    subdomains        = optional(list(string), [])
    path_patterns     = optional(list(string), [])
    health_check_path = optional(string, "/")
    env_vars          = optional(map(any), {})
    secrets           = optional(map(any), {})
  }))
| n/a | yes | +| [containers](#input\_containers) | Per container service configuration. Note that subdomains are used (e.g. 'www' not 'www.example.com') | 
map(object({
    tag               = optional(string, "latest")
    desired_count     = optional(number, 1)
    launch_type       = optional(string, "FARGATE")
    cpu               = optional(number, 0)
    memory            = optional(number, 0)
    port              = optional(number, 80)
    subdomains        = optional(list(string), [])
    path_patterns     = optional(list(string), [])
    health_check_path = optional(string, "/")
    env_vars          = optional(map(any), {})
    secrets           = optional(map(any), {})
  }))
| n/a | yes | | [environment](#input\_environment) | n/a | `string` | n/a | yes | | [project\_name](#input\_project\_name) | The overall name of the project using this infrastructure; used to group related resources | `any` | n/a | yes | | [region](#input\_region) | n/a | `string` | n/a | yes | -| [shared\_configuration](#input\_shared\_configuration) | Configuration object from shared resources | 
object({
    alb_arn                 = string
    alb_https_listener_arn  = string
    cluster_id              = string
    cluster_name            = string
    task_execution_role_arn = string
    db_identifier           = string
    vpc_id                  = string
    public_subnet_ids       = set(string)
  })
| n/a | yes | -| [tags](#input\_tags) | n/a | `map(any)` | 
{
  "terraform_managed": "true"
}
| no | +| [shared\_configuration](#input\_shared\_configuration) | Configuration object from shared resources | 
object({
    alb_arn                 = string
    alb_https_listener_arn  = string
    cluster_id              = string
    cluster_name            = string
    task_execution_role_arn = string
    db_identifier           = string
    vpc_id                  = string
    public_subnet_ids       = set(string)
  })
| n/a | yes | +| [tags](#input\_tags) | n/a | `map(any)` | 
{
  "terraform_managed": "true"
}
| no | | [vpc\_cidr](#input\_vpc\_cidr) | VPC cidr block | `string` | n/a | yes | | [zone\_id](#input\_zone\_id) | The root zone\_id for the service | `string` | n/a | yes | -## Providers - -| Name | Version | -|------|---------| -| [aws](#provider\_aws) | n/a | - +## Outputs -To automatically update this documentation, install terraform-docs on your local machine run the following: - cd - terraform-docs -c .terraform.docs.yml . +No outputs. \ No newline at end of file diff --git a/terraform/modules/legacy/multi-tenant-database/README.md b/terraform/modules/legacy/multi-tenant-database/README.md index 4b6a59e..1a14b34 100644 --- a/terraform/modules/legacy/multi-tenant-database/README.md +++ b/terraform/modules/legacy/multi-tenant-database/README.md @@ -1,9 +1,18 @@ -# Multi-Tenant-Database +## Requirements -Add description. +No requirements. +## Providers +| Name | Version | +|------|---------| +| [archive](#provider\_archive) | n/a | +| [aws](#provider\_aws) | n/a | + +## Modules + +No modules. ## Resources @@ -16,6 +25,7 @@ Add description. | [aws_lambda_layer_version.python-sqlalchemy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lambda_layer_version) | resource | | [aws_security_group.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group) | resource | | [archive_file.lambda_zip](https://registry.terraform.io/providers/hashicorp/archive/latest/docs/data-sources/file) | data source | + ## Inputs | Name | Description | Type | Default | Required | @@ -26,23 +36,13 @@ Add description. | [private\_subnet\_ids](#input\_private\_subnet\_ids) | vpc private subnet ids | `list(string)` | n/a | yes | | [public\_subnet\_ids](#input\_public\_subnet\_ids) | vpc public subnet ids | `list(string)` | n/a | yes | | [resource\_name](#input\_resource\_name) | The overall name of the shared resources | `string` | n/a | yes | -| [tags](#input\_tags) | n/a | `map(any)` | 
{
  "terraform_managed": "true"
}
| no | +| [tags](#input\_tags) | n/a | `map(any)` | 
{
  "terraform_managed": "true"
}
| no | | [vpc\_cidr](#input\_vpc\_cidr) | VPC cidr block | `string` | n/a | yes | | [vpc\_id](#input\_vpc\_id) | VPC ID | `string` | n/a | yes | + ## Outputs | Name | Description | |------|-------------| | [lambda\_function](#output\_lambda\_function) | n/a | -## Providers - -| Name | Version | -|------|---------| -| [archive](#provider\_archive) | n/a | -| [aws](#provider\_aws) | n/a | - - -To automatically update this documentation, install terraform-docs on your local machine run the following: - cd - terraform-docs -c .terraform.docs.yml . \ No newline at end of file diff --git a/terraform/modules/legacy/network/README.md b/terraform/modules/legacy/network/README.md index a6fc289..0646122 100644 --- a/terraform/modules/legacy/network/README.md +++ b/terraform/modules/legacy/network/README.md @@ -1,20 +1,27 @@ -# Network +## Requirements -Add description. +No requirements. +## Providers + +| Name | Version | +|------|---------| +| [aws](#provider\_aws) | n/a | ## Modules | Name | Source | Version | |------|--------|---------| | [vpc](#module\_vpc) | terraform-aws-modules/vpc/aws | n/a | + ## Resources | Name | Type | |------|------| | [aws_availability_zones.available](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/availability_zones) | data source | | [aws_caller_identity.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) | data source | + ## Inputs | Name | Description | Type | Default | Required | @@ -22,8 +29,9 @@ Add description. | [environment](#input\_environment) | n/a | `string` | n/a | yes | | [region](#input\_region) | n/a | `string` | n/a | yes | | [resource\_name](#input\_resource\_name) | The overall name of the shared resources | `string` | n/a | yes | -| [tags](#input\_tags) | n/a | `map(any)` | 
{
  "terraform_managed": "true"
}
| no | +| [tags](#input\_tags) | n/a | `map(any)` | 
{
  "terraform_managed": "true"
}
| no | | [vpc\_cidr](#input\_vpc\_cidr) | n/a | `string` | `"10.10.0.0/16"` | no | + ## Outputs | Name | Description | @@ -38,14 +46,4 @@ Add description. | [public\_subnet\_ids](#output\_public\_subnet\_ids) | n/a | | [vpc\_cidr](#output\_vpc\_cidr) | n/a | | [vpc\_id](#output\_vpc\_id) | The ID of the VPC | -## Providers - -| Name | Version | -|------|---------| -| [aws](#provider\_aws) | n/a | - - -To automatically update this documentation, install terraform-docs on your local machine run the following: - cd - terraform-docs -c .terraform.docs.yml . \ No newline at end of file diff --git a/terraform/modules/legacy/private-dns/README.md b/terraform/modules/legacy/private-dns/README.md index dca07e0..5333090 100644 --- a/terraform/modules/legacy/private-dns/README.md +++ b/terraform/modules/legacy/private-dns/README.md @@ -1,15 +1,24 @@ -# Private-DNS +## Requirements -Add description. +No requirements. +## Providers + +| Name | Version | +|------|---------| +| [aws](#provider\_aws) | n/a | + +## Modules +No modules. ## Resources | Name | Type | |------|------| | [aws_service_discovery_private_dns_namespace.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/service_discovery_private_dns_namespace) | resource | + ## Inputs | Name | Description | Type | Default | Required | @@ -17,22 +26,13 @@ Add description. | [environment](#input\_environment) | n/a | `string` | n/a | yes | | [region](#input\_region) | n/a | `string` | `"us-east-2"` | no | | [resource\_name](#input\_resource\_name) | The overall name of the project using this infrastructure; used to group related resources by | `any` | n/a | yes | -| [tags](#input\_tags) | n/a | `map(any)` | 
{
  "terraform_managed": "true"
}
| no | +| [tags](#input\_tags) | n/a | `map(any)` | 
{
  "terraform_managed": "true"
}
| no | | [vpc\_id](#input\_vpc\_id) | VPC ID | `any` | n/a | yes | + ## Outputs | Name | Description | |------|-------------| | [private\_dns\_id](#output\_private\_dns\_id) | n/a | | [private\_dns\_name](#output\_private\_dns\_name) | n/a | -## Providers - -| Name | Version | -|------|---------| -| [aws](#provider\_aws) | n/a | - - -To automatically update this documentation, install terraform-docs on your local machine run the following: - cd - terraform-docs -c .terraform.docs.yml . \ No newline at end of file diff --git a/terraform/modules/legacy/project-zone/README.md b/terraform/modules/legacy/project-zone/README.md index 265ddb0..c658a34 100644 --- a/terraform/modules/legacy/project-zone/README.md +++ b/terraform/modules/legacy/project-zone/README.md @@ -1,9 +1,17 @@ -# Project-Zone +## Requirements -Add description. +No requirements. +## Providers + +| Name | Version | +|------|---------| +| [aws](#provider\_aws) | n/a | + +## Modules +No modules. ## Resources @@ -18,26 +26,18 @@ Add description. | [aws_route53_record.cert_validation](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/route53_record) | resource | | [aws_route53_zone.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/route53_zone) | resource | | [aws_lb.lb](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/lb) | data source | + ## Inputs | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| | [github\_at\_apex](#input\_github\_at\_apex) | n/a | `bool` | `false` | no | -| [shared\_configuration](#input\_shared\_configuration) | Configuration object from shared resources | 
object({
    alb_arn                = string
    alb_https_listener_arn = string
  })
| n/a | yes | +| [shared\_configuration](#input\_shared\_configuration) | Configuration object from shared resources | 
object({
    alb_arn                = string
    alb_https_listener_arn = string
  })
| n/a | yes | | [zone\_name](#input\_zone\_name) | n/a | `string` | n/a | yes | + ## Outputs | Name | Description | |------|-------------| | [zone\_id](#output\_zone\_id) | n/a | -## Providers - -| Name | Version | -|------|---------| -| [aws](#provider\_aws) | n/a | - - -To automatically update this documentation, install terraform-docs on your local machine run the following: - cd - terraform-docs -c .terraform.docs.yml . \ No newline at end of file diff --git a/terraform/modules/legacy/r53/README.md b/terraform/modules/legacy/r53/README.md index 35dd6ea..d26d05e 100644 --- a/terraform/modules/legacy/r53/README.md +++ b/terraform/modules/legacy/r53/README.md @@ -1,9 +1,17 @@ -# R53 +## Requirements -Add description. +No requirements. +## Providers +| Name | Version | +|------|---------| +| [aws](#provider\_aws) | n/a | + +## Modules + +No modules. ## Resources @@ -11,6 +19,7 @@ Add description. |------|------| | [aws_route53_record.www](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/route53_record) | resource | | [aws_route53_zone.selected](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/route53_zone) | data source | + ## Inputs | Name | Description | Type | Default | Required | @@ -19,14 +28,7 @@ Add description. | [domain\_name](#input\_domain\_name) | The domain name where the application will be deployed, must already live in AWS | `string` | n/a | yes | | [host\_names](#input\_host\_names) | The URL where the application will be hosted, must be a subdomain of the domain\_name | `list(string)` | n/a | yes | -## Providers - -| Name | Version | -|------|---------| -| [aws](#provider\_aws) | n/a | - +## Outputs -To automatically update this documentation, install terraform-docs on your local machine run the following: - cd - terraform-docs -c .terraform.docs.yml . +No outputs. \ No newline at end of file diff --git a/terraform/modules/legacy/rds/README.md b/terraform/modules/legacy/rds/README.md index 87ca4c6..23664d7 100644 --- a/terraform/modules/legacy/rds/README.md +++ b/terraform/modules/legacy/rds/README.md @@ -1,9 +1,17 @@ -# RDS +## Requirements -Add description. +No requirements. +## Providers + +| Name | Version | +|------|---------| +| [aws](#provider\_aws) | n/a | + +## Modules +No modules. ## Resources @@ -12,6 +20,7 @@ Add description. | [aws_db_instance.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/db_instance) | resource | | [aws_db_subnet_group.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/db_subnet_group) | resource | | [aws_security_group.db](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group) | resource | + ## Inputs | Name | Description | Type | Default | Required | @@ -33,9 +42,10 @@ Add description. | [public\_subnet\_ids](#input\_public\_subnet\_ids) | vpc public subnet ids | `list(string)` | n/a | yes | | [region](#input\_region) | the aws region code where this is deployed; ex: 'us-west-2', 'us-east-1', 'us-east-2' | `string` | n/a | yes | | [resource\_name](#input\_resource\_name) | The overall name of the shared resources | `string` | n/a | yes | -| [tags](#input\_tags) | n/a | `map(any)` | 
{
  "terraform_managed": "true"
}
| no | +| [tags](#input\_tags) | n/a | `map(any)` | 
{
  "terraform_managed": "true"
}
| no | | [vpc\_cidr](#input\_vpc\_cidr) | VPC cidr block | `string` | n/a | yes | | [vpc\_id](#input\_vpc\_id) | VPC ID | `string` | n/a | yes | + ## Outputs | Name | Description | @@ -45,14 +55,4 @@ Add description. | [db\_instance\_endpoint](#output\_db\_instance\_endpoint) | The db adress and port for this RDS instance | | [db\_instance\_hosted\_zone\_id](#output\_db\_instance\_hosted\_zone\_id) | n/a | | [db\_security\_group\_id](#output\_db\_security\_group\_id) | The security group id for this RDS instance | -## Providers - -| Name | Version | -|------|---------| -| [aws](#provider\_aws) | n/a | - - -To automatically update this documentation, install terraform-docs on your local machine run the following: - cd - terraform-docs -c .terraform.docs.yml . \ No newline at end of file diff --git a/terraform/modules/legacy/redis/README.md b/terraform/modules/legacy/redis/README.md index 0505e54..17791cb 100644 --- a/terraform/modules/legacy/redis/README.md +++ b/terraform/modules/legacy/redis/README.md @@ -1,9 +1,18 @@ -# Redis +## Requirements -Add description. +No requirements. +## Providers +| Name | Version | +|------|---------| +| [aws](#provider\_aws) | n/a | +| [template](#provider\_template) | n/a | + +## Modules + +No modules. ## Resources @@ -14,6 +23,7 @@ Add description. | [aws_security_group.redis_sg](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group) | resource | | [aws_service_discovery_service.sd_service](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/service_discovery_service) | resource | | [template_file.container-definition](https://registry.terraform.io/providers/hashicorp/template/latest/docs/data-sources/file) | data source | + ## Inputs | Name | Description | Type | Default | Required | @@ -29,22 +39,12 @@ Add description. | [public\_subnet\_ids](#input\_public\_subnet\_ids) | VPB Public Subnets for where to place Fargate tasks | `list(string)` | n/a | yes | | [region](#input\_region) | n/a | `string` | `"us-east-2"` | no | | [resource\_name](#input\_resource\_name) | The overall name of the project using this infrastructure; used to group related resources by | `any` | n/a | yes | -| [tags](#input\_tags) | n/a | `map(any)` | 
{
  "terraform_managed": "true"
}
| no | +| [tags](#input\_tags) | n/a | `map(any)` | 
{
  "terraform_managed": "true"
}
| no | | [vpc\_id](#input\_vpc\_id) | VPC ID | `any` | n/a | yes | + ## Outputs | Name | Description | |------|-------------| | [internal\_dns\_name](#output\_internal\_dns\_name) | n/a | -## Providers - -| Name | Version | -|------|---------| -| [aws](#provider\_aws) | n/a | -| [template](#provider\_template) | n/a | - - -To automatically update this documentation, install terraform-docs on your local machine run the following: - cd - terraform-docs -c .terraform.docs.yml . \ No newline at end of file diff --git a/terraform/modules/legacy/service/README.md b/terraform/modules/legacy/service/README.md index 09d14ab..cc8f357 100644 --- a/terraform/modules/legacy/service/README.md +++ b/terraform/modules/legacy/service/README.md @@ -1,8 +1,13 @@ -# Service +## Requirements -Add description. +No requirements. +## Providers + +| Name | Version | +|------|---------| +| [aws](#provider\_aws) | n/a | ## Modules @@ -10,6 +15,7 @@ Add description. |------|--------|---------| | [application\_container\_def](#module\_application\_container\_def) | cloudposse/ecs-container-definition/aws | 0.56.0 | | [ecr](#module\_ecr) | ../ecr | n/a | + ## Resources | Name | Type | @@ -23,10 +29,12 @@ Add description. | [aws_ecs_task_definition.task](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecs_task_definition) | resource | | [aws_lb_listener_rule.static](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lb_listener_rule) | resource | | [aws_lb_target_group.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lb_target_group) | resource | -| [aws_route53_record.www](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/route53_record) | resource | +| [aws_route53_record.root](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/route53_record) | resource | +| [aws_route53_record.subdomain](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/route53_record) | resource | | [aws_security_group.fargate](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group) | resource | | [aws_lambda_invocation.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/lambda_invocation) | data source | | [aws_route53_zone.selected](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/route53_zone) | data source | + ## Inputs | Name | Description | Type | Default | Required | @@ -35,7 +43,7 @@ Add description. | [alb\_https\_listener\_arn](#input\_alb\_https\_listener\_arn) | ALB https listener arn for adding rule to | `any` | n/a | yes | | [alb\_security\_group\_id](#input\_alb\_security\_group\_id) | ALB Security Group ID | `string` | n/a | yes | | [application\_type](#input\_application\_type) | defines what type of application is running, fullstack, client, backend, etc. will be used for cloudwatch logs | `string` | n/a | yes | -| [aws\_managed\_dns](#input\_aws\_managed\_dns) | flag to either create record if domain is managed in AWS or output ALB DNS for user to manually create | `bool` | n/a | yes | +| [aws\_managed\_dns](#input\_aws\_managed\_dns) | Flag to either create record if domain is managed in AWS or output ALB DNS for user to manually create | `bool` | n/a | yes | | [cluster\_id](#input\_cluster\_id) | n/a | `string` | n/a | yes | | [cluster\_name](#input\_cluster\_name) | n/a | `string` | n/a | yes | | [container\_cpu](#input\_container\_cpu) | n/a | `number` | `0` | no | @@ -58,23 +66,14 @@ Add description. | [region](#input\_region) | n/a | `string` | n/a | yes | | [root\_db\_password](#input\_root\_db\_password) | root database password | `string` | n/a | yes | | [root\_db\_username](#input\_root\_db\_username) | root database user | `string` | n/a | yes | -| [tags](#input\_tags) | n/a | `map(any)` | 
{
  "terraform_managed": "true"
}
| no | +| [tags](#input\_tags) | n/a | `map(any)` | 
{
  "terraform_managed": "true"
}
| no | | [task\_execution\_role\_arn](#input\_task\_execution\_role\_arn) | ECS task execution role with policy for accessing other AWS resources | `string` | n/a | yes | | [vpc\_cidr](#input\_vpc\_cidr) | VPC cidr block | `string` | n/a | yes | | [vpc\_id](#input\_vpc\_id) | VPC ID | `any` | n/a | yes | + ## Outputs | Name | Description | |------|-------------| | [result\_entry](#output\_result\_entry) | n/a | -## Providers - -| Name | Version | -|------|---------| -| [aws](#provider\_aws) | n/a | - - -To automatically update this documentation, install terraform-docs on your local machine run the following: - cd - terraform-docs -c .terraform.docs.yml . \ No newline at end of file diff --git a/terraform/modules/root-dns-entry/README.md b/terraform/modules/root-dns-entry/README.md new file mode 100644 index 0000000..1a9f5e2 --- /dev/null +++ b/terraform/modules/root-dns-entry/README.md @@ -0,0 +1,35 @@ + +## Requirements + +No requirements. + +## Providers + +| Name | Version | +|------|---------| +| [aws](#provider\_aws) | n/a | + +## Modules + +No modules. + +## Resources + +| Name | Type | +|------|------| +| [aws_route53_record.www](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/route53_record) | resource | +| [aws_lb.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/lb) | data source | +| [aws_route53_zone.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/route53_zone) | data source | + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:--------:| +| [zone\_id](#input\_zone\_id) | n/a | `string` | n/a | yes | + +## Outputs + +| Name | Description | +|------|-------------| +| [full\_dns\_name](#output\_full\_dns\_name) | n/a | + \ No newline at end of file diff --git a/terraform/modules/secret/README.md b/terraform/modules/secret/README.md new file mode 100644 index 0000000..0ff59d6 --- /dev/null +++ b/terraform/modules/secret/README.md @@ -0,0 +1,41 @@ + +## Requirements + +No requirements. + +## Providers + +| Name | Version | +|------|---------| +| [aws](#provider\_aws) | n/a | +| [random](#provider\_random) | n/a | + +## Modules + +No modules. + +## Resources + +| Name | Type | +|------|------| +| [aws_ssm_parameter.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ssm_parameter) | resource | +| [random_password.password](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/password) | resource | + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:--------:| +| [application\_type](#input\_application\_type) | n/a | `string` | n/a | yes | +| [environment](#input\_environment) | n/a | `string` | `""` | no | +| [length](#input\_length) | n/a | `number` | `48` | no | +| [name](#input\_name) | n/a | `string` | n/a | yes | +| [project\_name](#input\_project\_name) | n/a | `string` | n/a | yes | +| [value](#input\_value) | n/a | `string` | `null` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| [arn](#output\_arn) | n/a | +| [value](#output\_value) | n/a | + \ No newline at end of file diff --git a/terraform/projects/civic-tech-index/README.md b/terraform/projects/civic-tech-index/README.md new file mode 100644 index 0000000..82ab3d3 --- /dev/null +++ b/terraform/projects/civic-tech-index/README.md @@ -0,0 +1,32 @@ + +## Requirements + +No requirements. + +## Providers + +No providers. + +## Modules + +| Name | Source | Version | +|------|--------|---------| +| [backend\_prod\_service](#module\_backend\_prod\_service) | ../../modules/container | n/a | +| [backend\_stage\_service](#module\_backend\_stage\_service) | ../../modules/container | n/a | +| [prod\_database\_password\_secret](#module\_prod\_database\_password\_secret) | ../../modules/secret | n/a | +| [prod\_database\_username\_secret](#module\_prod\_database\_username\_secret) | ../../modules/secret | n/a | +| [stage\_database\_password\_secret](#module\_stage\_database\_password\_secret) | ../../modules/secret | n/a | +| [stage\_database\_username\_secret](#module\_stage\_database\_username\_secret) | ../../modules/secret | n/a | + +## Resources + +No resources. + +## Inputs + +No inputs. + +## Outputs + +No outputs. + \ No newline at end of file diff --git a/terraform/projects/civic-tech-jobs/README.md b/terraform/projects/civic-tech-jobs/README.md new file mode 100644 index 0000000..49d22c4 --- /dev/null +++ b/terraform/projects/civic-tech-jobs/README.md @@ -0,0 +1,35 @@ + +## Requirements + +No requirements. + +## Providers + +| Name | Version | +|------|---------| +| [random](#provider\_random) | n/a | + +## Modules + +| Name | Source | Version | +|------|--------|---------| +| [civic\_tech\_jobs\_cicd](#module\_civic\_tech\_jobs\_cicd) | ../../modules/cicd_integration | n/a | +| [civic\_tech\_jobs\_ecr\_fullstack](#module\_civic\_tech\_jobs\_ecr\_fullstack) | ../../modules/ecr | n/a | +| [civic\_tech\_jobs\_fullstack\_stage\_dns\_entry](#module\_civic\_tech\_jobs\_fullstack\_stage\_dns\_entry) | ../../modules/dns-entry | n/a | +| [civic\_tech\_jobs\_fullstack\_stage\_service](#module\_civic\_tech\_jobs\_fullstack\_stage\_service) | ../../modules/container | n/a | +| [civic\_tech\_jobs\_stage\_database](#module\_civic\_tech\_jobs\_stage\_database) | ../../modules/database | n/a | + +## Resources + +| Name | Type | +|------|------| +| [random_password.cookie_key](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/password) | resource | + +## Inputs + +No inputs. + +## Outputs + +No outputs. + \ No newline at end of file diff --git a/terraform/projects/home-unite-us/README.md b/terraform/projects/home-unite-us/README.md new file mode 100644 index 0000000..f1ae72c --- /dev/null +++ b/terraform/projects/home-unite-us/README.md @@ -0,0 +1,60 @@ + +## Requirements + +No requirements. + +## Providers + +| Name | Version | +|------|---------| +| [archive](#provider\_archive) | n/a | +| [aws](#provider\_aws) | n/a | + +## Modules + +| Name | Source | Version | +|------|--------|---------| +| [cicd\_integration](#module\_cicd\_integration) | ../../modules/cicd_integration | n/a | +| [database\_dev](#module\_database\_dev) | ../../modules/database | n/a | +| [db\_url\_qa](#module\_db\_url\_qa) | ../../modules/secret | n/a | +| [ecr\_fullstack](#module\_ecr\_fullstack) | ../../modules/ecr | n/a | +| [qa\_dns\_entry](#module\_qa\_dns\_entry) | ../../modules/dns-entry | n/a | +| [qa\_service](#module\_qa\_service) | ../../modules/container | n/a | + +## Resources + +| Name | Type | +|------|------| +| [aws_cognito_identity_provider.google_client](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cognito_identity_provider) | resource | +| [aws_cognito_user_group.homeuniteus](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cognito_user_group) | resource | +| [aws_cognito_user_pool.homeuniteus](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cognito_user_pool) | resource | +| [aws_cognito_user_pool_client.homeuniteus](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cognito_user_pool_client) | resource | +| [aws_cognito_user_pool_domain.homeuniteus](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cognito_user_pool_domain) | resource | +| [aws_iam_role.cognito_idp](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource | +| [aws_iam_role.lambda](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource | +| [aws_iam_role_policy.cognito_sns](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy) | resource | +| [aws_iam_role_policy_attachment.lambda_cognito](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource | +| [aws_iam_role_policy_attachment.lambda_execution](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource | +| [aws_iam_role_policy_attachment.test-attach](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource | +| [aws_lambda_function.cognito_custom_message](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lambda_function) | resource | +| [aws_lambda_function.cognito_merge_users](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lambda_function) | resource | +| [aws_lambda_permission.allow_merge_execution_from_user_pool](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lambda_permission) | resource | +| [aws_lambda_permission.allow_message_execution_from_user_pool](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lambda_permission) | resource | +| [aws_secretsmanager_secret.cognito_client](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/secretsmanager_secret) | resource | +| [aws_secretsmanager_secret.google_client_id](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/secretsmanager_secret) | resource | +| [aws_secretsmanager_secret.google_secret](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/secretsmanager_secret) | resource | +| [aws_secretsmanager_secret_version.cognito_client](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/secretsmanager_secret_version) | resource | +| [archive_file.cognito_custom_message](https://registry.terraform.io/providers/hashicorp/archive/latest/docs/data-sources/file) | data source | +| [archive_file.cognito_merge_users](https://registry.terraform.io/providers/hashicorp/archive/latest/docs/data-sources/file) | data source | +| [aws_iam_policy_document.lambda_assume_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source | +| [aws_secretsmanager_secret_version.google_client_id](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/secretsmanager_secret_version) | data source | +| [aws_secretsmanager_secret_version.google_secret](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/secretsmanager_secret_version) | data source | + +## Inputs + +No inputs. + +## Outputs + +No outputs. + \ No newline at end of file diff --git a/terraform/projects/people-depot/README.md b/terraform/projects/people-depot/README.md new file mode 100644 index 0000000..decf6f3 --- /dev/null +++ b/terraform/projects/people-depot/README.md @@ -0,0 +1,36 @@ + +## Requirements + +No requirements. + +## Providers + +| Name | Version | +|------|---------| +| [random](#provider\_random) | n/a | + +## Modules + +| Name | Source | Version | +|------|--------|---------| +| [backend\_dev\_api\_secret](#module\_backend\_dev\_api\_secret) | ../../modules/secret | n/a | +| [backend\_dev\_service](#module\_backend\_dev\_service) | ../../modules/container | n/a | +| [dev\_database](#module\_dev\_database) | ../../modules/database | n/a | +| [dev\_dns\_entry](#module\_dev\_dns\_entry) | ../../modules/dns-entry | n/a | +| [people\_depot\_cicd](#module\_people\_depot\_cicd) | ../../modules/cicd_integration | n/a | +| [people\_depot\_ecr\_backend](#module\_people\_depot\_ecr\_backend) | ../../modules/ecr | n/a | + +## Resources + +| Name | Type | +|------|------| +| [random_password.cookie_key](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/password) | resource | + +## Inputs + +No inputs. + +## Outputs + +No outputs. + \ No newline at end of file diff --git a/terraform/projects/vrms/README.md b/terraform/projects/vrms/README.md new file mode 100644 index 0000000..028ca36 --- /dev/null +++ b/terraform/projects/vrms/README.md @@ -0,0 +1,46 @@ + +## Requirements + +No requirements. + +## Providers + +No providers. + +## Modules + +| Name | Source | Version | +|------|--------|---------| +| [backend\_dev\_service](#module\_backend\_dev\_service) | ../../modules/container | n/a | +| [backend\_prod\_service](#module\_backend\_prod\_service) | ../../modules/container | n/a | +| [cicd](#module\_cicd) | ../../modules/cicd_integration | n/a | +| [custom\_request\_header\_secret](#module\_custom\_request\_header\_secret) | ../../modules/secret | n/a | +| [dev\_database\_url\_secret](#module\_dev\_database\_url\_secret) | ../../modules/secret | n/a | +| [dev\_dns\_entry](#module\_dev\_dns\_entry) | ../../modules/dns-entry | n/a | +| [ecr\_backend](#module\_ecr\_backend) | ../../modules/ecr | n/a | +| [ecr\_frontend](#module\_ecr\_frontend) | ../../modules/ecr | n/a | +| [frontend\_dev\_service](#module\_frontend\_dev\_service) | ../../modules/container | n/a | +| [frontend\_prod\_service](#module\_frontend\_prod\_service) | ../../modules/container | n/a | +| [gmail\_client\_id\_secret](#module\_gmail\_client\_id\_secret) | ../../modules/secret | n/a | +| [gmail\_refresh\_token\_secret](#module\_gmail\_refresh\_token\_secret) | ../../modules/secret | n/a | +| [gmail\_secret\_id\_secret](#module\_gmail\_secret\_id\_secret) | ../../modules/secret | n/a | +| [mailhog\_password\_secret](#module\_mailhog\_password\_secret) | ../../modules/secret | n/a | +| [mailhog\_user\_secret](#module\_mailhog\_user\_secret) | ../../modules/secret | n/a | +| [prod\_database\_url\_secret](#module\_prod\_database\_url\_secret) | ../../modules/secret | n/a | +| [slack\_bot\_token\_secret](#module\_slack\_bot\_token\_secret) | ../../modules/secret | n/a | +| [slack\_client\_secret\_secret](#module\_slack\_client\_secret\_secret) | ../../modules/secret | n/a | +| [slack\_oauth\_token\_secret](#module\_slack\_oauth\_token\_secret) | ../../modules/secret | n/a | +| [slack\_signing\_secret\_secret](#module\_slack\_signing\_secret\_secret) | ../../modules/secret | n/a | + +## Resources + +No resources. + +## Inputs + +No inputs. + +## Outputs + +No outputs. + \ No newline at end of file