Skip to content

Commit 394b3a3

Browse files
committed
docs: update the input variables in readme
1 parent 1f9994f commit 394b3a3

File tree

2 files changed

+10
-20
lines changed

2 files changed

+10
-20
lines changed

.terraform-docs.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@ header-from: .header.md
44
footer-from: ""
55

66
recursive:
7-
enabled: true
8-
path: modules
7+
enabled: false
98
include-main: true
109

1110
output:

README.md

Lines changed: 9 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -52,15 +52,21 @@ This Terraform module automates the deployment of the Atlantis server on an ECS
5252
5353
| Name | Source | Version |
5454
|------|--------|---------|
55-
| <a name="module_alb"></a> [alb](#module\_alb) | ./modules/alb | n/a |
56-
| <a name="module_ecs"></a> [ecs](#module\_ecs) | ./modules/ecs | n/a |
55+
| <a name="module_ecs_deployment"></a> [ecs\_deployment](#module\_ecs\_deployment) | infraspecdev/ecs-deployment/aws | 2.1.0 |
5756
5857
## Resources
5958
6059
| Name | Type |
6160
|------|------|
6261
| [aws_iam_openid_connect_provider.google](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_openid_connect_provider) | resource |
62+
| [aws_iam_role.task_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource |
63+
| [aws_route53_record.record](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/route53_record) | resource |
64+
| [aws_security_group.alb](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group) | resource |
65+
| [aws_security_group.ecs](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group) | resource |
66+
| [aws_acm_certificate.base_domain_certificate](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/acm_certificate) | data source |
6367
| [aws_ecs_cluster.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/ecs_cluster) | data source |
68+
| [aws_iam_policy_document.ecs_task_assume_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
69+
| [aws_route53_zone.zone](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/route53_zone) | data source |
6470
| [aws_ssm_parameter.environment](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/ssm_parameter) | data source |
6571
| [aws_vpc.selected](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/vpc) | data source |
6672
@@ -71,16 +77,9 @@ This Terraform module automates the deployment of the Atlantis server on an ECS
7177
| <a name="input_atlantis_gh_user"></a> [atlantis\_gh\_user](#input\_atlantis\_gh\_user) | The GitHub username used by Atlantis to access repositories | `string` | n/a | yes |
7278
| <a name="input_atlantis_repo_allowlist"></a> [atlantis\_repo\_allowlist](#input\_atlantis\_repo\_allowlist) | Comma delimited string containing repos to use atlantis | `string` | n/a | yes |
7379
| <a name="input_base_domain"></a> [base\_domain](#input\_base\_domain) | Your base domain with acm certificate attached to it. | `string` | n/a | yes |
74-
| <a name="input_container_memory_reservation"></a> [container\_memory\_reservation](#input\_container\_memory\_reservation) | Soft limit (in MiB) of memory to reserve for the container. When system memory is under contention, Docker attempts to keep the container memory to this soft limit | `number` | n/a | yes |
75-
| <a name="input_ecs_auto_scaling_group_desired_capacity"></a> [ecs\_auto\_scaling\_group\_desired\_capacity](#input\_ecs\_auto\_scaling\_group\_desired\_capacity) | (Optional) Number of Amazon EC2 instances that should be running in the group. | `number` | `null` | no |
76-
| <a name="input_ecs_auto_scaling_group_max_size"></a> [ecs\_auto\_scaling\_group\_max\_size](#input\_ecs\_auto\_scaling\_group\_max\_size) | (Required) Maximum size of the Auto Scaling Group. | `number` | n/a | yes |
77-
| <a name="input_ecs_auto_scaling_group_min_size"></a> [ecs\_auto\_scaling\_group\_min\_size](#input\_ecs\_auto\_scaling\_group\_min\_size) | (Required) Minimum size of the Auto Scaling Group | `number` | n/a | yes |
78-
| <a name="input_ecs_launch_template_image_id"></a> [ecs\_launch\_template\_image\_id](#input\_ecs\_launch\_template\_image\_id) | (Optional) The AMI from which to launch the instance. | `string` | `null` | no |
79-
| <a name="input_ecs_launch_template_instance_type"></a> [ecs\_launch\_template\_instance\_type](#input\_ecs\_launch\_template\_instance\_type) | (Optional) The type of the instance. | `string` | `null` | no |
8080
| <a name="input_ecs_launch_type_cpu"></a> [ecs\_launch\_type\_cpu](#input\_ecs\_launch\_type\_cpu) | EC2 instance CPU | `number` | `null` | no |
8181
| <a name="input_ecs_launch_type_memory"></a> [ecs\_launch\_type\_memory](#input\_ecs\_launch\_type\_memory) | EC2 instance memory | `number` | `null` | no |
8282
| <a name="input_ecs_service_desired_count"></a> [ecs\_service\_desired\_count](#input\_ecs\_service\_desired\_count) | (Optional) Number of instances of the task definition to place and keep running. | `number` | `null` | no |
83-
| <a name="input_launch_template_key_name"></a> [launch\_template\_key\_name](#input\_launch\_template\_key\_name) | The key name to use for the instance. | `string` | n/a | yes |
8483
| <a name="input_private_subnet_ids"></a> [private\_subnet\_ids](#input\_private\_subnet\_ids) | List of Private subnet ids to deploy Atlantis server. | `list(string)` | n/a | yes |
8584
| <a name="input_public_subnet_ids"></a> [public\_subnet\_ids](#input\_public\_subnet\_ids) | List of Public subnet ids to deploy application load balancers. | `list(string)` | n/a | yes |
8685
| <a name="input_sub_domain"></a> [sub\_domain](#input\_sub\_domain) | Your desired sub domain | `string` | n/a | yes |
@@ -90,12 +89,4 @@ This Terraform module automates the deployment of the Atlantis server on an ECS
9089
9190
| Name | Description |
9291
|------|-------------|
93-
| <a name="output_alb_dns_name"></a> [alb\_dns\_name](#output\_alb\_dns\_name) | The DNS name of the ALB |
94-
| <a name="output_authorized_javascript_origin"></a> [authorized\_javascript\_origin](#output\_authorized\_javascript\_origin) | The base URL for your application that is authorized to use JavaScript for OAuth requests. |
95-
| <a name="output_authorized_redirect_uri"></a> [authorized\_redirect\_uri](#output\_authorized\_redirect\_uri) | The redirect URI used by your OAuth provider to return responses to your application. |
96-
| <a name="output_ecs_service_name"></a> [ecs\_service\_name](#output\_ecs\_service\_name) | The name of the ECS service |
97-
| <a name="output_ecs_task_definition_arn"></a> [ecs\_task\_definition\_arn](#output\_ecs\_task\_definition\_arn) | The ARN of the ECS task definition |
98-
| <a name="output_github_webhook_url"></a> [github\_webhook\_url](#output\_github\_webhook\_url) | The URL for GitHub webhook |
99-
| <a name="output_private_subnet_ids"></a> [private\_subnet\_ids](#output\_private\_subnet\_ids) | The IDs of the private subnets. |
100-
| <a name="output_public_subnet_ids"></a> [public\_subnet\_ids](#output\_public\_subnet\_ids) | The IDs of the public subnets. |
101-
| <a name="output_vpc_id"></a> [vpc\_id](#output\_vpc\_id) | The ID of the VPC. |
92+
| <a name="output_atlantis_url"></a> [atlantis\_url](#output\_atlantis\_url) | The URL for Atlantis. |

0 commit comments

Comments
 (0)