terraform-provider-swo

README

Solarwinds Observability Terraform Provider (Terraform Plugin Framework)

terraform-provider-swo

This provider lets you save clicking in the Solarwinds Observability Platform user interface by allowing you to produce SWO configuration with the rest of your cloud infratructure.

The SWO terraform provider enables the automation of:

• Alerts
• Api Tokens
• Dashboards
• Log Exclusion Filters
• Notification Services
• Uris (uptime checks)
• Websites (uptime checks)

Example usage

See example.tf in this repo to understand how to start using the provider.

Installing

• Grab the latest release binary from the Releases page.
• Extract and place the binary into $HOME/.terraform.d/plugins/github.com/solarwinds/terraform-provider-swo/<VERSION>/<ARCH>/terraform-provider-swo (Replace <VERSION> with the version downloaded and <ARCH> with the machine architecture (eg. darwin_amd64 or darwin_arm64)
• Set the execute flag on the binary

chmod 755 $HOME/.terraform.d/plugins/github.com/solarwinds/terraform-provider-swo/<VERSION>/<ARCH>/terraform-provider-swo

• You should now be able to write TF code for the Solarwinds Observability Platform with the rest of your infrastructure code.

Usage Notes

In order for the provider to work in a module, you need to add a required_providers block in your module as such:

terraform {
  required_providers {
    swo = {
      source  = "solarwinds/swo"
      version = ">= 0.0.11"
    }
  }
}

This needs to be done because this provider has not been published to the Terraform registry, which is the default location that Terraform will look in when searching for providers.

Issues/Bugs

Please report bugs and request enhancements in the Issues area of this repo.

Requirements

• Terraform >= 1.0
• Go >= 1.20

Building The Provider

1. Clone the repository
2. Enter the repository directory
3. Build the provider using the Go install command:

go install

Adding Dependencies

This provider uses Go modules. Please see the Go documentation for the most up to date information about using Go modules.

To add a new dependency github.com/author/dependency to your Terraform provider:

go get github.com/author/dependency
go mod tidy

Then commit the changes to go.mod and go.sum.

Using the provider

Full documentation for using the provider can be found at the Terraform Registry or in the /docs folder of this repo.

Developing the Provider

If you wish to work on the provider, you'll first need Go installed on your machine (see Requirements above).

To compile the provider, run go install. This will build the provider and put the provider binary in the $GOPATH/bin directory.

To generate or update documentation, run go generate.

In order to run the full suite of Acceptance tests, run make testacc.

Note: Acceptance tests create real resources, and often cost money to run.

make testacc

Terraform Debugging

Mac Install Terraform:

$ brew tap hashicorp/tap
$ brew install hashicorp/tap/terraform

Follow this: https://opencredo.com/blogs/running-a-terraform-provider-with-a-debugger/ For vscode setup a .vscode/launch.json file that looks like this

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "debug tf",
            "type": "go",
            "request": "launch",
            "args": ["--debug"],
            "program": "main.go" 
        }
    ],
}

Run the new debugger. If everything was set up correctly, the plugin will output a message to the Debug Console telling you to set the TF_REATTACH_PROVIDERS environment variable.

Below you see an example of what should be displayed in your Debug Console if the provider stated up correctly. Copy the variable in your Debug Console and export it in your terminal. Don't export what is in the example below.

Example:

Provider started. To attach Terraform CLI, set the TF_REATTACH_PROVIDERS environment variable with the following:

	TF_REATTACH_PROVIDERS='{"github.com/solarwinds/swo":{"Protocol":"grpc","ProtocolVersion":6,"Pid":50111,"Test":true,"Addr":{"Network":"unix","String":"/var/folders/86/21z0bd_x39g177h5nfw2l8w80000gq/T/plugin1234"}}}'

export the TF_REATTACH_PROVIDERS you get back.

If you're running Apple M1 chip.

export GODEBUG=asyncpreemptoff=1
terraform init -upgrade