README.md

Solarwinds Observability Terraform Provider (Terraform Plugin Framework)

terraform-provider-swo

This provider lets you manage your SolarWinds Observability configuration (e.g. alerts, websites, API tokens, etc.) using Terraform. Its Terraform registry page can be found here.

Using the provider

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

Example usage

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

Issues/Bugs

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

Developing the Provider

Requirements

• Terraform >= 1.0
• Go >= 1.22

Building

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

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.

Terraform Debugging

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 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

Run Terraform:

terraform init -upgrade