Skip to content

Commit 85c86da

Browse files
committed
ServiceNow link edits
1 parent 999e977 commit 85c86da

File tree

4 files changed

+22
-24
lines changed

4 files changed

+22
-24
lines changed

website/docs/cloud-docs/integrations/service-now/service-graph/customizations.mdx

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
page_title: Overview - ServiceNow Service Graph Connector for Terraform Integration - summary of the setup process
2+
page_title: Overview - ServiceNow Service Graph Connector for Terraform Integration - instructions on customizations for admins
33
description: >-
44
ServiceNow Service Graph Connector for Terraform allows you to edit ETL mapping and add more resources.
55
---
@@ -18,7 +18,7 @@ Any customizations should be done from the application's scope: **Service Graph
1818

1919
## Clone the ETL map
2020

21-
Navigate to the **IntegrationHub ETL** in the top menu. Check the **SG-Terraform** record and click **Duplicate**.
21+
Navigate to the **IntegrationHub ETL** in the top menu. Check the **SG-Terraform** record and click **Duplicate**. Refer to the [ServiceNow documentation](https://docs.servicenow.com/en-US/bundle/utah-servicenow-platform/page/product/configuration-management/task/duplicate-cmdb-transform-map.html) on creating a duplicate of an existing ETL transform map.
2222

2323
## Build a resource in Terraform Cloud
2424

@@ -44,25 +44,25 @@ Locate the resource in the state object. This JSON record will serve as a source
4444

4545
## Identify the CI target
4646

47-
Pick a suitable Configuration Item (CI) target for your resource. For example, AWS virtual private network (VPC) is mapped to Cloud Network (`cmdb_ci_network`) in the Service Graph Connector for Terraform. Refer to the [ServiceNow CMDB documentation](https://docs.servicenow.com/en-US/bundle/utah-servicenow-platform/page/product/configuration-management/reference/cmdb-tables-details.html) for more details on available CI tables.
47+
Pick a suitable Configuration Item (CI) target for your resource. For instance, the AWS virtual private network (VPC) resource is mapped to Cloud Network (`cmdb_ci_network`) by the Service Graph Connector for Terraform. Refer to the [ServiceNow CMDB documentation](https://docs.servicenow.com/en-US/bundle/utah-servicenow-platform/page/product/configuration-management/reference/cmdb-tables-details.html) for more details on available CI tables.
4848

4949
## Consult the CI Class Manager
5050

5151
After selecting an appropriate CI target, it is important to consult the CI Class Manager for guidance on dependent relationships. Numerous CMDB resources rely on other CI tables. If a related class is not properly mapped, the ETL job will generate errors or warnings, resulting in the failure of importing your resource into CMDB.
5252

5353
In the top navigation, click on **All**, search for **CI Class Manager**, and click on **Open Hierarchy**. Search for your target CI Class and check **Dependent Relationships** tab to learn more about dependent mappings required by the resource.
5454

55-
Example: according to the CI Class Manager, Cloud Network should be hosted on Logical Datacenter and Cloud Service Account.
55+
Example: according to the **CI Class Manager**, **Cloud Network** should be hosted on **Logical Datacenter** and **Cloud Service Account**.
5656

5757
## Set the mapping rules
5858

59-
Open the **IntegrationHub ETL** from the top navigation menu and select your cloned ETL record prepared for customization.
59+
Open the **IntegrationHub ETL** from the top navigation menu and select your cloned ETL map record prepared for customization. Refer to the [ServiceNow documentation](https://docs.servicenow.com/en-US/bundle/utah-servicenow-platform/page/product/configuration-management/concept/create-etl-transform-map.html) for a more comprehensive instruction on creating an ETL transform map.
6060

6161
Click on the first **Specify Basic Details** section of the ETL Transform Map Assistant. Select the import set number containing your resource from the **Sample Import Set** dropdown and click **Mark as Complete**.
6262

6363
Open the **Preview and Prepare Data** section and review the imported rows. Click **Mark as Complete**.
6464

65-
The third section provides the interface for mapping resource attributes. Click on **Select CMDB Classes to Map Source Data**. Click on **Add Conditional Class** button at the top. Set the rules that will identify your resource in the import set. Use the `type` field value from the Terraform state object to identify your resource (on the ServiceNow side field name are prefaced with `u_`). Set the target CMDB CI CLass name and click **Save**.
65+
The third section provides the interface for mapping resource attributes. Click on **Select CMDB Classes to Map Source Data**. Click on **Add Conditional Class** button at the top. Set the rules that will identify your resource in the import set. Use the `type` field value from the Terraform state object to identify your resource (on the ServiceNow side, field name are prefaced with `u_`). Set the target CMDB CI CLass name and click **Save**.
6666

6767
![ServiceNow Service Graph Connector: setting the Conditional Class rules in the ETL mapping](/img/docs/service-now-service-graph-conditional-class-mapping.png)
6868

@@ -78,7 +78,7 @@ Click **Mark as Complete** to finalize the **Select CMDB Classes to Map Source D
7878

7979
## Set the required relationships
8080

81-
Click **Add Relationships** to proceed to the next section. Click **Add Conditional Relationship** button at the top. The following configuration tells the ETL that when a record with `aws_vpc` type is found in the import set, it should be hosted on **AWS Datacenter 1**. Click **Save**.
81+
Click **Add Relationships** to proceed to the next section. Click **Add Conditional Relationship** button at the top of the page. The following configuration tells the ETL that when a record with `aws_vpc` type is found in the import set, it should be hosted on **AWS Datacenter 1**. Click **Save**.
8282

8383
![ServiceNow Service Graph Connector: setting dependent relationships in the ETL mapping interface](/img/docs/service-now-service-graph-etl-setting-relationship.png)
8484

@@ -90,4 +90,4 @@ Click **Mark as Complete** to finalize the **Add Relationships** section.
9090

9191
## Run a test
9292

93-
You can test the new resource mapping either by using the **Test and Rollback Integration Results** interface of the ETL Transform Map Assistant or initiating a new run in your Terraform Cloud workspace containing the resource deployment.
93+
To test the new resource mapping, you have two options. First, you can utilize the **Test and Rollback Integration Results** interface of the ETL Transform Map Assistant. Alternatively, you can initiate a new run in your Terraform Cloud workspace that includes the deployment of the resource.

website/docs/cloud-docs/integrations/service-now/service-graph/index.mdx

+5-7
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ The integration is based on the [Service Graph Connector](https://www.servicenow
1717

1818
The diagram below shows how the application connects Terraform Cloud to your ServiceNow instance.
1919

20-
![screenshot: ServiceNow Service Graph Connector for Terraform design diagram](/img/docs/service-now-service-graph-design.png)
20+
![ServiceNow Service Graph Connector for Terraform: design diagram](/img/docs/service-now-service-graph-design.png)
2121

22-
The Service Graph Connector for Terraform integrates with Terraform Cloud in order to obtain the latest information about your deployments, with the Terraform state being the source of data. The application doesn't make any requests to your cloud provider, and therefore doesn't ask you to share any cloud credentials.
22+
The Service Graph Connector for Terraform integrates with Terraform Cloud to fetch up-to-date information about your deployments. It leverages the Terraform state as the primary data source. The application doesn't make any requests to your cloud provider or require you to share any cloud credentials.
2323

2424
### Two modes of import
2525

@@ -35,13 +35,13 @@ Access the scheduler by searching for **Service Graph Connector for Terraform**
3535

3636
As a more lightweight alternative to the scheduled import, you can configure [webhook notifications](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/notifications) for all relevant workspaces in your Terraform Cloud. Webhooks offer an event-based approach to importing your resources. The import is triggered as soon as a Terraform run is successfully completed in the Terraform Cloud.
3737

38-
Webhook POST requests are sent to an API endpoint exposed by the Service Graph Connector for Terraform in your ServiceNow instance. Each webhook request includes an HMAC token, and the endpoint validates the signature using the secret you provide. Learn more about [Terraform Cloud notification authenticity](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/notifications).
38+
Webhook POST requests are sent to an API endpoint exposed by the Service Graph Connector for Terraform in your ServiceNow instance. Each webhook request includes an HMAC token, and the endpoint validates the signature using the secret you provide. Learn more about [Terraform Cloud notification authenticity](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/notifications#notification-authenticity).
3939

4040
Internally, the application uses a scheduled job as a helper to keep track of the incoming webhook requests. You can activate, configure it, and view the history of all webhook imports by navigating to **Scheduled Imports** and selecting **SG-Terraform Scheduled Process State**. By default, the job is set to run every minute. You can change it to run more frequently if you wish to process the webhook requests even faster.
4141

4242
-> **Tip:** Both import options may be enabled, or you may choose to configure only the webhooks or the scheduled import.
4343

44-
The [setup page](/terraform/cloud-docs/integrations/service-graph/service-graph-setup) provides configuration details for both import modes.
44+
The [setup page](/terraform/cloud-docs/integrations/service-now/service-graph/service-graph-setup) provides configuration details for both import modes.
4545

4646
### ETL (Extract, Transform, Load)
4747

@@ -93,6 +93,4 @@ The [resource mapping](/terraform/cloud-docs/integrations/service-now/service-gr
9393

9494
### Destroyed resources
9595

96-
The Service Graph Connector automatically marks the deleted resources as **Non-Operational** in the ServiceNow CMDB. After the destroy run is completed in Terraform Cloud and the application's import job is finished in your ServiceNow instance, the value of the **Operational Status** field will change to **Non-Operational** for all resources removed from the Terraform state as a result of the deletion.
97-
98-
96+
The Service Graph Connector automatically marks the deleted resources as **Non-Operational** in the ServiceNow CMDB. After the destroy run is completed in Terraform Cloud and the application's import job is finished in your ServiceNow instance, the **Operational Status** field of all resources removed from the Terraform state during the deletion process will be updated to **Non-Operational**.

website/docs/cloud-docs/integrations/service-now/service-graph/resource-coverage.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
page_title: Overview - ServiceNow Service Graph Connector for Terraform Integration - Resource Coverage
33
description: >-
4-
ServiceNow Service Graph integration allows to import selected resources into ServiceNow CMDB.
4+
ServiceNow Service Graph integration allows to import selected resources from major cloud providers into ServiceNow CMDB.
55
---
66

77
# Resource Coverage and Mapping
88

9-
The following tables outline how Service Graph Connector for Terraform maps resources from the Terraform state to the ServiceNow CMDB configuration items (CIs).
9+
The tables provided on this page illustrate the mapping of resources from the Terraform state to the ServiceNow CMDB configuration items (CIs) by the Service Graph Connector for Terraform.
1010

11-
While the default ETL map provided by the application can be utilized without modification, it is also possible to customize it according to the specific requirements of your organization. Check [ETL Mapping Customizations](/terraform/cloud-docs/integrations/service-now/service-graph/customizations) for more details.
11+
While the default ETL map provided by the application can be utilized without modification, it is also possible to customize it according to the specific requirements of your organization. Check [customizations](/terraform/cloud-docs/integrations/service-now/service-graph/customizations) for more details.
1212

1313
## AWS
1414

website/docs/cloud-docs/integrations/service-now/service-graph/service-graph-setup.mdx

+6-6
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The ServiceNow Service Graph for Terraform is a certified scoped application ava
1818

1919
-> **ServiceNow roles:** `admin`, `x_hashi_service_gr.terraform_user`
2020

21-
Once the integration is installed, proceed to the guided setup form to enter your Terraform credentials and set up a secure connection between Terraform Cloud and your ServiceNow instance.
21+
Once the integration is installed, you can proceed to the guided setup form where you will enter your Terraform credentials. This step will establish a secure connection between Terraform Cloud and your ServiceNow instance.
2222

2323
### Create and scope Terraform API token
2424

@@ -39,17 +39,17 @@ In the **Configure Terraform authentication credentials** section, click **Confi
3939

4040
If you want to route traffic between your Terraform Cloud and the ServiceNow instance through a MID server acting as a proxy, change **Applies to** dropdown to "Specific MID servers" and select your previously configured MID server name from the list. If you don't use MID servers, leave the default value.
4141

42-
Set the **API Key** to the Terraform Cloud team API token that you created earlier in this tutorial and click **Update**.
42+
Set the **API Key** to the Terraform Cloud team API token that you created in the previous section and click **Update**.
4343

4444
![ServiceNow Service Graph Connector API Key Credentials configuration screen. The API key is provided, then saved by clicking the Update button](/img/docs/service-now-service-graph-apikey.png)
4545

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

4848
### Configure Terraform Webhook Notification token
4949

50-
This section is optional and can be skipped if you plan to use only the scheduled import. Refer to the documentation explaining the [two modes of import](/terraform/cloud-docs/integrations/service-graph/index#two-modes-of-import) to decide which option works best for your environment.
50+
This section is optional and can be skipped if you plan to use only the scheduled import. Refer to the documentation explaining the [two modes of import](/terraform/cloud-docs/integrations/service-now/service-graph#two-modes-of-import) to decide which option works best for your environment.
5151

52-
To improve security, Terraform Cloud includes an HMAC signature on all "generic" webhook notifications using a user-provided **token**. This token is an arbitrary secret string that Terraform Cloud uses to sign each webhook notification. ServiceNow uses the same token to verify the request authenticity. Refer to [Notification Authenticity](/terraform/cloud-docs/api-docs/notification-configurations#notification-authenticity) for more information.
52+
To improve security, Terraform Cloud includes an HMAC signature on all "generic" webhook notifications using a user-provided **token**. This token is an arbitrary secret string that Terraform Cloud uses to sign each webhook notification. ServiceNow uses the same token to verify the request authenticity. Refer to [Terraform Cloud notification authenticity](/terraform/cloud-docs/api-docs/notification-configurations#notification-authenticity) for more information.
5353

5454
Create a token and save it in a safe place. This secret token can be any value but should be treated as sensitive.
5555

@@ -123,10 +123,10 @@ Under the form, you will find a table containing all registered import sets. Loc
123123

124124
Click on the **Import Set** field to open it and view its details. The **Outbound Http Requests** tab lists all requests made by your ServiceNow instance to Terraform Cloud in order to retrieve the latest Terraform state.
125125

126-
Monitor the state of the import job. Wait for it to change to Complete, indicated by a green mark.
126+
Monitor the state of the import job. Wait for it to change to **Complete**, indicated by a green mark.
127127
Once the import job is complete, you can access the imported resources in the CMDB.
128128

129-
![ServiceNow Service Graph Connector successful import set with completed state](/img/docs/service-now-service-graph-import-set.png)
129+
![ServiceNow Service Graph Connector: import set with successfully completed status](/img/docs/service-now-service-graph-import-set.png)
130130

131131
You can also access all import sets, regardless of the import type, by navigating to **All** and selecting **Import Sets** under the **Advanced** category.
132132

0 commit comments

Comments
 (0)