README.yaml

---
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#


# Name of this project
name: Terraform AZURE FLEXIBLE MYSQL

# License of this project
license: "APACHE"

# Canonical GitHub repo
github_repo: clouddrove/terraform-azure-flexible-mysql

# Badges to display
badges:
  - name: "Terraform"
    image: "https://img.shields.io/badge/Terraform-v1.1.7-green"
    url: "https://www.terraform.io"
  - name: "Licence"
    image: "https://img.shields.io/badge/License-APACHE-blue.svg"
    url: "LICENSE.md"

#  description of this project
description: |-
  Terraform module to create flexible-mysql resource on AZURE.

# extra content
include:
  - "terraform.md"

# How to use this project
# yamllint disable rule:line-length
usage: |-
  ### Simple Example
  Here is an example of how you can use this module in your inventory structure:
  ```hcl
  module "flexible-mysql" {
   source                          = "clouddrove/flexible-mysql/azure"
   name                            = "app"
   environment                     = "test"
   label_order                     = ["environment", "name"]
   resource_group_name             = module.resource_group.resource_group_name
   location                        = module.resource_group.resource_group_location
   virtual_network_id              = module.vnet.vnet_id[0]
   delegated_subnet_id             = module.subnet.default_subnet_id[0]
   mysql_version                   = "8.0.21"
   mysql_server_name               = "testmysqlserver"
   private_dns                     = true
   zone                            = "1"
   admin_username                  = "mysqlusername"
   admin_password                  = "ba5yatgfgfhdsv6A3ns2lu4gqzzc"
   sku_name                        = "GP_Standard_D8ds_v4"
   db_name                         = "maindb"
   charset                         = "utf8"
   collation                       = "utf8_unicode_ci"
   server_configuration_name       = "interactive_timeout"
   auto_grow_enabled               = true
   iops                            = 360
   size_gb                         = "20"
   }
    ```
  ##for mysql replication
    ```hcl
  module "flexible-mysql" {
   source                          = "clouddrove/flexible-mysql/azure"
   name                            = "app"
   environment                     = "test"
   label_order                     = ["environment", "name"]
   main_rg_name                    = data.azurerm_resource_group.main.name
   resource_group_name             = module.resource_group.resource_group_name
   location                        = module.resource_group.resource_group_location
   virtual_network_id              = module.vnet.vnet_id[0]
   delegated_subnet_id             = module.subnet.default_subnet_id[0]
   mysql_version                   = "8.0.21"
   mysql_server_name               = "testmysqlserver"
   zone                            = "1"
   admin_username                  = "mysqlusern"
   admin_password                  = "ba5yatgfgfhdsvvc6A3ns2lu4gqzzc"
   sku_name                        = "GP_Standard_D8ds_v4"
   db_name                         = "maindb"
   charset                         = "utf8"
   collation                       = "utf8_unicode_ci"
   server_configuration_name       = "interactive_timeout"
   auto_grow_enabled               = true
   iops                            = 360
   size_gb                         = "20"
   existing_private_dns_zone       = true
   existing_private_dns_zone_id    = data.azurerm_private_dns_zone.main.id
   existing_private_dns_zone_name  = data.azurerm_private_dns_zone.main.name
   }
    ```