Skip to content

Commit 01f47a0

Browse files
jpipkin1kimsauce
andauthored
DOCS-1228 - Links for Terraform (#5991)
* Add resources * Add resuse file * Start adding links * Finish draft * Fix spelling error * Update docs/api/about-apis/terraform-with-sumo-logic.md Co-authored-by: Kim (Sumo Logic) <[email protected]> * Update docs/api/about-apis/terraform-with-sumo-logic.md Co-authored-by: Kim (Sumo Logic) <[email protected]> --------- Co-authored-by: Kim (Sumo Logic) <[email protected]>
1 parent 6a0821e commit 01f47a0

File tree

74 files changed

+722
-21
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

74 files changed

+722
-21
lines changed

docs/alerts/monitors/create-monitor.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,14 @@ Our alerts use machine learning to analyze historical data, establish baselines,
1313

1414
Integrated playbooks automate incident response by gathering diagnostics, notifying teams, triggering recovery actions, and streamlining workflows to improve response times. You can link playbooks to monitors to automate tasks such as restarting services or scaling infrastructure, ensuring swift and efficient anomaly resolution.
1515

16+
import TerraformLink from '../../reuse/terraform-link.md';
17+
18+
:::tip
19+
You can use Terraform to manage monitors with the [`sumologic_monitor`](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/monitor) and [`sumologic_monitor_folder`](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/monitor_folder) resources.
20+
21+
<TerraformLink/>
22+
:::
23+
1624
## Open the New Monitor window
1725

1826
There are several ways to create a new monitor, depending on where you are in Sumo Logic.

docs/alerts/monitors/muting-schedules.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,14 @@ Setting a **Muting Schedule** allows you to pause alert notifications from monit
1111
* **Planned System Maintenance**. During system maintenance, notifications can get triggered because your application and infrastructure are being brought up or turned off. Such notifications are known false alarms and should be ignored.
1212
* **Off-Business Hours**. If your monitors reflect performance thresholds that are only applicable during business hours, such monitors might generate false alarms during off-business hours.
1313

14+
import TerraformLink from '../../reuse/terraform-link.md';
15+
16+
:::tip
17+
You can use Terraform to manage muting schedules with the [`sumologic_muting_schedule`](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/muting_schedule) resource.
18+
19+
<TerraformLink/>
20+
:::
21+
1422
## Prerequisites
1523
Make sure you've enabled the [**View Muting Schedules**](/docs/manage/users-roles/roles/role-capabilities/#alerting) and [**Manage Muting Schedules**](/docs/manage/users-roles/roles/role-capabilities/#alerting) user permissions, which allow you to define and edit a muting schedule.
1624

docs/alerts/scheduled-searches/schedule-search.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,14 @@ This article outlines the process of creating a Scheduled Search, which is essen
1010

1111
To run a Scheduled Search using receipt time, save the search with receipt time enabled.
1212

13+
import TerraformLink from '../../reuse/terraform-link.md';
14+
15+
:::tip
16+
You can use Terraform to manage content such as scheduled searches with the [`sumologic_content`](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/content) resource.
17+
18+
<TerraformLink/>
19+
:::
20+
1321
## Create a Scheduled Search
1422

1523
This section describes how to create a Scheduled Search at the time you save a search. You can also edit a saved search later to add a schedule.

docs/alerts/webhook-connections/set-up-webhook-connections.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,14 @@ Most services with a REST API should allow you to create a connection using the
2323
If a scheduled search fails or times out, no data will be sent via webhook. In this case, you won’t see any notifications in the app you’ve configured to receive data.
2424
:::
2525

26+
import TerraformLink from '../../reuse/terraform-link.md';
27+
28+
:::tip
29+
You can use Terraform to manage webhook connections with the [`sumologic_connection`](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/connection) resource.
30+
31+
<TerraformLink/>
32+
:::
33+
2634
## Set up a webhook connection
2735

2836
The first step in integrating webhooks with Sumo Logic is to configure one or more connections, which are HTTP endpoints that tell Sumo Logic where to send data. You can set up any number of connections, depending on your organization's needs.

docs/api/about-apis/terraform-with-sumo-logic.md

Lines changed: 132 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,132 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
1111

1212
## What is Terraform?
1313

14-
[Terraform](https://developer.hashicorp.com/terraform) is an "infrastructure as code" tool developed by Hashicorp. Terraform scripts are used to define both cloud and on-prem resources in human-readable configuration files. Using Terraform scripts makes it easier for system administrators to provision and manage infrastructure and system resources consistently and reliably. The Terraform community, including Sumo Logic, supports Terraform through providers and APIs allowing applications to install and manage different types of resources and services from different vendors in one workflow. See the [Terraform Sumo Logic provider](https://registry.terraform.io/namespaces/SumoLogic).
15-
16-
## Sumo Logic use cases
17-
18-
You can use Terraform to manage all sorts of Sumo Logic resources. Here are some use cases:
19-
* [Manage monitors](https://www.sumologic.com/blog/terraform-sumo-logic)
20-
* [Manage collectors, users, and roles](https://www.sumologic.com/blog/terraform-provider-hosted)
21-
* [Deploy solutions (like AWS Observability)](/docs/observability/aws/deploy-use-aws-observability/deploy-with-terraform/)
22-
* [Manage Cloud SIEM rules](https://www.sumologic.com/guides/detections-as-code-setup)
14+
[Terraform](https://developer.hashicorp.com/terraform) is an "infrastructure as code" tool developed by Hashicorp. Terraform scripts are used to define both cloud and on-prem resources in human-readable configuration files. Using Terraform scripts makes it easier for system administrators to provision and manage infrastructure and system resources consistently and reliably. The Terraform community, including Sumo Logic, supports Terraform through providers and APIs allowing applications to install and manage different types of resources and services from different vendors in one workflow. See the [Terraform Sumo Logic provider](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs).
15+
16+
## Sumo Logic Terraform resources
17+
18+
You can use Terraform resources to manage all sorts of Sumo Logic components. Following are some examples.
19+
<details>
20+
21+
<summary>Resources</summary>
22+
23+
* Accounts
24+
* [Subdomains](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/subdomain)
25+
* [Apps](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/app)
26+
* Automation service
27+
* [Playbooks](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/csoar_playbook)
28+
* Cloud SIEM
29+
* [Automation](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/cse_automation)
30+
* [Context actions](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/cse_context_action)
31+
* Entities
32+
* [Custom entity types](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/cse_custom_entity_type)
33+
* [Entity criticality](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/cse_entity_criticality_config)
34+
* [Entity groups](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/cse_entity_entity_group_configuration)
35+
* [Entity normalization](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/cse_entity_normalization_configuration)
36+
* [Inventory entity groups](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/cse_inventory_entity_group_configuration)
37+
* Insights
38+
* [Configuration](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/cse_insights_configuration)
39+
* [Custom insights](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/cse_custom_insight)
40+
* [Resolution](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/cse_insights_resolution)
41+
* [Status](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/cse_insights_status)
42+
* [Log mapping](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/cse_log_mapping)
43+
* [Match lists](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/cse_match_list)
44+
* [Custom match list columns](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/cse_custom_match_list_column)
45+
* [Network blocks](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/cse_network_block)
46+
* Rules
47+
* [Aggregation rules](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/cse_aggregation_rule)
48+
* [Chain rule](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/cse_chain_rule)
49+
* [First seen rules](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/cse_first_seen_rule)
50+
* [Match rules](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/cse_match_rule)
51+
* [Outlier rules](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/cse_outlier_rule)
52+
* [Rule tuning expressions](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/cse_rule_tuning_expression)
53+
* [Threshold rules](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/cse_threshold_rule)
54+
* [Tag schemas](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/cse_tag_schema)
55+
* [Collectors](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/collector)
56+
* [Installed collectors](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/installed_collector)
57+
* [OpenTelemetry collectors](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/ot_collector)
58+
* [Connections](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/connection)
59+
* [Content](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/content)
60+
* [Content sharing](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/content_permission)
61+
* [Dashboards](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/dashboard)
62+
* Data forwarding
63+
* [Data forwarding destinations](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/data_forwarding_destination)
64+
* [Data forwarding rules](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/data_forwarding_rule)
65+
* [Fields](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/field)
66+
* [Field extraction rules](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/field_extraction_rule)
67+
* [Folders](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/folder)
68+
* [Hierarchies](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/hierarchy)
69+
* [Ingest budgets](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/ingest_budget_v2)
70+
* [Log searches](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/log_search)
71+
* [Lookup table](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/lookup_table)
72+
* Metrics
73+
* [Metrics search](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/metrics_search)
74+
* [Metrics search V2](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/metrics_search_v2)
75+
* [Monitors](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/monitor)
76+
* [Monitors folders](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/monitor_folder)
77+
* [Muting schedules](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/muting_schedule)
78+
* [Partitions](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/partition)
79+
* [Password policies](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/password_policy)
80+
* [Policies](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/policies)
81+
* [Roles](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/role)
82+
* [Roles v2](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/role_v2)
83+
* [SAML configuration](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/saml_configuration)
84+
* [Scan budget](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/scan_budget)
85+
* [Scheduled views](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/scheduled_view)
86+
* [SLOs](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/slo)
87+
* [SLO folders](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/slo_folder)
88+
* Sources
89+
* [AWS S3 source](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/s3_source)
90+
* [AWS S3 Archive source](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/s3_archive_source)
91+
* [AWS S3 Audit source](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/s3_audit_source)
92+
* [AWS inventory source](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/aws_inventory_source)
93+
* [AWS XRay source](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/aws_xray_source)
94+
* [Azure Event Hub log source](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/azure_event_hub_log_source)
95+
* [Azure metrics source](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/azure_metrics_source)
96+
* [Cloud-to-Cloud source](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/cloud_to_cloud_source)
97+
* [CloudFront source](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/cloudfront_source)
98+
* [Cloud Syslog source](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/cloudsyslog_source)
99+
* [CloudTrail source](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/cloudtrail_source)
100+
* [CloudWatch source](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/cloudwatch_source)
101+
* [ELB source](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/elb_source)
102+
* [GCP Metrics source](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/gcp_metrics_source)
103+
* [GCP source](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/gcp_source)
104+
* [HTTP source](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/http_source)
105+
* [Kinesis Log source](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/kinesis_log_source)
106+
* [Kinesis Metrics source](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/kinesis_metrics_source)
107+
* [Local file source](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/local_file_source)
108+
* [Local Windows Event Log source](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/local_windows_event_source)
109+
* [Metadata source](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/metadata_source)
110+
* [Rum Source](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/rum_source)
111+
* [Source templates](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/source_template)
112+
* [Tokens](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/token)
113+
* [Users](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/user)
114+
115+
</details>
116+
117+
## Sumo Logic Terraform data sources
118+
119+
You can use Terraform data sources to retrieve Sumo Logic data from your Terraform configuration. Following are some examples.
120+
121+
<details>
122+
123+
<summary>Data sources</summary>
124+
125+
* [Admin recommended folders](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/data-sources/admin_recommended_folder)
126+
* [Apps](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/data-sources/apps)
127+
* [Caller identity](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/data-sources/caller_identity)
128+
* [Collectors](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/data-sources/collector)
129+
* [Cloud SIEM log mapping](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/data-sources/cse_log_mapping_vendor_product)
130+
* [Folders](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/data-sources/folder)
131+
* [HTTP sources](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/data-sources/http_source)
132+
* [Partitions](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/data-sources/partitions)
133+
* [Partition details](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/data-sources/partition)
134+
* [Personal folders](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/data-sources/personal_folder)
135+
* [Roles](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/role)
136+
* [Roles v2](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/data-sources/role_v2)
137+
* [Users](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/data-sources/user)
138+
139+
</details>
23140

24141
## Prerequisites
25142

@@ -93,7 +210,9 @@ Let's look at some examples:
93210
94211
### Terraform providers
95212
96-
A *provider* is a Terraform module or plugin developed by a vendor that defines which vendor resources are available for Terraform to create and manage. Sumo Logic has an established Terraform provider plugin, as does AWS and other major cloud vendors. The Terraform script section defining the provider for resources defined by other parts of the script might look like this:
213+
A *provider* is a Terraform module or plugin developed by a vendor that defines which vendor resources are available for Terraform to create and manage. For information about the Sumo Logic provider, see the [Sumo Logic Provider documentation](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs).
214+
215+
Sumo Logic has an established Terraform provider plugin, as does AWS and other major cloud vendors. The Terraform script section defining the provider for resources defined by other parts of the script might look like this:
97216
98217
```
99218
provider "aws" {
@@ -119,7 +238,9 @@ terraform {
119238
120239
### Terraform resources
121240
122-
A *resource* is an infrastructure element that can be defined and created from the available resources produced by the provider. A resource definition will look similar in form to the provider definition:
241+
A *resource* is an infrastructure element that can be defined and created from the available resources produced by the provider. For available resources, see the [Sumo Logic Provider documentation](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs).
242+
243+
A resource definition will look similar in form to the provider definition:
123244
124245
```
125246
resource "aws_s3_bucket" "training" {

docs/apm/real-user-monitoring/configure-data-collection.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,14 @@ To utilize XHR and navigation/route changes, and errors collection, you must use
3333

3434
For full end-to-end visibility, we recommended supplementing your RUM browser auto-instrumentation with the appropriate [back-end tracing instrumentation](/docs/apm/traces/get-started-transaction-tracing).
3535

36+
import TerraformLink from '../../reuse/terraform-link.md';
37+
38+
:::tip
39+
You can use Terraform to provide a RUM source with the [`sumologic_rum_source`](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/rum_source) resource.
40+
41+
<TerraformLink/>
42+
:::
43+
3644
## Step 1: Create a RUM HTTP Traces Source
3745

3846
To configure a RUM HTTP Traces source:

0 commit comments

Comments
 (0)