General Page
Getting Started
1. Before migrating an Environment you must first have a TechZone Collection.
Note: If you don't have a Collection on TechZone, please view the instructions below:
-
To create your own collection, first review TechZone Guidance and Standards
-
Visit the How to Create a Collection Runbook for more information on how to create a collection.
-
Add Resources, view the How to Create a Resource for more information on house to create the resource. Create a resource explaining the lab guide and implement it as a Resource Document type.
-
Have the new Collection reviewed by mbawa@us.ibm.com before proceeding to step 2.
TechXchange Instructor Collection Creation Guidance
New collections to be created only for the recent TechXchange assets, are encouraged to title the collection the same name used for the session so that those that attended can easily find the assets on TechZone.
Collections should include the environment used for the TechXchange lab session and the Lab Guide as a supporting resource to accompany the environment.
Contact mbawa@us.ibm.com to review new collection before proceeding to step 2.
2. Raise a TechZone support ticket to request your Lab be Migrated to TechZone
-
Reach out to TechZone support team by opening a case to request your lab to be migrated to TechZone.
-
Provide the following details in your request:
-
The Collection name and direct URL link to the collection.
-
The Session ID.
-
DISCLAIMER: Please be aware of the following steps that are taken before the template transfer can proceed:
- ISOs associated with the source template will be unmounted.
- Snapshots associated with the source template will be deleted.
The Aspera automation that performs the template transfer tends to fail unless the above steps are taken. If this process is disruptive to your template, please communicate with Support so we can determine other available options.
3. Onboarding the Environment to a Collection
The TechZone support team will respond back with a text file and a link to the Onboarding Environment to a Collection section for you to take next steps for onboarding your environment onto TechZone.
The TechZone support team will provide you with a text file that includes Terraform Variables Overriding as follows:
```
Terraform Variables Overriding
vmtemplateid
vmtemplatefolder
vmmapstring // CONTENT AUTHOR TO UPDATE THE JSON STUB FILE PROVIDED BY TECHZONE SUPPORT
vm_subnet
vmrouterip
vm_domain ```
Follow guidance below to ensure that you copy and paste this information correctly into the environment entry.
-
Navigate to your collection and select edit:
-
Scroll down the collection edit form and locate the environment section
-
Select 'Add an environment' button
-

-
Provide a title for the environment and select IBM Cloud from the Infrastructure drop down list
-
Provide a description for the environment for users to identify what they are reserving
-
Select
vmware-templatefrom the GitOps Pattern drop down list
-
NOTE: vmware-template is for VMware only

-
Under the Settings section, follow the below steps to setup this section:
-
Select
itzvmwarefrom the dropdown menu under the Account Pool field -
Select
itzvmwarefrom the dropdown menu under the the Cloud Account field -
Select the relevant GEO, either
Americas,EuropeorAPfrom the dropdown menu under the Geo field -
Select
Any(preferred)from the dropdown menu the Region field -
Select
Any(preferred)from the dropdown menu the Data Center field
-
NOTE: Ensure that you press the "add" button, otherwise your inputted values will not be saved!


- Under the Terraform Variables Overriding section, follow the below steps to ensure each variable provided in the text file is setup correctly
-
Adding the
VMWare template IDvariableNamefield, select from the drop-down menu list 'vmware_template_id'

-
Adding the
VMWare Template Foldervariable:-
Select
vm_template_folderadd the New value and Click on the + icon -
Select
vm_map_stringfrom pulldown and add the New value and Click on the + icon
-
-
Follow guidance on how to build out map string for an image by referencing the How to Build your vm-map-string Runbook.
-
Select
vm_subnetfrom pulldown and add the New value and Click on the + icon -
Select
vm_router_ipfrom pulldown and add the New value and Click on the + icon- Select
vm_domainfrom pulldown and add the New value and Click on the + icon
- Select
-
-
Click the bottom blue Save button" to save the "Terraform Variables Overriding" for the Collection
Variable Dictionary:
Default Variables required
- Infrastructure - where to deployed. For example "IBM Cloud"
- GitOps Patterns - Provisioning instructions - Select "vmware-template"
- Account pool - Location - Select the different locations (
itzvmware), Cloud Account (itzvmware), Geo (Americas), Region (us-east), Datacenter (wdc04) vm_template_folder- parent folder name. For example "templates-shared"vm_template_id- the template folder name for the VMsvm_map_string- values for the VMs - make sure your VM Map string is correct, you can use any JSON validators like https://jsonlint.com/)vm_domain- Network domain for the VMvm_router_ip- Router for the VMvm_subnet- Subnet for the VM
Note: If you do not have custom Network requirements, use the defaults values below for the Network details:
- Default
vm_domain valueisibmdte.net - Default
vm_router_ipvalue is10.0.0.254 - Default
vm_subnet valueis10.0.0.0/24
Example of a vm_map_string ``` { "GKLM41-20230105": { "ip": "10.0.0.1", "hostname": "host-1", "stage": 1 } }
"GKLM41-20230105" // Template file name "ip": "10.0.0.1" // IP address for the VM
"hostname": "host-1" // Hostname for the VM
"stage": 1 // create and launch first (order to create a VM which has no dependency) "stage": 2 // Optional if have more than 1 VM and there are dependencies: create and launch second (create after stage 1 has been created - dependent on stage 1 creation) "stage": 3 // Optional if have more than 1 VM and there are dependencies: create and launch third (create after stage 2 has been created - dependent on stage 2 creation) ``` Published Services Variables
- If adding ports to be exposed as publish services, add port variable to the vmmapstring which can be found in the VMwarePublishedServices Runbook.
Was this topic helpful?
Document Information
Modified date:
21 October 2025
UID
ibm17159476