Skip to content

Commit d7a0c52

Browse files
committed
Final cleanup
1 parent 953de07 commit d7a0c52

File tree

7 files changed

+15
-10
lines changed

7 files changed

+15
-10
lines changed

docs/api/about-apis/intro-to-apis.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Web APIs typically use HTTP calls, the same protocol that provides web pages whe
2929

3030
## Create an access key
3131

32-
To use the Sumo Logic APIs you need a Sumo Logic access ID and access key. To do this, you need to log in to the main Sumo Logic web interface with a Sumo Logic user account that has the [Create Access Keys role capability](/docs/manage/users-roles/roles/role-capabilities/#security).
32+
To use the Sumo Logic APIs you need a [Sumo Logic access ID and access key](/docs/manage/security/access-keys/). To do this, you need to log in to the main Sumo Logic web interface with a Sumo Logic user account that has the [Create Access Keys role capability](/docs/manage/users-roles/roles/role-capabilities/#security).
3333

3434
In this section, we'll walk you through creating a personal access key that you can use to access the API in the subsequent sections.
3535

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

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ 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](https://developer.hashicorp.com/terraform/intro). 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.
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).
1515

1616
[How does Terraform work?](https://developer.hashicorp.com/terraform/intro#how-does-terraform-work) The core Terraform workflow consists of three stages:
1717
* **Write**. Define resources, which may be across multiple cloud providers and services. For example, you might create a configuration to deploy an AWS instance to support AWS Observability for a customer.
@@ -22,9 +22,12 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
2222

2323
## Understanding the Terraform format
2424

25-
Terraform scripts are text files, typically with a `.tf` extension, that use names and values in a hierarchal format, defined by curly braces `{ }`. Terraform scripts can be edited with any text editor, and although they are intended to be run automatically by a computer system, the script elements are generally human readable and not difficult to parse and understand.
25+
Terraform scripts are text files, typically with a `.tf` extension, that use names and values in a hierarchal format, defined by curly braces `{ }`. Terraform scripts can be edited with any text editor, and although they are intended to be run automatically by a computer system, the script elements are generally human-readable and not difficult to parse and understand.
2626

2727
Let's look at some examples:
28+
* [Terraform providers](#terraform-providers)
29+
* [Terraform resources](#terraform-resources)
30+
* [Terraform state files](#terraform-state-files)
2831

2932
### Terraform providers
3033

@@ -174,20 +177,20 @@ The state file is used by Terraform to track the current infrastructure state in
174177

175178
## Using Sumo Logic's AWS Terraform template
176179

177-
Since setting up AWS Observability is a common use case, Sumo Logic has already established a Terraform template containing the basic script items needed to setup an AWS installation with the proper AWS and Sumo Logic resources and components.
180+
Since [setting up AWS Observability](/docs/observability/aws/deploy-use-aws-observability/deploy-with-terraform/) is a common use case, Sumo Logic has already established a Terraform template containing the basic script items needed to setup an AWS installation with the proper AWS and Sumo Logic resources and components.
178181

179182
To use this solution template, you should already have:
180183
* A Sumo Logic account.
181184
* An AWS account.
182-
* A Sumo Logic access ID and access key.
185+
* A [Sumo Logic access ID and access key](/docs/manage/security/access-keys/).
183186

184187
Perform the following steps to use the template:
185188

186189
1. The solution template files can be found [here](https://github.com/SumoLogic/sumologic-solution-templates/tree/master/aws-observability-terraform), in the Sumo Logic solution templates Github repository. To implement this solution, copy or clone the files in the repository to your server or local machine. For instance, from the command line, you can use the following command to clone the repository:<br/>`git clone https://github.com/SumoLogic/sumologic-solution-templates`
187190
1. In preparation, you will want to complete the following steps on your server or local machine:
188191
1. [Install Terraform](https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli) (version 1.6 or later).
189192
1. [Install Python](https://www.python.org/downloads/) (version 3.11 or later).
190-
1. [Install the latest version](https://github.com/jqlang/jq/wiki/Installation) of the "jq" JSON parser, necessary to run the `.sh` batch files in the template.
193+
1. [Install the latest version of the "jq" JSON parser](https://github.com/jqlang/jq/wiki/Installation), necessary to run the `.sh` batch files in the template.
191194
1. [Install the Sumo Logic Python SDK](https://pypi.org/project/sumologic-sdk/).
192195
1. [Install the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html).
193196
1. Next, navigate to the `sumologic-solution-templates` folder where you cloned the repository, and go to the `aws-observability-terraform` subdirectory. Set this directory to be the Terraform working directory by executing the following command: `terraform init`

docs/observability/aws/deploy-use-aws-observability/changelog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar_label: Changelog
55
description: This section provides details on the available versions of the AWS Observability CloudFormation template.
66
---
77

8-
This section provides details on the available versions of the AWS Observability Terraform script and CloudFormation template. The details also include all the AWS and Sumo Logic resources that will be updated and resolved bugs when upgrading the existing version of the Terraform script or CloudFormation template to the latest version.
8+
This section provides details on the available versions of the AWS Observability Terraform script and CloudFormation template. The details also include all the AWS and Sumo Logic resources that will be updated and resolved bugs when upgrading the existing version of the Terraform script or CloudFormation template to the latest version. For more information about how to use Terraform in your Sumo Logic environment, see [Use Terraform with Sumo Logic](/docs/api/about-apis/terraform-with-sumo-logic).
99

1010
To install or upgrade to the required version of the CloudFormation template, use the URL of the YAML file corresponding to the right version number as the Amazon S3 URL in the AWS CloudFormation section of the AWS Management Console. See [Selecting a stack template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-using-console-create-stack-template.html) for more information.
1111

docs/observability/aws/deploy-use-aws-observability/deploy-with-terraform.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar_label: Deploy with Terraform
55
description: Learn how to deploy AWS Observability Solution using Terraform.
66
---
77

8-
These instructions help you deploy our AWS Observability Solution using a Terraform script. 
8+
These instructions help you deploy our AWS Observability Solution using a Terraform script. For more information about how to use Terraform in your Sumo Logic environment, see [Use Terraform with Sumo Logic](/docs/api/about-apis/terraform-with-sumo-logic).
99

1010
To set up the AWS Observability solution using Terraform, complete the following steps described in this documentation.
1111

docs/observability/sdo/set-up-sdo/sdo-setup-with-terraform-script.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar_label: Terraform Configuration
55
description: Learn how to set up the Software Development Optimization (SDO) Solution using a Terraform script.
66
---
77

8-
These instructions help you prepare and set up the Software Development Optimization (SDO) Solution using a Terraform script. 
8+
These instructions help you prepare and set up the Software Development Optimization (SDO) Solution using a Terraform script. For more information about how to use Terraform in your Sumo Logic environment, see [Use Terraform with Sumo Logic](/docs/api/about-apis/terraform-with-sumo-logic).
99

1010
The Terraform script performs the following actions:
1111

docs/platform-services/automation-service/app-central/integrations/terraform.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
99
***Version: 1.1
1010
Updated: Jun 22, 2023***
1111

12-
Terraform is an open-source infrastructure as code software tool that provides a consistent CLI workflow to manage cloud services.
12+
This [automation integration](/docs/platform-services/automation-service/app-central/integrations/) utilizes Terraform. [Terraform](https://developer.hashicorp.com/terraform) is an open-source infrastructure as code software tool that provides a consistent CLI workflow to manage cloud services.
13+
14+
For more information about how to use Terraform in your Sumo Logic environment, see [Use Terraform with Sumo Logic](/docs/api/about-apis/terraform-with-sumo-logic).
1315

1416
## Actions
1517

static/img/api/postman-ui.png

-277 KB
Loading

0 commit comments

Comments
 (0)