Merge pull request #1 from kumarvna/develop

final configuration for version 1.0.0

Author: kumarvna

README.md

@@ -0,0 +1,102 @@
+# Azure Database for PostgreSQL Terraform Module
+
+Azure Database for PostgreSQL Single Server is a fully managed database service with minimal requirements for customizations of database. The single server platform is designed to handle most of the database management functions such as patching, backups, high availability, security with minimal user configuration and control. The architecture is optimized for built-in high availability with 99.99% availability on single availability zone. It supports community version of PostgreSQL 9.5, 9,6, 10, and 11.
+
+## Module Usage
+
+```terraform
+module "postgresql-db" {
+  source  = "kumarvna/postgresql-db/azurerm"
+  version = "1.0.0"
+
+  # By default, this module will create a resource group
+  # proivde a name to use an existing resource group and set the argument 
+  # to `create_resource_group = false` if you want to existing resoruce group. 
+  # If you use existing resrouce group location will be the same as existing RG.
+  create_resource_group = false
+  resource_group_name   = "rg-shared-westeurope-01"
+  location              = "westeurope"
+
+  # PostgreSQL Server and Database settings
+  postgresql_server_name = "mypostgresdbsrv01"
+
+  postgresql_server_settings = {
+    sku_name   = "GP_Gen5_8"
+    storage_mb = 640000
+    version    = "9.6"
+    # default admin user `sqladmin` and can be specified as per the choice here
+    # by default random password created by this module. required password can be specified here
+    admin_username = "postgresadmin"
+    admin_password = "H@Sh1CoR3!"
+    # Database name, charset and collection arguments  
+    database_name = "demo-postgres-db"
+    charset       = "UTF8"
+    collation     = "English_United States.1252"
+    # Storage Profile and other optional arguments
+    auto_grow_enabled                = true
+    backup_retention_days            = 7
+    geo_redundant_backup_enabled     = true
+    public_network_access_enabled    = true
+    ssl_enforcement_enabled          = true
+    ssl_minimal_tls_version_enforced = "TLS1_2"
+  }
+
+  # PostgreSQL Server Parameters 
+  # For more information: https://bit.ly/3dbYTtB
+  postgresql_configuration = {
+    backslash_quote = "on"
+  }
+
+  # Use Virtual Network service endpoints and rules for Azure Database for PostgreSQL
+  subnet_id = var.subnet_id
+
+  # The URL to a Key Vault custom managed key
+  key_vault_key_id = var.key_vault_key_id
+
+  # To enable Azure Defender for database set `enable_threat_detection_policy` to true 
+  enable_threat_detection_policy = true
+  log_retention_days             = 30
+  email_addresses_for_alerts     = ["user@example.com", "firstname.lastname@example.com"]
+
+  # AD administrator for an Azure database for PostgreSQL
+  # Allows you to set a user or group as the AD administrator for PostgreSQL server
+  ad_admin_login_name = "firstname.lastname@example.com"
+
+  # (Optional) To enable Azure Monitoring for Azure PostgreSQL database
+  # (Optional) Specify `storage_account_name` to save monitoring logs to storage. 
+  log_analytics_workspace_name = "loganalytics-we-sharedtest2"
+
+  # Firewall Rules to allow azure and external clients and specific Ip address/ranges. 
+  firewall_rules = {
+    access-to-azure = {
+      start_ip_address = "0.0.0.0"
+      end_ip_address   = "0.0.0.0"
+    },
+    desktop-ip = {
+      start_ip_address = "49.204.228.223"
+      end_ip_address   = "49.204.228.223"
+    }
+  }
+
+  # Tags for Azure Resources
+  tags = {
+    Terraform   = "true"
+    Environment = "dev"
+    Owner       = "test-user"
+  }
+}
+```
+
+## Terraform Usage
+
+To run this example you need to execute following Terraform commands
+
+```hcl
+terraform init
+
+terraform plan
+
+terraform apply
+```
+
+Run `terraform destroy` when you don't need these resources.

examples/PostgreSQL_Server/README.md

@@ -0,0 +1,81 @@
+module "postgresql-db" {
+  //  source  = "kumarvna/postgresql-db/azurerm"
+  //  version = "1.0.0"
+  source = "../../"
+
+  # By default, this module will create a resource group
+  # proivde a name to use an existing resource group and set the argument 
+  # to `create_resource_group = false` if you want to existing resoruce group. 
+  # If you use existing resrouce group location will be the same as existing RG.
+  create_resource_group = false
+  resource_group_name   = "rg-shared-westeurope-01"
+  location              = "westeurope"
+
+  # PostgreSQL Server and Database settings
+  postgresql_server_name = "mypostgresdbsrv01"
+
+  postgresql_server_settings = {
+    sku_name   = "GP_Gen5_8"
+    storage_mb = 640000
+    version    = "9.6"
+    # default admin user `sqladmin` and can be specified as per the choice here
+    # by default random password created by this module. required password can be specified here
+    admin_username = "postgresadmin"
+    admin_password = "H@Sh1CoR3!"
+    # Database name, charset and collection arguments  
+    database_name = "demo-postgres-db"
+    charset       = "UTF8"
+    collation     = "English_United States.1252"
+    # Storage Profile and other optional arguments
+    auto_grow_enabled                = true
+    backup_retention_days            = 7
+    geo_redundant_backup_enabled     = true
+    public_network_access_enabled    = true
+    ssl_enforcement_enabled          = true
+    ssl_minimal_tls_version_enforced = "TLS1_2"
+  }
+
+  # PostgreSQL Server Parameters 
+  # For more information: https://bit.ly/3dbYTtB
+  postgresql_configuration = {
+    backslash_quote = "on"
+  }
+
+  # Use Virtual Network service endpoints and rules for Azure Database for PostgreSQL
+  subnet_id = var.subnet_id
+
+  # The URL to a Key Vault custom managed key
+  key_vault_key_id = var.key_vault_key_id
+
+  # To enable Azure Defender for database set `enable_threat_detection_policy` to true 
+  enable_threat_detection_policy = true
+  log_retention_days             = 30
+  email_addresses_for_alerts     = ["user@example.com", "firstname.lastname@example.com"]
+
+  # AD administrator for an Azure database for PostgreSQL
+  # Allows you to set a user or group as the AD administrator for PostgreSQL server
+  ad_admin_login_name = "firstname.lastname@example.com"
+
+  # (Optional) To enable Azure Monitoring for Azure PostgreSQL database
+  # (Optional) Specify `storage_account_name` to save monitoring logs to storage. 
+  log_analytics_workspace_name = "loganalytics-we-sharedtest2"
+
+  # Firewall Rules to allow azure and external clients and specific Ip address/ranges. 
+  firewall_rules = {
+    access-to-azure = {
+      start_ip_address = "0.0.0.0"
+      end_ip_address   = "0.0.0.0"
+    },
+    desktop-ip = {
+      start_ip_address = "49.204.228.223"
+      end_ip_address   = "49.204.228.223"
+    }
+  }
+
+  # Tags for Azure Resources
+  tags = {
+    Terraform   = "true"
+    Environment = "dev"
+    Owner       = "test-user"
+  }
+}

examples/PostgreSQL_Server/main.tf

@@ -0,0 +1,9 @@
+variable "key_vault_key_id" {
+  description = "The URL to a Key Vault Key"
+  default     = null
+}
+
+variable "subnet_id" {
+  description = "The resource ID of the subnet"
+  default     = null
+}