From 4bad84b4cea237c4d4030c8039be0f1b30f5f1d6 Mon Sep 17 00:00:00 2001
From: shemau <shemau@gmail.com>
Date: Fri, 16 May 2025 21:26:09 +0100
Subject: [PATCH] fix: comments in examples

---
 examples/backup/main.tf   |  5 ++++-
 examples/basic/main.tf    | 12 +++++++++---
 examples/complete/main.tf |  5 ++++-
 examples/fscloud/main.tf  |  5 ++++-
 examples/pitr/main.tf     |  5 ++++-
 5 files changed, 25 insertions(+), 7 deletions(-)

diff --git a/examples/backup/main.tf b/examples/backup/main.tf
index 331e34c6..bfdf1588 100644
--- a/examples/backup/main.tf
+++ b/examples/backup/main.tf
@@ -15,7 +15,10 @@ data "ibm_database_backups" "backup_database" {
 
 # New mysql instance pointing to the backup instance
 module "restored_mysql_db" {
-  source             = "../.."
+  source = "../.."
+  # remove the above line and uncomment the below 2 lines to consume the module from the registry
+  # source            = "terraform-ibm-modules/icd-mysql/ibm"
+  # version           = "X.Y.Z" # Replace "X.Y.Z" with a release version to lock into a specific release
   resource_group_id  = module.resource_group.resource_group_id
   name               = "${var.prefix}-mysql-restored"
   mysql_version      = var.mysql_version
diff --git a/examples/basic/main.tf b/examples/basic/main.tf
index 3a704f6a..3d2cce0d 100644
--- a/examples/basic/main.tf
+++ b/examples/basic/main.tf
@@ -15,7 +15,10 @@ module "resource_group" {
 ##############################################################################
 
 module "database" {
-  source             = "../.."
+  source = "../.."
+  # remove the above line and uncomment the below 2 lines to consume the module from the registry
+  # source            = "terraform-ibm-modules/icd-mysql/ibm"
+  # version           = "X.Y.Z" # Replace "X.Y.Z" with a release version to lock into a specific release
   resource_group_id  = module.resource_group.resource_group_id
   name               = "${var.prefix}-mysql"
   mysql_version      = var.mysql_version
@@ -51,8 +54,11 @@ resource "time_sleep" "wait_time" {
 ##############################################################################
 
 module "read_only_replica_mysql_db" {
-  count             = var.read_only_replicas_count
-  source            = "../.."
+  count  = var.read_only_replicas_count
+  source = "../.."
+  # remove the above line and uncomment the below 2 lines to consume the module from the registry
+  # source            = "terraform-ibm-modules/icd-mysql/ibm"
+  # version           = "X.Y.Z" # Replace "X.Y.Z" with a release version to lock into a specific release
   resource_group_id = module.resource_group.resource_group_id
   name              = "${var.prefix}-read-only-replica-${count.index}"
   region            = var.region
diff --git a/examples/complete/main.tf b/examples/complete/main.tf
index 68311194..8f4a70d0 100644
--- a/examples/complete/main.tf
+++ b/examples/complete/main.tf
@@ -102,7 +102,10 @@ module "cbr_zone" {
 ##############################################################################
 
 module "mysql_db" {
-  source            = "../../"
+  source = "../../"
+  # remove the above line and uncomment the below 2 lines to consume the module from the registry
+  # source            = "terraform-ibm-modules/icd-mysql/ibm"
+  # version           = "X.Y.Z" # Replace "X.Y.Z" with a release version to lock into a specific release
   resource_group_id = module.resource_group.resource_group_id
   name              = "${var.prefix}-mysql"
   region            = var.region
diff --git a/examples/fscloud/main.tf b/examples/fscloud/main.tf
index 41a75120..ee6f5938 100644
--- a/examples/fscloud/main.tf
+++ b/examples/fscloud/main.tf
@@ -54,7 +54,10 @@ module "cbr_zone" {
 ##############################################################################
 
 module "mysql" {
-  source                    = "../../modules/fscloud"
+  source = "../../modules/fscloud"
+  # remove the above line and uncomment the below 2 lines to consume the module from the registry
+  # source            = "terraform-ibm-modules/icd-mysql/ibm//modules/fscloud"
+  # version           = "X.Y.Z" # Replace "X.Y.Z" with a release version to lock into a specific release
   resource_group_id         = module.resource_group.resource_group_id
   name                      = "${var.prefix}-mysql"
   region                    = var.region
diff --git a/examples/pitr/main.tf b/examples/pitr/main.tf
index f46796ad..fdf56250 100644
--- a/examples/pitr/main.tf
+++ b/examples/pitr/main.tf
@@ -12,7 +12,10 @@ module "resource_group" {
 
 # New ICD mysql database instance pointing to a PITR time
 module "mysql_db_pitr" {
-  source             = "../.."
+  source = "../.."
+  # remove the above line and uncomment the below 2 lines to consume the module from the registry
+  # source            = "terraform-ibm-modules/icd-mysql/ibm"
+  # version           = "X.Y.Z" # Replace "X.Y.Z" with a release version to lock into a specific release
   resource_group_id  = module.resource_group.resource_group_id
   name               = "${var.prefix}-mysql-pitr"
   region             = var.region