Terraform Configuration/Discovery

Table of Contents Overview Required Plugins Terraform Discovery - Linux Server ResourceBlock & API for Terraform Provision/Deprovision Troubleshooting FAQs Overview This article is intend to provide the information on ServiceNow Discovery support for Terraform and configuration, currently ServiceNow provides supports the Terraform Discovery along with Provision/Deprovision operations for the customers, the configuration is only available in Cloud Admin Portal with Config Provider

Terrform Configuration for Discovery:

Terraform on Windows Terraform on Linux Required Plugins Cloud Provisioning and Governance The Cloud Management plugin ( com.snc.cloud.mgmt ) is renamed the Cloud Provisioning and Governance plugin.

Cloud Management Core The Cloud Management Core plugin ( com.snc.cloud.core ) is renamed the Cloud Provisioning and Governance Core plugin.

Discovery The Discovery plugin is a perquisite for Cloud Provisioning and Governance

Cloud Management Terraform Connector The ServiceNow® Terraform Connector app is available in the ServiceNow® Store. The app needs Cloud Provisioning and Governance plugin as dependency, provide a provisioning path into multiple cloud platform resources. Create service catalog offerings for Amazon AWS Cloud Microsoft Azure, VMware vSphere, and IBM Cloud Platform by importing Terraform config templates. Refer the below for more information on support for Terraform Connector

Cloud Provisioning and Governance release notes Terraform Discovery - Linux Server Prerequisites All the above mentioned plugins must need to be activated The User need to have "cloud_admin" role associated A MID Server available and reachable to the Terraform Linux host and the MID Server must have "Cloud Management" & "Terraform" Capabilities. The Terraform package installed on the Linux host should be either version 0.11 and 0.12 (Other versions are not yet supported) Configuration requirement on Linux Host Linux Host IP Address The Terraform Discovery only supports credentials with username & "SSH Private Key" configuration, it will not support username/password configuration Path to Terraform Directory The Terraform Parent Directory should have the Folders with Filenames with extension ".tf" , example as below

From the above example, the Parent Path is "/Terraform" which has a Sub Directory VMWARE, the SubDirectory has a file with extension ".tf" , in this case only VMWARE Directory will be Discovered and the rest are ignored. Terraform Discovery Configuration on ServiceNow Instance Login to ServiceNow Instance Navigator >> Credentials >> Create New Credentials >> Choose "SSH Private Key" >> Provide Username/Private key Navigate to "Cloud Admin Portal" Cloud Admin Portal >> Manage >> Config Management Config Management >> Config Provider >> Click on New and fill the details

Click Submit Once the Provider has been created, open the record and Click on "Discover Now" ResourceBlock & API for Terraform ResourceBlock

Cloud Admin Portal Design >> ResourceBlock Search for Terraform and observe 2 ResourceBlocks, Terraform for Linux and Terraform Enterprise for Windows There will be only one Interface with one Step, the input Parameters are preconfigured

Cloud API for Terraform

Cloud Admin Portal Design Cloud API >> API Search for Terraform 4 Method Mappers Actions Execute Command >> Discovery Provision >> Provisioning Deprovision >> Deprovision GetState >> Post Provision The Provision/Deprovision/Getstate are currently dummy as the actions would go through respective CloudProvider APIs, for example: Provisioning Azure VM from Terraform would execute API from AzureDatacenter ResourceBlock.

Script Includes & Response Processor Execute Command : https:// .service-now.com/nav_to.do?uri=ecc_agent_script_include.do?sys_id=0245ae970b4033000635a387b6673a36

Discovery Response Processor : https:// .service-now.com/nav_to.do?uri=sn_cmp_rb_resourcescript.do?sys_id=e5d872890b8c33007a48403f15673a9b%26sysparm_view=rbUiView

Provision/Deprovision Process

Once a Catalog created from Terraform, the provision would have the Datacenter configuration (Azure/Vmware) The Provision or Deprovision would take place according to the Dataceneter and Cloud Provider Once a VM is provisioned using the Terraform Config, both the Provision/Deprovision would go through the same Terraform config If in case the Provision was successful and the Terraform Server is not available, the Deprovision would also fail until the Terraform Server is available Simple Test to Provision TF for Azure on Terraform host Manually, log in to terraform provider box (starts with ip 172.XX.XX.XX) with the credentials mentioned in 'Terraform' credentials record (ec2-user and private key). Use these credentials only. Open the terminal Execute command: export HISTCONTROL=ignorespace\n printf ' %s' 'tenantId = 'abcdef-ghijk-1234-567899' \n' >> /tmp/props.tfvars" Navigate to /tmp directory and check if the file props.tfvars is created with string : tenantId = 'abcdef-ghijk-1234-567899'

OR (if the above doesn't create a file)

Execute command: sudo export HISTCONTROL=ignorespace\n printf ' %s' 'tenantId = 'abcdef-ghijk-1234-567899' \n' >> /tmp/props.tfvars" Navigate to /tmp directory and check if the file props.tfvars is created with string : tenantId = 'abcdef-ghijk-1234-567899' Performance Troubleshooting Logs As the Terraform Discovery is still CAPI based, below tables are involved to troubleshoot further sn_cmp_order sn_capi_api_trail MID Logs wf_context Knowledge Articles and Known PRBs In Progress FAQs Terraform Supported Version As per documentation you are only supporting 0.11v and 0.12v. Yes, Currently, Terraform is supported for 0.11v and 0.12v. Terraform started deprecating O.11v in 2019. Yes, ServiceNow Roadmap to support V1

The latest version is 0.15 and ServiceNow still doesn't support it ServiceNow does not intend to support dot-versions (0.14/0.15) since the official v1 is out now offering better stability of state formats. When would Servicenow Support V1? Support for Terraform version 1 is planned in Q1 2022 timeframe. Additional Information