⚠️ This project is still in very early stages and breaking changes could happen

Checkly Pulumi Provider

The Checkly Pulumi provider enables you to create and configure Checkly resources using your favourite programming language.

Installation

To use this package, please install the Pulumi CLI first.
This package is only available for JavaScript and TypeScript but support for other languages/platforms, will be available soon.

Node.js (JavaScript/TypeScript)

To use from JavaScript or TypeScript in Node.js, install using either npm:

npm install @checkly/pulumi

or yarn:

yarn add @checkly/pulumi

Python

TBA

Go

TBA

.NET

TBA

Authentication

The Pulumi Checkly Provider needs to be configured with a Checkly API Key and Account ID before it can be used to create resources.

If you don't have an API Key, you can create one here.

Once you generated the API Key there are two ways to communicate your authorization tokens to Pulumi:

Set the environment variables CHECKLY_API_KEY and CHECKLY_ACCOUNT_ID:

$ export CHECKLY_API_KEY=cu_xxx
$ export CHECKLY_ACCOUNT_ID=xxx

Set them using pulumi config command, if you prefer that they be stored alongside your Pulumi stack for easy multi-user access:
```
$ pulumi config set checkly:apiKey cu_xxx --secret
$ pulumi config set checkly:accountId xxx
```

Remember to pass --secret when setting checkly:apiKey so it is properly encrypted.

Creating Resources

const checkly = require("@checkly/pulumi")

new checkly.Check("api-check", {
  activated: true,
  frequency: 10,
  type: "API",
  request: {
    method: "GET",
    url: "https://api.spacexdata.com/v3",
  }
})

new checkly.Check("browser-check", {
  activated: true,
  frequency: 10,
  type: "BROWSER",
  script: `console`
})

Check the examples directory for more detailed code samples.

Configuration

The following configuration points are available for the foo provider:

checkly:apiKey (environment: CHECKLY_API_KEY) - the Checkly API Key.
checkly:accountId (environment: CHECKLY_ACCOUNT_ID) - the Checkly account ID.

Reference

For detailed reference documentation, please visit the Pulumi registry.

License

MIT

_{Delightful Active Monitoring for Developers}
_{From Checkly with ♥️}

stack72 / pulumi-checkly-1