updated readme

Author: Ad-squareops

IAM.md

@@ -82,4 +82,4 @@ permissions = [
     "resourcemanager.projects.getIamPolicy",
     "resourcemanager.projects.setIamPolicy"
   ]
-```
+```

README.md

@@ -38,52 +38,48 @@ module "aws" {
 }
 
 module "mysql" {
-  source = "squareops/mysql/kubernetes"
+  source           = "squareops/mysql/kubernetes/"
+  create_namespace = local.create_namespace
+  namespace        = local.namespace
   mysqldb_config = {
-    name                             = "mysql"
-    values_yaml                      = ""
-    environment                      = "prod"
+    name                             = local.name
+    values_yaml                      = file("./helm/values.yaml")
+    app_version                      = "8.0.29-debian-11-r9"
+    environment                      = local.environment
     architecture                     = "replication"
-    storage_class_name               = "gp3"
-    custom_user_username             = "admin"
+    custom_database                  = "test_db"
+    storage_class_name               = "gp2"
+    custom_user_username             = local.mysqldb_custom_credentials_enabled ? "" : local.custom_user_username
     primary_db_volume_size           = "10Gi"
     secondary_db_volume_size         = "10Gi"
     secondary_db_replica_count       = 2
-    store_password_to_secret_manager = true
+    store_password_to_secret_manager = local.store_password_to_secret_manager
   }
-  mysqldb_custom_credentials_enabled = true
-  mysqldb_custom_credentials_config  = {
-    root_user            = "root"
-    root_password        = "RJDRIFsYC8ZS1WQuV0ps"
-    custom_username      = "admin"
-    custom_user_password = "NCPFUKEMd7rrWuvMAa73"
-    replication_user     = "replicator"
-    replication_password = "nvAHhm1uGQNYWVw6ZyAH"
-    exporter_user        = "mysqld_exporter"
-    exporter_password    = "ZawhvpueAehRdKFlbjaq"
-  }
-  root_password                      = mysqldb_custom_credentials_enabled ? "" : module.aws.root_password
-  metric_exporter_pasword            = mysqldb_custom_credentials_enabled ? "" : module.aws.metric_exporter_pasword
-  mysqldb_replication_user_password  = mysqldb_custom_credentials_enabled ? "" : module.aws.mysqldb_replication_user_password
-  custom_user_password               = mysqldb_custom_credentials_enabled ? "" : module.aws.custom_user_password
+  mysqldb_custom_credentials_enabled = local.mysqldb_custom_credentials_enabled
+  mysqldb_custom_credentials_config  = local.mysqldb_custom_credentials_config
+  root_password                      = local.mysqldb_custom_credentials_enabled ? "" : module.aws.root_password
+  metric_exporter_pasword            = local.mysqldb_custom_credentials_enabled ? "" : module.aws.metric_exporter_pasword
+  mysqldb_replication_user_password  = local.mysqldb_custom_credentials_enabled ? "" : module.aws.mysqldb_replication_user_password
+  custom_user_password               = local.mysqldb_custom_credentials_enabled ? "" : module.aws.custom_user_password
   bucket_provider_type               = "s3"
   iam_role_arn_backup                = module.aws.iam_role_arn_backup
   mysqldb_backup_enabled             = true
   mysqldb_backup_config = {
-    bucket_uri           = "backup-bucket-uri"
-    s3_bucket_region     = "backup-bucket-region"
-    cron_for_full_backup = "* */12 * * *"
+    bucket_uri           = "s3://bucket_name"
+    s3_bucket_region     = ""
+    cron_for_full_backup = "*/5 * * * *"
   }
   mysqldb_restore_enabled = true
   iam_role_arn_restore    = module.aws.iam_role_arn_restore
   mysqldb_restore_config = {
-    bucket_uri       = "restore-bucket-uri/restore-file-name"
-    file_name        = "restore-file-name"
-    s3_bucket_region = "restore-bucket-region"
+    bucket_uri       = "s3://bucket_name/mysqldump_20230710_120501.zip"
+    file_name        = "mysqldump_20230710_120501.zip"
+    s3_bucket_region = ""
   }
   mysqldb_exporter_enabled = true
 }
 
+
 ```
 - Refer [AWS examples](https://github.com/squareops/terraform-kubernetes-mysql/tree/main/examples/complete/aws) for more details.
 - Refer [Azure examples](https://github.com/squareops/terraform-kubernetes-mysql/tree/main/examples/complete/azure) for more details.

examples/complete/aws/main.tf

@@ -7,8 +7,8 @@ locals {
     Expires    = "Never"
     Department = "Engineering"
   }
-  create_namespace                   = false
-  namespace                          = ""
+  create_namespace                   = true
+  namespace                          = "mysql"
   store_password_to_secret_manager   = false
   mysqldb_custom_credentials_enabled = true
   mysqldb_custom_credentials_config = {

examples/complete/azure/helm/values.yaml

@@ -18,4 +18,4 @@ secondary:
                     - key: "Addons-Services"
                       operator: In
                       values:
-                      - "true"
+                      - "true"

examples/complete/azure/main.tf

@@ -45,7 +45,7 @@ module "mysql" {
   source           = "squareops/mysql/kubernetes"
   create_namespace = local.create_namespace
   namespace        = local.namespace
-  mysqldb_config   = {
+  mysqldb_config = {
     name                             = local.name
     values_yaml                      = file("./helm/values.yaml")
     environment                      = local.environment

examples/complete/azure/outputs.tf

@@ -6,4 +6,4 @@ output "mysql_endpoints" {
 output "mysql_credential" {
   value       = local.store_password_to_secret_manager ? null : module.mysql.mysqldb_credential
   description = "MySQL credentials used for accessing the MySQL database."
-}
+}

examples/complete/gcp/main.tf

@@ -39,7 +39,7 @@ module "mysql" {
   source           = "squareops/mysql/kubernetes"
   create_namespace = local.create_namespace
   namespace        = local.namespace
-  mysqldb_config   = {
+  mysqldb_config = {
     name                             = local.name
     values_yaml                      = file("./helm/values.yaml")
     environment                      = local.environment

modules/resources/azure/main.tf

@@ -54,7 +54,7 @@ resource "azurerm_key_vault" "mysql-secret" {
 }
 
 resource "azurerm_key_vault_secret" "mysql-secret" {
-  count  = var.store_password_to_secret_manager ? 1 : 0
+  count      = var.store_password_to_secret_manager ? 1 : 0
   depends_on = [azurerm_key_vault.mysql-secret[0]]
   name       = format("%s-%s-%s", var.environment, var.name, "secret")
   value = var.mysqldb_custom_credentials_enabled ? jsonencode(

modules/resources/azure/outputs.tf

@@ -16,4 +16,4 @@ output "mysqldb_replication_user_password" {
 output "custom_user_password" {
   value       = var.mysqldb_custom_credentials_enabled ? null : nonsensitive(random_password.mysqldb_custom_user_password[0].result)
   description = "custom user's password of mysqldb"
-}
+}

modules/resources/azure/variables.tf

@@ -69,4 +69,4 @@ variable "custom_user_username" {
 variable "storage_account_name" {
   type    = string
   default = ""
-}
+}