Merge pull request #2 from nick-mathison/2025-tf-example-updates

adding Nick's example changes

Author: Uddipaan-Hazarika

examples/full_stack_deployment/README.md

@@ -0,0 +1,5 @@
+This file show cases how to provision a full stack of deployment including an Azure VM, add the environment Delphix, ingest an Oracle dSource, and provision 1 VDB. 
+
+This is a great example of disaster recovery scenarios or showcasing the full power of Delphix.
+
+Note: This example will not work out of the box, by default, as you might not have the same Oracle configuration and the Azure VM is half implementated. Consult the comments within the file for further direction.

examples/full_stack_deployment/main.tf

@@ -0,0 +1,118 @@
+/**
+* Summary: This template showcases a mock example to 
+* 1) Provision an Azure VM.
+* 2) Create a Target environment from that VM.
+* 3) Link and Sync a dSource. Create a new snapshot.
+* 4) Provision a new VDB from that Oracle dSource's snapshot.
+* *** Warning: This is only an example. It will not work out of the box.***
+*/
+
+terraform {
+  required_providers {
+    delphix = {
+      version = ">=3.3.2"
+      source  = "delphix-integrations/delphix"
+    }
+    azurerm = {
+      source  = "hashicorp/azurerm"
+      version = "~>3.0"
+    }
+  }
+}
+
+# *** Requirement***: Various variables used throughout the example.
+locals {
+  dct-key           = "<1.XXXX>"
+  dct-host          = "<DCT HOSTNAME>"
+  vm-hostname       = "oracle-linux-host"
+  vm-username       = "<USERNAME>"
+  vm-password       = "<PASSWORD>"
+  source-db-name    = "<SOURCE DATABASE NAME>" // Name of Database dynamically identified on the source environment
+  dsource-name      = "full_deploy_dsource"
+  vdb-name          = "full_deploy_vdb"
+}
+
+provider "delphix" {
+  tls_insecure_skip = true
+  key               = local.dct-key
+  host              = loca.dct-host
+}
+
+
+# *** Requirement ***: This is an example only and will not work without significant modification and additional files.
+# See the official documentation here for a full VM deployment: https://learn.microsoft.com/en-us/azure/virtual-machines/linux/quick-create-terraform
+# The VM creation terraform resource can be replaced with an equivalent resource GCP, AWS, VMWare, etc that's compatible with Delphix Continuous Data.
+# Consult your organization's DevOps expert for guidance on how to provision a VM that's approved for your company.
+resource "azurerm_linux_virtual_machine" "azure_vm" {
+  name                  = "Delphix Oracle Target"
+  location              = azurerm_resource_group.rg.location // Not provided
+  resource_group_name   = azurerm_resource_group.rg.name // Not provided
+  network_interface_ids = [azurerm_network_interface.my_terraform_nic.id] // Not provided
+  size                  = "Standard_DS1_v2"
+
+  os_disk {
+    name                 = "myOsDisk"
+    caching              = "ReadWrite"
+    storage_account_type = "Premium_LRS"
+  }
+
+  source_image_reference {
+    publisher = "Canonical"
+    offer     = "0001-com-ubuntu-server-jammy"
+    sku       = "22_04-lts-gen2"
+    version   = "latest"
+  }
+
+  computer_name  = local.vm-hostname
+  admin_username = local.vm-username
+  admin_password = local.vm-password // Not secure. Example only
+
+  boot_diagnostics {
+    storage_account_uri = azurerm_storage_account.my_storage_account.primary_blob_endpoint // Not provided
+  }
+}
+
+# Add the Azure VM as a Delphix environment.
+# Docs: https://registry.terraform.io/providers/delphix-integrations/delphix/latest/docs/resources/environment
+resource "delphix_environment" "linux-oracle-target" {
+     name = local.vm-hostname
+     os_name = "UNIX"
+     hostname = local.vm-hostname
+     username = local.vm-username
+     password = local.vm-password
+     engine_id = 1
+     toolkit_path = "/home/delphix_os/toolkit"
+     description = "This is a unix target for the Oracle VDB."     
+ } 
+
+
+# If we were ingesting a PostgreSQL (or AppData) database, we would need to configure a Source Config (Source) 
+# resource "delphix_database_postgresql" "postgresql_source_config" {
+#   name             = local.source-db-name + "source config"
+#   repository_value = "PostgreSQL Repo"
+#   engine_value = "1"
+#   environment_value = local.vm-hostname
+# }
+
+# Link and Sync the dSource and take a new snapshot
+# *** Requirement *** This is an Oracle dSource. Updates are likely required.
+# Docs: https://registry.terraform.io/providers/delphix-integrations/delphix/latest/docs/resources/oracle_dsource
+resource "delphix_oracle_dsource" "full_oracle_dsource" {
+  name                       = local.dsource-name
+  source_value               = local.source-db-name
+  group_id                   = "full_deployment_group"
+  environment_user_id        = local.vm-username
+  log_sync_enabled           = false
+  link_now                   = true
+  make_current_account_owner = true
+}
+
+
+# Provision by Snapshot the 1 Oracle VDB on the newly created environment
+# Docs: https://registry.terraform.io/providers/delphix-integrations/delphix/latest/docs/resources/vdb
+resource "delphix_vdb" "vdb_provision_loop" {
+  name                   = local.vdb-name
+  source_data_id         = local.dsource-name
+  environment_id         = local.vm-hostname
+  auto_select_repository = true
+}

examples/jenkins-integration/Readme.md renamed to examples/jenkins_integration/Readme.md

@@ -2,7 +2,7 @@ terraform {
   required_providers {
     delphix = {
       source  = "delphix-integrations/delphix"
-      version = "3.1.0"
+      version = ">=3.1.0"
     }
   }
 }

examples/jenkins-integration/jenkinsfile renamed to examples/jenkins_integration/jenkinsfile

@@ -1,7 +1,7 @@
 terraform {
   required_providers {
     delphix = {
-      version = "1.0-beta"
+      version = ">=3.3.2"
       source  = "delphix.com/dct/delphix"
     }
   }

examples/simple-provision/versions.tf

@@ -18,7 +18,7 @@ provider "delphix" {
 }
 
 resource "delphix_vdb" "example" {
-  bookmark_id             = ""
+  bookmark_id             = "bookmark_name"
   name                    = "vdb_to_be_created"
   source_data_id          = "dsource-name"
   vdb_restart             = true

examples/vdb/main.tf

@@ -1,42 +1,50 @@
 /**
-* Summary: This template showcases the properties available when creating an app data dsource.
+* Summary: This template showcases a simple example to 
+* 1) Set local VDB variables
+* 2) Provision 5 VDBs using a for_each loop
+* 3) Place the 5 VDBs into a single VDB Group using a for loop
 */
 
 terraform {
   required_providers {
     delphix = {
-      version = "VERSION"
+      version = ">=3.3.2"
       source  = "delphix-integrations/delphix"
     }
   }
 }
 
+// *** Requirement***: Update the key and host with valid credentials.
 provider "delphix" {
   tls_insecure_skip = true
   key               = "1.XXXX"
   host              = "HOSTNAME"
 }
 
 
+// Create variables for the VDBs.
+// *** Requirement***: Update the Snapshot ID with a valid Snapshot. The same snapshot can be reused.
 locals {
   vdbs = {
+    "vdb1" = { snapshot_id = "6-ORACLE_DB_CONTAINER-7",  name = "us1" },
+    "vdb2" = { snapshot_id = "6-ORACLE_DB_CONTAINER-1",  name = "us2" },
+    "vdb3" = { snapshot_id = "6-ORACLE_DB_CONTAINER-5",  name = "us3" },
     "vdb4" = { snapshot_id = "6-ORACLE_DB_CONTAINER-21", name = "us4" },
-    "vdb5" = { snapshot_id = "6-ORACLE_DB_CONTAINER-23", name = "us5" },
-    "vdb1" = { snapshot_id = "6-ORACLE_DB_CONTAINER-7", name = "us1" },
-    "vdb2" = { snapshot_id = "6-ORACLE_DB_CONTAINER-1", name = "us2" },
-    "vdb3" = { snapshot_id = "6-ORACLE_DB_CONTAINER-5", name = "us3" }
+    "vdb5" = { snapshot_id = "6-ORACLE_DB_CONTAINER-23", name = "us5" }
   }
 }
 
-resource "delphix_vdb" "example" {
+// Provision by Snapshot the 5 VDBs in a loop.
+// Instead of a for_each loop, you could optionally copy this resource 4 more times and replace the values directly.
+resource "delphix_vdb" "vdb_provision_loop" {
   for_each               = try(local.vdbs, {})
   name                   = each.value.name
   source_data_id         = each.value.snapshot_id
   auto_select_repository = true
 
 }
-
-#sort helps to maintain thr order of the vdbs to avoid erroneous drift
+// Place the 5 VDBs in a single VDB Group.
+// The sort() function helps to maintain the order of the vdbs to avoid erroneous drift.
 resource "delphix_vdb_group" "this" {
   name    = "random"
   vdb_ids = sort(flatten([for vdb in delphix_vdb.example : vdb.id]))