Align to coding conventions (#56)

osinfra-io · Sep 15, 2024 · 0165e11 · 0165e11
1 parent cd1f1fa
commit 0165e11
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 31 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -11,7 +11,7 @@ repos:
       - id: check-symlinks
 
   - repo: https://github.com/antonbabenko/pre-commit-terraform
-    rev: v1.92.1
+    rev: v1.95.0
     hooks:
       - id: terraform_fmt
 
@@ -29,7 +29,7 @@ repos:
       - id: terraform_docs
 
   - repo: https://github.com/bridgecrewio/checkov.git
-    rev: 3.2.219
+    rev: 3.2.254
     hooks:
       - id: checkov
         verbose: true

diff --git a/README.md b/README.md
@@ -71,7 +71,7 @@ terraform test
 
 > A child module automatically inherits default (un-aliased) provider configurations from its parent. The provider versions below are informational only and do **not** need to align with the provider configurations from its parent.
 
-<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+<!-- BEGIN_TF_DOCS -->
 ## Requirements
 
 No requirements.
@@ -95,7 +95,7 @@ No inputs.
 ## Outputs
 
 No outputs.
-<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+<!-- END_TF_DOCS -->
 
 ## 📓 Terraform Regional Documentation
 

diff --git a/regional/README.md b/regional/README.md
@@ -2,7 +2,7 @@
 
 A child module automatically inherits its parent's default (un-aliased) provider configurations. The provider versions below are informational only and do **not** need to align with the provider configurations from its parent.
 
-<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+<!-- BEGIN_TF_DOCS -->
 ## Requirements
 
 No requirements.
@@ -11,8 +11,8 @@ No requirements.
 
 | Name | Version |
 |------|---------|
-| <a name="provider_google"></a> [google](#provider\_google) | 5.40.0 |
-| <a name="provider_random"></a> [random](#provider\_random) | 3.6.2 |
+| <a name="provider_google"></a> [google](#provider\_google) | 6.2.0 |
+| <a name="provider_random"></a> [random](#provider\_random) | 3.6.3 |
 
 ## Modules
 
@@ -58,9 +58,8 @@ No modules.
 | Name | Description |
 |------|-------------|
 | <a name="output_client_cert"></a> [client\_cert](#output\_client\_cert) | The client certificate |
+| <a name="output_instance"></a> [instance](#output\_instance) | SQL instance name |
 | <a name="output_instance_server_ca_cert"></a> [instance\_server\_ca\_cert](#output\_instance\_server\_ca\_cert) | The SQL instance server CA certificate |
 | <a name="output_private_ip_address"></a> [private\_ip\_address](#output\_private\_ip\_address) | SQL instance private IP address |
 | <a name="output_private_key"></a> [private\_key](#output\_private\_key) | The client private key |
-| <a name="output_project_id"></a> [project\_id](#output\_project\_id) | The ID of the project in which the resource belongs |
-| <a name="output_sql_instance"></a> [sql\_instance](#output\_sql\_instance) | SQL instance name |
-<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+<!-- END_TF_DOCS -->
diff --git a/regional/main.tf b/regional/main.tf
@@ -70,7 +70,6 @@ resource "google_sql_database_instance" "this" {
     user_labels = var.labels
   }
 
-
   timeouts {
     create = "60m"
     delete = "60m"

diff --git a/regional/outputs.tf b/regional/outputs.tf
@@ -1,3 +1,6 @@
+# Output Values
+# https://www.terraform.io/docs/language/values/outputs.html
+
 output "client_cert" {
   description = "The client certificate"
   value = {
@@ -12,6 +15,11 @@ output "instance_server_ca_cert" {
   sensitive   = true
 }
 
+output "private_ip_address" {
+  description = "SQL instance private IP address"
+  value       = google_sql_database_instance.this.private_ip_address
+}
+
 output "private_key" {
   description = "The client private key"
   value = {
@@ -20,17 +28,7 @@ output "private_key" {
   sensitive = true
 }
 
-output "private_ip_address" {
-  description = "SQL instance private IP address"
-  value       = google_sql_database_instance.this.private_ip_address
-}
-
-output "project_id" {
-  description = "The ID of the project in which the resource belongs"
-  value       = var.project
-}
-
-output "sql_instance" {
+output "instance" {
   description = "SQL instance name"
   value       = google_sql_database_instance.this.name
 }
diff --git a/regional/variables.tf b/regional/variables.tf
@@ -1,3 +1,6 @@
+# Input Variables
+# https://www.terraform.io/language/values/variables
+
 variable "availability_type" {
   description = "The availability type of the Cloud SQL instance"
   type        = string
@@ -16,15 +19,6 @@ variable "client_certs" {
   default     = []
 }
 
-variable "postgres_database_flags" {
-  description = "The database flags for Cloud SQL. See [PostgreSQL Flags](https://cloud.google.com/sql/docs/postgres/flags)"
-  type = list(object({
-    name  = string
-    value = string
-  }))
-  default = []
-}
-
 variable "database_version" {
   description = "The MySQL, PostgreSQL or SQL Server version to use."
   type        = string
@@ -83,6 +77,15 @@ variable "point_in_time_recovery_enabled" {
   default     = false
 }
 
+variable "postgres_database_flags" {
+  description = "The database flags for Cloud SQL. See [PostgreSQL Flags](https://cloud.google.com/sql/docs/postgres/flags)"
+  type = list(object({
+    name  = string
+    value = string
+  }))
+  default = []
+}
+
 variable "project" {
   description = "The ID of the project in which the resource belongs"
   type        = string