From bbbc4776834693499bfb7a4a4f96c2d90732aa35 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Wed, 14 Feb 2024 08:52:17 +0000 Subject: [PATCH] terraform-docs: automated action --- README.md | 80 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 80 insertions(+) diff --git a/README.md b/README.md index 02cba6c..16abab9 100644 --- a/README.md +++ b/README.md @@ -4,3 +4,83 @@ - EC2 instance without EIP - EBS volume - VPC and subnet + + +## Requirements + +| Name | Version | +|------|---------| +| [aws](#requirement\_aws) | ~> 5.0 | +| [cloudflare](#requirement\_cloudflare) | ~> 4.0 | + +## Providers + +| Name | Version | +|------|---------| +| [aws](#provider\_aws) | ~> 5.0 | + +## Modules + +| Name | Source | Version | +|------|--------|---------| +| [ebs\_server\_1](#module\_ebs\_server\_1) | ./aws_ebs | n/a | +| [rds\_postgres](#module\_rds\_postgres) | ./aws_rds | n/a | +| [server1](#module\_server1) | ./aws_instance | n/a | +| [vpc](#module\_vpc) | ./aws_vpc | n/a | + +## Resources + +| Name | Type | +|------|------| +| [aws_availability_zones.available](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/availability_zones) | data source | + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:--------:| +| [allocated\_storage](#input\_allocated\_storage) | Storage amount GB | `string` | `"20"` | no | +| [allow\_major\_version\_upgrade](#input\_allow\_major\_version\_upgrade) | Allow major version upgrade | `bool` | `false` | no | +| [ami\_ubuntu\_22\_04](#input\_ami\_ubuntu\_22\_04) | ami\_ubuntu\_22.04 | `string` | `"ami-0ec7f9846da6b0f61"` | no | +| [apply\_immediately](#input\_apply\_immediately) | Apply immediately | `bool` | `false` | no | +| [backup\_retention\_period](#input\_backup\_retention\_period) | Backup retention period | `string` | `"3"` | no | +| [cidr\_vpc](#input\_cidr\_vpc) | CIDR block for VPC | `string` | `"192.168.0.0/16"` | no | +| [db\_name](#input\_db\_name) | Created db name | `string` | n/a | yes | +| [db\_port](#input\_db\_port) | DB open port | `string` | n/a | yes | +| [deletion\_protection](#input\_deletion\_protection) | Deletion protection | `bool` | `false` | no | +| [ebs\_name](#input\_ebs\_name) | EBS name | `string` | `"/dev/sdf"` | no | +| [engine](#input\_engine) | Engine type | `string` | `"postgres"` | no | +| [engine\_version](#input\_engine\_version) | Engine\_version | `string` | `"14.8"` | no | +| [env](#input\_env) | Environment | `string` | `"dev"` | no | +| [inst1\_name](#input\_inst1\_name) | Name for instances | `string` | `"test"` | no | +| [inst2\_name](#input\_inst2\_name) | Name for instances | `string` | `""` | no | +| [inst3\_name](#input\_inst3\_name) | Name for instances | `string` | `""` | no | +| [inst4\_name](#input\_inst4\_name) | Name for instances | `string` | `""` | no | +| [instance\_class](#input\_instance\_class) | Instance\_class | `string` | `"db.t4g.micro"` | no | +| [max\_allocated\_storage](#input\_max\_allocated\_storage) | Autoscale stogage amount | `string` | `"0"` | no | +| [monitoring\_interval](#input\_monitoring\_interval) | Monitoring interval | `string` | `"0"` | no | +| [multi\_az](#input\_multi\_az) | multi\_az | `bool` | `false` | no | +| [nat\_create](#input\_nat\_create) | Is create a NAT Gateway? | `bool` | `false` | no | +| [parameter\_group\_name](#input\_parameter\_group\_name) | Parameter group name | `string` | `"default.postgres14"` | no | +| [password](#input\_password) | Password for master username | `string` | n/a | yes | +| [private\_subnet\_cidrs](#input\_private\_subnet\_cidrs) | Public subnet CIDRs | `list(string)` | 
[
  "192.168.21.0/24",
  "192.168.22.0/24"
]
| no | +| [project\_name](#input\_project\_name) | Project name | `string` | n/a | yes | +| [public\_subnet\_cidrs](#input\_public\_subnet\_cidrs) | Public subnet CIDRs | `list(string)` | 
[
  "192.168.11.0/24",
  "192.168.12.0/24"
]
| no | +| [publicly\_accessible](#input\_publicly\_accessible) | Publicly accessible | `bool` | `false` | no | +| [region](#input\_region) | AWS region | `string` | `"eu-central-1"` | no | +| [skip\_final\_snapshot](#input\_skip\_final\_snapshot) | Skip final snapshot | `bool` | n/a | yes | +| [ssh\_key](#input\_ssh\_key) | SSH key pair for instances | `string` | `"test_key"` | no | +| [storage\_type](#input\_storage\_type) | Storage type | `string` | `"gp3"` | no | +| [username](#input\_username) | Master username | `string` | n/a | yes | + +## Outputs + +| Name | Description | +|------|-------------| +| [avz](#output\_avz) | n/a | +| [avz\_ids](#output\_avz\_ids) | n/a | +| [nat\_eip](#output\_nat\_eip) | n/a | +| [private\_subnet\_ids](#output\_private\_subnet\_ids) | n/a | +| [public\_subnet\_ids](#output\_public\_subnet\_ids) | n/a | +| [rds\_endpoint](#output\_rds\_endpoint) | Endpoint of the RDS instance | +| [vpc\_id](#output\_vpc\_id) | n/a | + \ No newline at end of file