README.md

Checkly Terraform provider

This Terraform provider enables users to manage Checkly resources like checks.

You can read a detailed tutorial and explanation of the Checkly Terraform provider here:

• Managing Checkly checks with Terraform

Using the provider

1. Download the binary applicable for your platform from the latest tagged release. Then copy the binary to your Terraform plugin folder, unzip it and rename it to just terraform-provider-checkly. Lastly, set the correct access rights.

I you're on MacOS, just run the script install.sh script

curl https://raw.githubusercontent.com/bitfield/terraform-provider-checkly/master/install.sh | sh

2. Run terraform init and then terraform providers. The Checkly plugin should be listed.

terraform init

Initializing provider plugins...
Terraform has been successfully initialized!

terraform providers
.
└── provider.checkly

If you're having issues, please check the Hashicorp docs on installing third party plugins.

Authentication

To use the provider with your Checkly account, you will need an API Key for the account. Go to the Account Settings: API Keys page and click 'Create API Key'.

Now expose the API key as an environment variable in your shell:

export TF_VAR_checkly_api_key=<my_api_key>

Usage examples

Add a checkly_check resource to your resource file.

This first example is a very minimal API check.

variable "checkly_api_key" {}

provider "checkly" {
  api_key = "${var.checkly_api_key}"
}

resource "checkly_check" "example-check" {
  name                      = "Example check"
  type                      = "API"
  activated                 = true
  should_fail               = false
  frequency                 = 1
  double_check              = true
  ssl_check                 = true
  ssl_check_domain          = "api.example.com"
  use_global_alert_settings = true

  locations = [
    "us-west-1"
  ]

  request {
    url              = "https://api.example.com/"
    follow_redirects = true
    assertion {
      source     = "STATUS_CODE"
      comparison = "EQUALS"
      target     = "200"
    }
  }
}

Here's something a little more complicated, to show what you can do:

resource "checkly_check" "example-check2" {
  name                   = "Example check 2"
  type                   = "API"
  activated              = true
  should_fail            = true
  frequency              = 1
  ssl_check_domain       = "api.example.com"
  double_check           = true
  degraded_response_time = 5000
  max_response_time      = 10000

  locations = [
    "us-west-1",
    "ap-northeast-1",
    "ap-south-1",
  ]

  alert_settings {
    escalation_type = "RUN_BASED"

    run_based_escalation {
      failed_run_threshold = 1
    }

    time_based_escalation {
      minutes_failing_threshold = 5
    }

    ssl_certificates {
      enabled         = true
      alert_threshold = 30
    }

    reminders {
      amount = 1
    }
  }

  request {
    follow_redirects = true
    url              = "http://api.example.com/"

    query_parameters = {
      search = "foo"
    }

    headers = {
      X-Bogus = "bogus"
    }

    assertion {
      source     = "JSON_BODY"
      property   = "code"
      comparison = "HAS_VALUE"
      target     = "authentication.failed"
    }

    assertion {
      source     = "STATUS_CODE"
      property   = ""
      comparison = "EQUALS"
      target     = "401"
    }

    basic_auth {
      username = ""
      password = ""
    }
  }
}

Developing the provider

Clone the repo, build the project and add it to your Terraform plugins directory. You will need to have Go installed.

git clone [email protected]:bitfield/terraform-provider-checkly.git
cd terraform-provider-checkly
go test
go build && CHECKLY_API_KEY=XXX go test -tags=integration