Configure ServiceNow Service Graph Connector for Terraform Cloud

The ServiceNow Service Graph Connector for Terraform lets you import cloud infrastructure resources managed by Terraform Cloud or Terraform Enterprise into your ServiceNow Configuration Management Database (CMDB), so you can maintain a clean, complete system of record of your resources and services. Terraform is an infrastructure-as-code tool that lets teams safely and reliably provision and maintain cloud infrastructure. By connecting Terraform to ServiceNow, you can manage and search for your Terraform-allocated resources alongside the rest of your company's infrastructure.

In this tutorial you will provision a cloud resource with Terraform Cloud, configure the Service Graph Connector for Terraform, and import the resource into the ServiceNow CMDB.

Prerequisites

This tutorial assumes that you are familiar with the Terraform and Terraform Cloud workflows. If you are new to Terraform, complete the Get Started collection first. If you are new to Terraform Cloud, complete the Terraform Cloud Get Started tutorials first.

For this tutorial, you will need:

• Terraform v1.3+ installed locally.
• An AWS account.
• A Terraform Cloud or Terraform Enterprise account and organization.
• A Terraform Cloud variable set configured with your AWS credentials.
• A ServiceNow instance of version "San Diego" or newer and an account with admin or x_hashi_service_gr.terraform_user access.

If you do not already have a ServiceNow instance, or do not have administrator access, create a developer instance for free using ServiceNow Developer.

Create and scope Terraform API token

In order for ServiceNow to interact with Terraform Cloud, you must give it a Terraform Cloud API token. The permissions of this token determine what resources the service graph connector will import into the CMDB. While you could use a user API token, it could import resources from multiple organizations. By providing a team API token, you can scope permissions to only import resources from specified workspaces within a single organization.

Visit your organization’s Settings > Teams page. Scroll down to the Team API Token section and click Create a team token. Save this token in a safe place; Terraform Cloud only displays it once. You will use it to configure ServiceNow later in this tutorial.

Configure Service Graph Connector for Terraform API token

In the top navigation of your ServiceNow instance's control panel, click on All, search for Service Graph Connector for Terraform, and click Setup. Next, click Get Started.

Next, in the Configure the Terraform connection section, click Get Started.

In the Configure Terraform authentication credentials section, click Configure. Set the API Key to the Terraform Cloud team API token that you created earlier in this tutorial and click Update.

In the Configure Terraform authentication credentials section, click Mark as Complete.

Configure Terraform connection

By default, the Service Graph Connector is configured to connect to Terraform Cloud. If you are using Terraform Enterprise, complete the following steps to connect to your Terraform Enterprise server. If you are using Terraform Cloud, skip this section and proceed to the next section.

In the Configure Terraform connection section, click Configure.

Set the Connection URL to the URL of your Terraform Enterprise instance and click Update.

In the Configure Terraform connection section, click Mark as Complete.

Enable ServiceNow webhook

In the top navigation, click on All, search for Scheduled Imports, and click on Scheduled Imports.

Select the SG-Terraform Scheduled Process State record, then click To edit this record click To edit the record click here.

Click the Active checkbox to enable it, then click Update.

Create workspace and webhook

Clone the example configuration for this tutorial.

$ git clone https://github.com/hashicorp/learn-terraform-snow-sgc.git

Change into the repository directory.

$ cd learn-terraform-snow-sgc

Open the main.tf file in your code editor to review it. It contains the following resources:

• The AWS Terraform provider
• An EC2 instance of size t2.micro
• The AMI that the EC2 instance will use
• An output that will provide the instance ID

Set your Terraform Cloud organization name as an environment variable.

$ export TF_CLOUD_ORGANIZATION=

Initialize your configuration. As part of initialization, Terraform creates a workspace titled learn-terraform-snow-sgc.

$ terraform init

Initializing Terraform Cloud...

Initializing provider plugins...
- Finding hashicorp/aws versions matching "~> 4.45"...
- Installing hashicorp/aws v4.45.0...
- Installed hashicorp/aws v4.45.0 (signed by HashiCorp)

Terraform has created a lock file .terraform.lock.hcl to record the provider
selections it made above. Include this file in your version control repository
so that Terraform can guarantee to make the same selections by default when
you run "terraform init" in the future.

Terraform Cloud has been successfully initialized!

You may now begin working with Terraform Cloud. Try running "terraform plan" to
see any changes that are required for your infrastructure.

If you ever set or change modules or Terraform Settings, run "terraform init"
again to reinitialize your working directory.

Next, create the webhook in Terraform Cloud. Navigate to the learn-terraform-snow-sgc workspace and click Settings > Notifications. Click Create a Notification.

Keep the Destination as the default option of Webhook. Choose a descriptive name Name.

For the Webhook URL enter https://<SERVICENOW_HOSTNAME>/api/x_hashi_service_gr/sg_terraform_webhook and replace <SERVICENOW_HOSTNAME> with the hostname of your ServiceNow instance.

Under Triggers choose Only certain events and enable notifications only on Completed runs. Click Create Notification.

Apply configuration

Now in your terminal apply your Terraform configuration. When prompted, type yes to confirm the operation.

$ terraform apply
Running apply in Terraform Cloud. Output will stream here. Pressing Ctrl-C
will cancel the remote apply if it's still pending. If the apply started it
will stop streaming the logs, but will not stop the apply running remotely.

Preparing the remote apply...

To view this run in a browser, visit:
https://app.terraform.io/app/hashicorp-training/learn-terraform-snow-sgc/runs/run-abc123

Waiting for the plan to start...

Terraform v1.3.6
on linux_amd64
Initializing plugins and modules...
data.aws_ami.instance_ami: Reading...
data.aws_ami.instance_ami: Read complete after 0s [id=ami-0a05040be81434d40]

Terraform used the selected providers to generate the following execution
plan. Resource actions are indicated with the following symbols:
  + create

Terraform will perform the following actions:

  # aws_instance.app_server will be created
  + resource "aws_instance" "app_server" {
    + ami                               = "ami-0a05040be81434d40"
##…

Plan: 1 to add, 0 to change, 0 to destroy.

Changes to Outputs:
  + instance_id     = (known after apply)

Do you want to perform these actions in workspace "learn-terraform-snow-sgc"?
  Terraform will perform the actions described above.
  Only 'yes' will be accepted to approve.

  Enter a value: yes

##...

Apply complete! Resources: 1 added, 0 changed, 0 destroyed.

Outputs:

instance_id = "i-00efdcec697539585"

The instance_id output lets you identify your instance in ServiceNow.

View resources in ServiceNow

In the top navigation of ServiceNow, click on All and search for CMDB Workspace, and click on CMDB Workspace.

Perform a Configuration Item (CI) search by selecting Virtual Machine Instance under Class and clicking Search

A few minutes after applying your Terraform configuration, you should see an entry for an instance with an ID that matches the Terraform output from the beginning of this tutorial.

Clean up infrastructure

Destroy the resources that you created in this tutorial. When prompted, type yes to confirm the operation.

$ terraform destroy
##...

Terraform used the selected providers to generate the following execution
plan. Resource actions are indicated with the following symbols:
  - destroy

Terraform will perform the following actions:
##...
Plan: 0 to add, 0 to change, 1 to destroy.

Changes to Outputs:
  - instance_id = "i-00efdcec697539585" -> null

Do you really want to destroy all resources in workspace "learn-terraform-snow-sgc"?
  Terraform will destroy all your managed infrastructure, as shown above.
  There is no undo. Only 'yes' will be accepted to confirm.


  Enter a value: yes
##...
Apply complete! Resources: 0 added, 0 changed, 1 destroyed.

Optionally, delete your learn-terraform-snow-sgc workspace in your Terraform organization.

The Service Graph Connector automatically marks the deleted EC2 instance as Non-Operational in the ServiceNow CMDB.

Next steps

In this tutorial, you installed and configured the ServiceNow Service Graph Connector for Terraform and imported Terraform-managed resources into the ServiceNow CMDB. To learn more about how you can use Terraform Cloud or Terraform Enterprise to build and manage your infrastructure, check out the following resources:

• Learn more about Terraform Enterprise.
• Learn how to deploy resources with Terraform in ServiceNow with the Terraform ServiceNow Service Catalog Integration.
• Read about ServiceNow Service Graph Connectors.
• Read about the ServiceNow Configuration Management Database.