Skip to content

Commit

Permalink
update to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
angeloskyratzakos committed Dec 20, 2024
1 parent c50a92b commit fffbbef
Show file tree
Hide file tree
Showing 16 changed files with 18 additions and 18 deletions.
2 changes: 1 addition & 1 deletion aws/aurora-cluster/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ No modules.
| <a name="input_preferred_backup_window"></a> [preferred\_backup\_window](#input\_preferred\_backup\_window) | The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter | `string` | n/a | yes |
| <a name="input_preferred_maintenance_window"></a> [preferred\_maintenance\_window](#input\_preferred\_maintenance\_window) | The window to perform maintenance in | `string` | n/a | yes |
| <a name="input_publicly_accessible"></a> [publicly\_accessible](#input\_publicly\_accessible) | Bool to control if instance is publicly accessible | `bool` | `false` | no |
| <a name="input_ram_memory_bytes"></a> [ram\_memory\_bytes](#input\_ram\_memory\_bytes) | The RAM memory of each instance type in Bytes. | `map(any)` | <pre>{<br> "db.r5.12xlarge": "412316860416",<br> "db.r5.16xlarge": "549755813888",<br> "db.r5.24xlarge": "824633720832",<br> "db.r5.2xlarge": "68719476736",<br> "db.r5.4xlarge": "137438953472",<br> "db.r5.8xlarge": "274877906944",<br> "db.r5.large": "17179869184",<br> "db.r5.xlarge": "34359738368",<br> "db.r6g.12xlarge": "412316860416",<br> "db.r6g.16xlarge": "549755813888",<br> "db.r6g.24xlarge": "824633720832",<br> "db.r6g.2xlarge": "68719476736",<br> "db.r6g.4xlarge": "137438953472",<br> "db.r6g.8xlarge": "274877906944",<br> "db.r6g.large": "17179869184",<br> "db.r6g.xlarge": "34359738368",<br> "db.t3.large": "8589934592",<br> "db.t3.medium": "4294967296",<br> "db.t3.small": "2147483648",<br> "db.t4g.large": "8589934592",<br> "db.t4g.medium": "4294967296",<br> "db.t4g.small": "2147483648"<br>}</pre> | no |
| <a name="input_ram_memory_bytes"></a> [ram\_memory\_bytes](#input\_ram\_memory\_bytes) | The RAM memory of each instance type in Bytes. | `map(any)` | <pre>{<br/> "db.r5.12xlarge": "412316860416",<br/> "db.r5.16xlarge": "549755813888",<br/> "db.r5.24xlarge": "824633720832",<br/> "db.r5.2xlarge": "68719476736",<br/> "db.r5.4xlarge": "137438953472",<br/> "db.r5.8xlarge": "274877906944",<br/> "db.r5.large": "17179869184",<br/> "db.r5.xlarge": "34359738368",<br/> "db.r6g.12xlarge": "412316860416",<br/> "db.r6g.16xlarge": "549755813888",<br/> "db.r6g.24xlarge": "824633720832",<br/> "db.r6g.2xlarge": "68719476736",<br/> "db.r6g.4xlarge": "137438953472",<br/> "db.r6g.8xlarge": "274877906944",<br/> "db.r6g.large": "17179869184",<br/> "db.r6g.xlarge": "34359738368",<br/> "db.t3.large": "8589934592",<br/> "db.t3.medium": "4294967296",<br/> "db.t3.small": "2147483648",<br/> "db.t4g.large": "8589934592",<br/> "db.t4g.medium": "4294967296",<br/> "db.t4g.small": "2147483648"<br/>}</pre> | no |
| <a name="input_rds_sns_topic"></a> [rds\_sns\_topic](#input\_rds\_sns\_topic) | RDS events sns topic | `string` | `"rds-cluster-events"` | no |
| <a name="input_replica_min"></a> [replica\_min](#input\_replica\_min) | Number of replicas to deploy initially with the RDS Cluster. | `number` | n/a | yes |
| <a name="input_service_name"></a> [service\_name](#input\_service\_name) | THe name of the service | `string` | n/a | yes |
Expand Down
2 changes: 1 addition & 1 deletion aws/awat/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@
| <a name="input_awat_db_password"></a> [awat\_db\_password](#input\_awat\_db\_password) | n/a | `string` | n/a | yes |
| <a name="input_awat_db_username"></a> [awat\_db\_username](#input\_awat\_db\_username) | n/a | `string` | n/a | yes |
| <a name="input_awat_enable_rds_alerting"></a> [awat\_enable\_rds\_alerting](#input\_awat\_enable\_rds\_alerting) | n/a | `bool` | `false` | no |
| <a name="input_awat_enabled_cloudwatch_logs_exports"></a> [awat\_enabled\_cloudwatch\_logs\_exports](#input\_awat\_enabled\_cloudwatch\_logs\_exports) | n/a | `list(string)` | <pre>[<br> "postgresql"<br>]</pre> | no |
| <a name="input_awat_enabled_cloudwatch_logs_exports"></a> [awat\_enabled\_cloudwatch\_logs\_exports](#input\_awat\_enabled\_cloudwatch\_logs\_exports) | n/a | `list(string)` | <pre>[<br/> "postgresql"<br/>]</pre> | no |
| <a name="input_awat_kms_key"></a> [awat\_kms\_key](#input\_awat\_kms\_key) | n/a | `string` | n/a | yes |
| <a name="input_awat_max_capacity"></a> [awat\_max\_capacity](#input\_awat\_max\_capacity) | n/a | `number` | `4` | no |
| <a name="input_awat_min_capacity"></a> [awat\_min\_capacity](#input\_awat\_min\_capacity) | n/a | `number` | `0.5` | no |
Expand Down
2 changes: 1 addition & 1 deletion aws/blapi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
| <a name="input_blapi_db_cluster_instance_identifier"></a> [blapi\_db\_cluster\_instance\_identifier](#input\_blapi\_db\_cluster\_instance\_identifier) | n/a | `string` | n/a | yes |
| <a name="input_blapi_db_cluster_instance_type"></a> [blapi\_db\_cluster\_instance\_type](#input\_blapi\_db\_cluster\_instance\_type) | n/a | `string` | `"db.t4g.medium"` | no |
| <a name="input_blapi_enable_rds_alerting"></a> [blapi\_enable\_rds\_alerting](#input\_blapi\_enable\_rds\_alerting) | n/a | `bool` | `false` | no |
| <a name="input_blapi_enabled_cloudwatch_logs_exports"></a> [blapi\_enabled\_cloudwatch\_logs\_exports](#input\_blapi\_enabled\_cloudwatch\_logs\_exports) | n/a | `list(string)` | <pre>[<br> "postgresql"<br>]</pre> | no |
| <a name="input_blapi_enabled_cloudwatch_logs_exports"></a> [blapi\_enabled\_cloudwatch\_logs\_exports](#input\_blapi\_enabled\_cloudwatch\_logs\_exports) | n/a | `list(string)` | <pre>[<br/> "postgresql"<br/>]</pre> | no |
| <a name="input_blapi_kms_key"></a> [blapi\_kms\_key](#input\_blapi\_kms\_key) | n/a | `string` | n/a | yes |
| <a name="input_blapi_max_capacity"></a> [blapi\_max\_capacity](#input\_blapi\_max\_capacity) | n/a | `number` | `4` | no |
| <a name="input_blapi_min_capacity"></a> [blapi\_min\_capacity](#input\_blapi\_min\_capacity) | n/a | `number` | `0.5` | no |
Expand Down
2 changes: 1 addition & 1 deletion aws/calls-offloader-storage/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ No modules.
| <a name="input_root_kms_key_id"></a> [root\_kms\_key\_id](#input\_root\_kms\_key\_id) | Optional KMS Key ID for encrypting the root volume of the NFS server. Leave empty to use the default AWS-managed KMS key. | `string` | `""` | no |
| <a name="input_root_volume_size"></a> [root\_volume\_size](#input\_root\_volume\_size) | Size of the root volume in GiB for the NFS server. | `number` | `20` | no |
| <a name="input_volume_type"></a> [volume\_type](#input\_volume\_type) | Type of volumefor the NFS server. | `string` | `"gp3"` | no |
| <a name="input_vpc_configurations"></a> [vpc\_configurations](#input\_vpc\_configurations) | Map of VPC configurations, including VPC ID and subnets. | <pre>map(object({<br> vpc_id = string<br> subnet_ids = list(string)<br> }))</pre> | n/a | yes |
| <a name="input_vpc_configurations"></a> [vpc\_configurations](#input\_vpc\_configurations) | Map of VPC configurations, including VPC ID and subnets. | <pre>map(object({<br/> vpc_id = string<br/> subnet_ids = list(string)<br/> }))</pre> | n/a | yes |

## Outputs

Expand Down
2 changes: 1 addition & 1 deletion aws/community-rds-infra/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ No modules.
|------|-------------|------|---------|:--------:|
| <a name="input_private_hosted_zoneid"></a> [private\_hosted\_zoneid](#input\_private\_hosted\_zoneid) | The ID of the Route53 private hosted zone | `string` | n/a | yes |
| <a name="input_rds_reader_hostnames"></a> [rds\_reader\_hostnames](#input\_rds\_reader\_hostnames) | The RDS reader hostname, must be 3 elements. The first element is the generic reader hostname, the second is the primary reader, and the third is the secondary reader. | `list(string)` | n/a | yes |
| <a name="input_rds_reader_records"></a> [rds\_reader\_records](#input\_rds\_reader\_records) | The RDS reader records, must be 3 elements. The first element is the generic reader record, the second is the primary reader, and the third is the secondary reader. | `list(string)` | <pre>[<br> "community-db-ro",<br> "community-db-reader1",<br> "community-db-reader2"<br>]</pre> | no |
| <a name="input_rds_reader_records"></a> [rds\_reader\_records](#input\_rds\_reader\_records) | The RDS reader records, must be 3 elements. The first element is the generic reader record, the second is the primary reader, and the third is the secondary reader. | `list(string)` | <pre>[<br/> "community-db-ro",<br/> "community-db-reader1",<br/> "community-db-reader2"<br/>]</pre> | no |
| <a name="input_rds_writer_hostname"></a> [rds\_writer\_hostname](#input\_rds\_writer\_hostname) | The RDS writer hostname | `string` | n/a | yes |

## Outputs
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,15 +45,15 @@ No modules.
| <a name="input_check_nlb"></a> [check\_nlb](#input\_check\_nlb) | n/a | `bool` | `false` | no |
| <a name="input_cluster_name"></a> [cluster\_name](#input\_cluster\_name) | Name of the EKS cluster to create or validate | `string` | n/a | yes |
| <a name="input_create_private_endpoint"></a> [create\_private\_endpoint](#input\_create\_private\_endpoint) | Flag to indicate if the EKS cluster should have a private endpoint only | `bool` | `true` | no |
| <a name="input_eks_cluster_tags"></a> [eks\_cluster\_tags](#input\_eks\_cluster\_tags) | n/a | `map(string)` | <pre>{<br> "Name": "EKS Cluster Private link POC"<br>}</pre> | no |
| <a name="input_eks_cluster_tags"></a> [eks\_cluster\_tags](#input\_eks\_cluster\_tags) | n/a | `map(string)` | <pre>{<br/> "Name": "EKS Cluster Private link POC"<br/>}</pre> | no |
| <a name="input_environment"></a> [environment](#input\_environment) | Environment name | `string` | n/a | yes |
| <a name="input_instance_type"></a> [instance\_type](#input\_instance\_type) | Type of EC2 instance | `string` | `"t2.micro"` | no |
| <a name="input_key_name"></a> [key\_name](#input\_key\_name) | n/a | `string` | `""` | no |
| <a name="input_listener_port"></a> [listener\_port](#input\_listener\_port) | Listener port for NLB | `number` | `443` | no |
| <a name="input_nlb_name"></a> [nlb\_name](#input\_nlb\_name) | Name of the Network Load Balancer | `string` | n/a | yes |
| <a name="input_proxy_security_group_ids"></a> [proxy\_security\_group\_ids](#input\_proxy\_security\_group\_ids) | Security Groups for the proxy instance | `list(string)` | n/a | yes |
| <a name="input_proxy_subnet_id"></a> [proxy\_subnet\_id](#input\_proxy\_subnet\_id) | Subnet ID where the instance will be deployed | `string` | n/a | yes |
| <a name="input_proxy_tags"></a> [proxy\_tags](#input\_proxy\_tags) | n/a | `map(string)` | <pre>{<br> "Name": "Proxy Instance POC"<br>}</pre> | no |
| <a name="input_proxy_tags"></a> [proxy\_tags](#input\_proxy\_tags) | n/a | `map(string)` | <pre>{<br/> "Name": "Proxy Instance POC"<br/>}</pre> | no |
| <a name="input_security_group_ids"></a> [security\_group\_ids](#input\_security\_group\_ids) | Security Groups for the EKS cluster | `list(string)` | n/a | yes |
| <a name="input_subnet_ids"></a> [subnet\_ids](#input\_subnet\_ids) | Subnets used by the EKS cluster | `list(string)` | n/a | yes |
| <a name="input_target_group_name"></a> [target\_group\_name](#input\_target\_group\_name) | Name of the target group for NLB | `string` | n/a | yes |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ No modules.
| <a name="input_ami_id"></a> [ami\_id](#input\_ami\_id) | AMI ID to be used for the instance | `string` | n/a | yes |
| <a name="input_check_nlb"></a> [check\_nlb](#input\_check\_nlb) | n/a | `bool` | `false` | no |
| <a name="input_environment"></a> [environment](#input\_environment) | Environment name | `string` | n/a | yes |
| <a name="input_instance_tags"></a> [instance\_tags](#input\_instance\_tags) | n/a | `map(string)` | <pre>{<br> "Name": "Service Instance POC"<br>}</pre> | no |
| <a name="input_instance_tags"></a> [instance\_tags](#input\_instance\_tags) | n/a | `map(string)` | <pre>{<br/> "Name": "Service Instance POC"<br/>}</pre> | no |
| <a name="input_instance_type"></a> [instance\_type](#input\_instance\_type) | Type of EC2 instance | `string` | `"t2.micro"` | no |
| <a name="input_listener_port"></a> [listener\_port](#input\_listener\_port) | Listener port for NLB | `number` | `80` | no |
| <a name="input_nlb_name"></a> [nlb\_name](#input\_nlb\_name) | Name of the Network Load Balancer | `string` | n/a | yes |
Expand Down
2 changes: 1 addition & 1 deletion aws/customer-web-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
| <a name="input_cws_db_username"></a> [cws\_db\_username](#input\_cws\_db\_username) | n/a | `string` | n/a | yes |
| <a name="input_cws_enable_bastion"></a> [cws\_enable\_bastion](#input\_cws\_enable\_bastion) | n/a | `bool` | `true` | no |
| <a name="input_cws_enable_rds_alerting"></a> [cws\_enable\_rds\_alerting](#input\_cws\_enable\_rds\_alerting) | n/a | `bool` | `false` | no |
| <a name="input_cws_enabled_cloudwatch_logs_exports"></a> [cws\_enabled\_cloudwatch\_logs\_exports](#input\_cws\_enabled\_cloudwatch\_logs\_exports) | n/a | `list(string)` | <pre>[<br> "postgresql"<br>]</pre> | no |
| <a name="input_cws_enabled_cloudwatch_logs_exports"></a> [cws\_enabled\_cloudwatch\_logs\_exports](#input\_cws\_enabled\_cloudwatch\_logs\_exports) | n/a | `list(string)` | <pre>[<br/> "postgresql"<br/>]</pre> | no |
| <a name="input_cws_kms_key"></a> [cws\_kms\_key](#input\_cws\_kms\_key) | n/a | `string` | n/a | yes |
| <a name="input_cws_max_capacity"></a> [cws\_max\_capacity](#input\_cws\_max\_capacity) | n/a | `number` | `4` | no |
| <a name="input_cws_min_capacity"></a> [cws\_min\_capacity](#input\_cws\_min\_capacity) | n/a | `number` | `0.5` | no |
Expand Down
4 changes: 2 additions & 2 deletions aws/eks-customer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@
| <a name="input_cluster_endpoint_private_access"></a> [cluster\_endpoint\_private\_access](#input\_cluster\_endpoint\_private\_access) | Indicates whether or not the Amazon EKS private API server endpoint is enabled | `bool` | n/a | yes |
| <a name="input_cluster_endpoint_public_access"></a> [cluster\_endpoint\_public\_access](#input\_cluster\_endpoint\_public\_access) | Indicates whether or not the Amazon EKS public API server endpoint is enabled | `bool` | n/a | yes |
| <a name="input_cluster_name"></a> [cluster\_name](#input\_cluster\_name) | The cluster name | `string` | n/a | yes |
| <a name="input_cluster_security_group_additional_rules"></a> [cluster\_security\_group\_additional\_rules](#input\_cluster\_security\_group\_additional\_rules) | The list of additional security group rules for the EKS cluster | <pre>map(object({<br> from_port = number<br> to_port = number<br> protocol = string<br> cidr_blocks = list(string)<br> type = string<br> }))</pre> | n/a | yes |
| <a name="input_cluster_security_group_additional_rules"></a> [cluster\_security\_group\_additional\_rules](#input\_cluster\_security\_group\_additional\_rules) | The list of additional security group rules for the EKS cluster | <pre>map(object({<br/> from_port = number<br/> to_port = number<br/> protocol = string<br/> cidr_blocks = list(string)<br/> type = string<br/> }))</pre> | n/a | yes |
| <a name="input_cluster_tags"></a> [cluster\_tags](#input\_cluster\_tags) | A map of tags to add to all resources | `map(string)` | `{}` | no |
| <a name="input_cluster_version"></a> [cluster\_version](#input\_cluster\_version) | The Kubernetes version for the EKS cluster | `string` | n/a | yes |
| <a name="input_coredns_version"></a> [coredns\_version](#input\_coredns\_version) | The version of the CoreDNS addon | `string` | n/a | yes |
Expand Down Expand Up @@ -112,7 +112,7 @@
| <a name="input_snapshot_controller_version"></a> [snapshot\_controller\_version](#input\_snapshot\_controller\_version) | n/a | `string` | n/a | yes |
| <a name="input_staff_role_arn"></a> [staff\_role\_arn](#input\_staff\_role\_arn) | The staff role arn | `string` | n/a | yes |
| <a name="input_use_name_prefix"></a> [use\_name\_prefix](#input\_use\_name\_prefix) | Determines whether to use `name` as is or create a unique name beginning with the `name` as the prefix | `bool` | `false` | no |
| <a name="input_utilities"></a> [utilities](#input\_utilities) | The list of utilities | <pre>list(object({<br> name = string<br> enable_irsa = bool<br> internal_dns = any<br> service_account = string<br> cluster_label_type = string<br> }))</pre> | n/a | yes |
| <a name="input_utilities"></a> [utilities](#input\_utilities) | The list of utilities | <pre>list(object({<br/> name = string<br/> enable_irsa = bool<br/> internal_dns = any<br/> service_account = string<br/> cluster_label_type = string<br/> }))</pre> | n/a | yes |
| <a name="input_volume_delete_on_termination"></a> [volume\_delete\_on\_termination](#input\_volume\_delete\_on\_termination) | Indicates whether the EBS volume is deleted on termination | `bool` | `true` | no |
| <a name="input_volume_encrypted"></a> [volume\_encrypted](#input\_volume\_encrypted) | Indicates whether the EBS volume is encrypted | `bool` | `true` | no |
| <a name="input_volume_iops"></a> [volume\_iops](#input\_volume\_iops) | The amount of provisioned IOPS | `number` | `3000` | no |
Expand Down
2 changes: 1 addition & 1 deletion aws/elasticsearch/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ No modules.
| <a name="input_dedicated_master_enabled"></a> [dedicated\_master\_enabled](#input\_dedicated\_master\_enabled) | n/a | `bool` | n/a | yes |
| <a name="input_dedicated_master_type"></a> [dedicated\_master\_type](#input\_dedicated\_master\_type) | n/a | `string` | n/a | yes |
| <a name="input_domain_name"></a> [domain\_name](#input\_domain\_name) | n/a | `string` | n/a | yes |
| <a name="input_elasticsearch_access_policy_principal"></a> [elasticsearch\_access\_policy\_principal](#input\_elasticsearch\_access\_policy\_principal) | Which AWS resources should have access to the Elasticsearch cluster | `list(string)` | <pre>[<br> "*"<br>]</pre> | no |
| <a name="input_elasticsearch_access_policy_principal"></a> [elasticsearch\_access\_policy\_principal](#input\_elasticsearch\_access\_policy\_principal) | Which AWS resources should have access to the Elasticsearch cluster | `list(string)` | <pre>[<br/> "*"<br/>]</pre> | no |
| <a name="input_environment"></a> [environment](#input\_environment) | n/a | `string` | n/a | yes |
| <a name="input_es_instance_type"></a> [es\_instance\_type](#input\_es\_instance\_type) | n/a | `string` | n/a | yes |
| <a name="input_es_version"></a> [es\_version](#input\_es\_version) | n/a | `string` | n/a | yes |
Expand Down
2 changes: 1 addition & 1 deletion aws/elrond/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
| <a name="input_elrond_db_cluster_instance_identifier"></a> [elrond\_db\_cluster\_instance\_identifier](#input\_elrond\_db\_cluster\_instance\_identifier) | n/a | `string` | n/a | yes |
| <a name="input_elrond_db_cluster_instance_type"></a> [elrond\_db\_cluster\_instance\_type](#input\_elrond\_db\_cluster\_instance\_type) | n/a | `string` | `"db.serverless"` | no |
| <a name="input_elrond_enable_rds_alerting"></a> [elrond\_enable\_rds\_alerting](#input\_elrond\_enable\_rds\_alerting) | n/a | `bool` | `false` | no |
| <a name="input_elrond_enabled_cloudwatch_logs_exports"></a> [elrond\_enabled\_cloudwatch\_logs\_exports](#input\_elrond\_enabled\_cloudwatch\_logs\_exports) | n/a | `list(string)` | <pre>[<br> "postgresql"<br>]</pre> | no |
| <a name="input_elrond_enabled_cloudwatch_logs_exports"></a> [elrond\_enabled\_cloudwatch\_logs\_exports](#input\_elrond\_enabled\_cloudwatch\_logs\_exports) | n/a | `list(string)` | <pre>[<br/> "postgresql"<br/>]</pre> | no |
| <a name="input_elrond_kms_key"></a> [elrond\_kms\_key](#input\_elrond\_kms\_key) | n/a | `string` | n/a | yes |
| <a name="input_elrond_max_capacity"></a> [elrond\_max\_capacity](#input\_elrond\_max\_capacity) | n/a | `number` | `4` | no |
| <a name="input_elrond_min_capacity"></a> [elrond\_min\_capacity](#input\_elrond\_min\_capacity) | n/a | `number` | `0.5` | no |
Expand Down
Loading

0 comments on commit fffbbef

Please sign in to comment.