Skip to content

Commit 92e1cc3

Browse files
authored
[ServiceNow] [Service ctalog] Update documentation for supported var types (#1108)
2 parents 2b03006 + 025f7fe commit 92e1cc3

File tree

1 file changed

+13
-15
lines changed
  • content/terraform-docs-common/docs/cloud-docs/integrations/service-now/service-catalog-terraform

1 file changed

+13
-15
lines changed

content/terraform-docs-common/docs/cloud-docs/integrations/service-now/service-catalog-terraform/developer-reference.mdx

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ This function looks for variables following these conventions:
2020

2121
| ServiceNow Variable Name | HCP Terraform Variable |
2222
| -------------------------------- | ---------------------------------------------------------- |
23-
| `tf_var_VARIABLE_NAME` | Terraform Variable: `VARIABLE_NAME` |
23+
| `tf_var_hcl_VARIABLE_NAME` | Terraform Variable: `VARIABLE_NAME` |
2424
| `tf_env_ENV_NAME` | Environment Variable: `ENV_NAME` |
25-
| `sensitive_tf_var_VARIABLE_NAME` | Sensitive Terraform Variable (Write Only): `VARIABLE_NAME` |
25+
| `sensitive_tf_var_hcl_VARIABLE_NAME` | Sensitive Terraform Variable (Write Only): `VARIABLE_NAME` |
2626
| `sensitive_tf_env_ENV_NAME` | Sensitive Environment Variable (Write Only): `ENV_NAME` |
2727

2828
This function takes the ServiceNow Variable Set and HCP Terraform workspace
@@ -61,17 +61,17 @@ Server Development > Script Include.
6161

6262
### Example Service Catalog Flows and Actions
6363

64-
The ServiceNow Service Catalog for Terraform provides sample catalog items that use **Flows**
65-
and **Workflows** as their primary process engines. **Flows** are a newer solution developed
66-
by ServiceNow and are generally preferred over **Workflows**. To see which engine an item is using, open it
67-
in the edit mode and navigate to the **Process Engine** tab. For example, **Create Workspace** uses a **Workflow**,
68-
whereas **Create Workspace Flow** is built upon a **Flow**. You can access both in the **Studio**. You can also
64+
The ServiceNow Service Catalog for Terraform provides sample catalog items that use **Flows**
65+
and **Workflows** as their primary process engines. **Flows** are a newer solution developed
66+
by ServiceNow and are generally preferred over **Workflows**. To see which engine an item is using, open it
67+
in the edit mode and navigate to the **Process Engine** tab. For example, **Create Workspace** uses a **Workflow**,
68+
whereas **Create Workspace Flow** is built upon a **Flow**. You can access both in the **Studio**. You can also
6969
manage **Flows** in the **Flow Designer**. To manage **Workflows**, navigate to **All > Workflow Editor**.
7070

71-
You can find the ServiceNow Example Flows for Terraform in the **ServiceNow Studio > Flows** (or **All > Flow Designer**).
72-
Search for items that belong to the **Terraform** application. By default, Flows execute when someone submits an order request
73-
for a catalog item based on a Flow. Admins can customize the Flows and Actions to add approval flows, set approval rules based
74-
on certain conditions, and configure multiple users or roles as approvers for specific catalog items.
71+
You can find the ServiceNow Example Flows for Terraform in the **ServiceNow Studio > Flows** (or **All > Flow Designer**).
72+
Search for items that belong to the **Terraform** application. By default, Flows execute when someone submits an order request
73+
for a catalog item based on a Flow. Admins can customize the Flows and Actions to add approval flows, set approval rules based
74+
on certain conditions, and configure multiple users or roles as approvers for specific catalog items.
7575

7676
| Flow Name | Description |
7777
| ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -80,19 +80,17 @@ on certain conditions, and configure multiple users or roles as approvers for sp
8080
| Create Run | Creates and queues a new run in the HCP Terraform workspace. |
8181
| Apply Run | Applies a run in the HCP Terraform workspace. |
8282
| Provision Resources | Creates a new HCP Terraform workspace (with auto-apply), creates and queues a run, then applies the run when ready. |
83-
| Provision Resources with Vars | Creates a new HCP Terraform workspace (with auto-apply), creates any variables, creates/queues a run, applies the run when ready.
83+
| Provision Resources with Vars | Creates a new HCP Terraform workspace (with auto-apply), creates any variables, creates/queues a run, applies the run when ready.
8484
| Provision No-Code Workspace and Deploy Resources | Creates a new HCP Terraform workspace based on a no-code module configured in the private registry (with auto-apply), creates any variables, creates and queues a run, then applies the run when ready. |
8585
| Delete Workspace | Creates a destroy run plan. |
8686
| Worker Poll Run State | Polls the HCP Terraform API for the current run state of a workspace. |
8787
| Worker Poll Apply Run | Polls the HCP Terraform API and applies any pending Terraform runs. |
8888
| Worker Poll Destroy Workspace | Queries ServiceNow Terraform Records for resources marked `is_destroyable`, applies the destroy run to destroy resources, and deletes the corresponding Terraform workspace. |
89-
| Update No-Code Workspace and Deploy Resources | Updates an existing no-code workspace to the most recent no-code module version, updates that workspace's attached variable values, and then starts a new Terraform run.
89+
| Update No-Code Workspace and Deploy Resources | Updates an existing no-code workspace to the most recent no-code module version, updates that workspace's attached variable values, and then starts a new Terraform run.
9090
| Update Workspace | Updates HCP Terraform workspace configurations, such as VCS repository, description, project, execution mode, and agent pool ID (if applicable). |
9191
| Update Workspace with Vars | Allows you to change details about the HCP Terraform workspace configurations and attached variable values. |
9292
| Update Resources | Updates HCP Terraform workspace details and starts a new Terraform run with these new values. |
9393
| Update Resources with Vars | Updates your existing HCP Terraform workspace and its variables, then starts a Terraform run with these updated values. |
94-
| Provision Resources with Vars with Approval | Creates a new HCP Terraform workspace, enables auto-apply, creates workspace variables, starts a speculative plan, then pauses for approval. If you approve the run, HCP Terraform applies the plan.
95-
| Update Resources with Vars with Approval | Updates your existing HCP Terraform workspace and its variables, then starts a Terraform run (speculative plan) with these updated values. If request is approved, the plan is applied. If it is rejected then the it will not be applied. |
9694

9795
## ServiceNow ACLs
9896

0 commit comments

Comments
 (0)