This release is a pre-release and may not be stable for production use.
Checkly Provider for Pulumi
The Checkly provider for Pulumi can be used to provision any of the monitoring resources available in Checkly.
Installation
The Checkly provider is available as a package in most Pulumi languages:
- JavaScript/TypeScript:
@checkly/pulumi - Python:
pulumi-checkly - Go:
github.com/checkly/pulumi-checkly/sdk/v3/go/checkly - .NET:
Pulumi.Checkly
Authentication
The Checkly provider must be configured with an API Key and an Account ID in order to deploy Checkly resources. Sign up for a Checkly account and follow our integration guide to create and configure your credentials.
Example configuration
First, configure your Checkly Account ID:
pulumi config set checkly:accountId YOUR_CHECKLY_ACCOUNT_ID
Then, configure you Checkly API key (with --secret):
pulumi config set checkly:apiKey YOUR_CHECKLY_API_KEY --secret
You should now be able to deploy Checkly resources.
Example usage
You can find working JavaScript and TypeScript code samples in the ./examples directory.
Upgrading to v3
v3 bridges version 2 of the Checkly Terraform provider, which moved to the Terraform Plugin Framework. This section lists what changes for Pulumi programs and stacks. For the details behind it, and for smaller changes not listed here, read the Terraform provider's v2 upgrade guide.
Upgrade procedure
- While still on v2.x, run
pulumi upand apply any pending changes, so that you start from a clean preview. - Delete every
TriggerCheckandTriggerCheckGroupresource while still on v2.x: remove it from your program and runpulumi up. To keep the trigger URL working for now, runpulumi state delete <urn>instead, which removes the resource from the stack only. If you have already upgraded, usepulumi state delete <urn>: v3 doesn't have these resource types and can't delete them. - Back up the stack with
pulumi stack export --file backup.json. Once v3 has updated or refreshed the stack, v2.x may not be able to read it; to go back, restore the backup withpulumi stack import --file backup.json. - Make sure every API key has an account ID: set
checkly:accountIdor theCHECKLY_ACCOUNT_IDenvironment variable. v2.x only required it for user-scoped keys. - Upgrade the package to v3 and update your program as described in Changes to your program.
- Run
pulumi preview, thenpulumi up. The preview should show only in-place updates, where a default changed; see Expected changes. If it shows a deletion or replacement you didn't intend, fix your program before runningpulumi up. This firstpulumi upswitches the stack to the v3 provider. Don't runpulumi refresh --run-programbefore it: it fails on the inputs that v2.x stored, withobjectEncoder failed on property "alert_settings". A plainpulumi refreshbefore it still uses the v2.x provider recorded in the stack. - Optionally, move deprecated resources to their replacements, as described in Moving to the replacement resources.
Changes to your program
- Go: the import path is now
github.com/checkly/pulumi-checkly/sdk/v3/go/checkly. - Go: the SDK needs Go 1.26.6 or later and
github.com/pulumi/pulumi/sdk/v3v3.276.0 or later. TriggerCheckandTriggerCheckGroupare gone. Checkly has deprecated command line trigger URLs; run checks on demand with the Checkly CLI instead.- New resources:
ApiCheck,BrowserCheckandMultistepCheck, one per check type, which expose only the properties of their type. They replaceCheck. MaintenanceWindownow manages the upstreamcheckly_maintenance_windowresource. Your code keeps working unchanged.- Deprecated, but still available:
Check,CheckGroup(useCheckGroupV2),HeartbeatCheck(useHeartbeatMonitor),TcpCheck(useTcpMonitor),StatusPage(useStatusPageV3) andStatusPageService(useStatusPageV3Component). - Nested
alertSettingsvalues are objects instead of lists, with singular names:runBasedEscalation,timeBasedEscalation,parallelRunFailureThresholdandreminders.alertSettings.sslCertificatesis gone. This applies to every check, group and monitor, and toCheckGroupV2.enforceAlertSettings.alertSettings. CheckandCheckGroup:environmentVariablesis a list of{ key, value, locked, secret }objects. It replaces both theenvironmentVariablelist and theenvironmentVariablesmap; rewrite each map entry as a list element with the samekeyandvalue. Remove environment variables from API checks, where they never had an effect.groupId,setupSnippetIdandteardownSnippetIdmust be left out, or set toundefined(Nonein Python,nilin Go), when a check has no group or snippet.0now fails the preview. An expression that chooses between an ID and none must chooseundefinedinstead of0.Check:sslCheckis gone. On a browser or multi-stepCheck, settingshouldFailfails the preview, even tofalse; remove it.GrpcMonitor,SslMonitorandTracerouteMonitor:shouldFailis gone.DnsMonitor,GrpcMonitor,IcmpMonitor,SslMonitor,TcpCheck,TcpMonitorandTracerouteMonitor:retryStrategy.onlyOnis gone.CheckGroupandCheckGroupV2: when you setapiCheckDefaults, itsurlis required. LeaveapiCheckDefaultsout if you don't need a base URL.- These outputs are now secrets: environment variable values (
EnvironmentVariable.valueandenvironmentVariables[].valueon checks, check groups and Playwright check suites), basic auth passwords,heartbeat.pingToken,PrivateLocation.proxyUrl, andslack.url,webhook.url,webhook.webhookSecret,opsgenie.apiKeyandpagerduty.serviceKeyofAlertChannel. Values derived from them, such as a ping URL built frompingToken, become secrets too;pulumi stack output --show-secretsshows them. - The provider checks lengths and formats in the preview, so some values that the API silently changed or dropped now fail. The upstream guide lists them under Values the API rejects or changes.
CHECKLY_DEBUG_LOGno longer writes API traffic to a file. Use an HTTPS proxy throughHTTPS_PROXYinstead.
Expected changes
The first pulumi up on v3 can update resources in place. The most important cases are:
useGlobalAlertSettingsno longer has a fixed default: it istruewhenalertSettingsisn't set, andfalsewhen it is. Checks, check groups, heartbeats and the TCP, gRPC, SSL and traceroute monitors that set neither switch to the account level alert settings; setuseGlobalAlertSettings: falseto keep their own.UrlMonitor,DnsMonitor,IcmpMonitorandPlaywrightCheckSuitethat setalertSettingsbut notuseGlobalAlertSettingsstart using theiralertSettings; setuseGlobalAlertSettings: trueand removealertSettingsto keep the account level settings. OnCheckGroupV2, the same applies toenforceAlertSettingswhile it is enabled.- Default response time limits match the API:
SslMonitor,TcpMonitor,TcpCheckandTracerouteMonitorthat leave them out get lower limits. Set them to keep the old ones. AlertChannel.autoSubscribeis new and defaults tofalse, which turns off automatic subscription of new checks. Set it totrueto keep it on.- Some properties that v2.x couldn't clear, such as a check's
tagsor a dashboard'slogo, are now cleared when you leave them out. Add values set in the web app to your program to keep them.
The upstream guide lists every case under Expected one-time changes.
Moving to the replacement resources
You can move a deprecated resource to its replacement without recreating it. After your first pulumi up on v3, run pulumi refresh once, so that the stored state of the old resource is in the v3 shape. Then change the resource in your program, add an alias with the old type, and run pulumi up:
new checkly.ApiCheck("my-api-check", {
// The properties of the check, with the type property removed.
}, { aliases: [{ type: "checkly:index/check:Check" }] })
The resource is updated in place. This works for:
ChecktoApiCheck,BrowserCheckorMultistepCheck. Pick the resource that matches the check'stype: the provider can't verify it during the move.ApiCheckdefaultsdegradedResponseTimeandmaxResponseTimeto 5000 and 20000 instead of 15000 and 30000, andrequest.followRedirectstotrueinstead offalse. Set them to keep the previous behaviour.- The per-type resources have no
doubleCheck. Before moving a check that sets it, replace it with the equivalentretryStrategy(typeFIXED,maxRetries: 1,baseBackoffSeconds: 0,maxDurationSeconds: 600,sameRegion: false), or the check stops retrying. - Before moving a browser or multi-step check whose
shouldFailistruein Checkly, removeshouldFailfrom theCheckand runpulumi up, which sets it tofalse.
CheckGrouptoCheckGroupV2. A v2 group doesn't impose settings on its checks unless you enforce them, so read Check groups in the upstream guide first.HeartbeatChecktoHeartbeatMonitor, andTcpChecktoTcpMonitor.
StatusPage and StatusPageService can't be moved: v3 status pages are separate objects in Checkly. Keep them, or create a StatusPageV3 page with StatusPageV3Component resources and then delete the old ones.
Configuration options
The following configuration points are available for the Checkly provider:
checkly:accountId(environment:CHECKLY_ACCOUNT_ID) - your Checkly Account IDcheckly:apiKey(environment:CHECKLY_API_KEY) - your Checkly API Key- If you don't have an API Key, you can create one here.
- Make sure to use the
--secretflag withpulumi config set.
checkly:apiUrl(environment:CHECKLY_API_URL) - for internal development purposes only
Reference
For detailed reference documentation, please visit the Pulumi registry.
Metadata
Release files for pulumi-checkly 3.1.0a1794847445
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pulumi_checkly-3.1.0a1794847445.tar.gz | 273.4 kB | Without provenance | Details for pulumi_checkly-3.1.0a1794847445.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pulumi_checkly-3.1.0a1794847445-py3-none-any.whl | Python 3 | none | any | Details for pulumi_checkly-3.1.0a1794847445-py3-none-any.whl |
Total release size: 576.6 kB
Release files / pulumi_checkly-3.1.0a1794847445.tar.gz
| Download URL | pulumi_checkly-3.1.0a1794847445.tar.gz |
|---|---|
| Size | 273.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6d70b6fe5f8fce6ea63054b40764a6f47d114ef9839a1822a54a04b5763cffcb
|
|
BLAKE2b-256 checksum How to use checksums |
fd4da158693a7ed7c818cac100217bf94e2dc718657647e4c414dbe0ffef169b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.16
|
Release files / pulumi_checkly-3.1.0a1794847445-py3-none-any.whl
| Download URL | pulumi_checkly-3.1.0a1794847445-py3-none-any.whl |
|---|---|
| Size | 303.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
13a257c829d44c8a735c69a53495c972300061010fbddf2a2bfa2cc6996cef52
|
|
BLAKE2b-256 checksum How to use checksums |
563494ee138fe9a6b5039011d13d658dfaa21db00775dfea7c5898b40a046f38
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.16
|
Security for pulumi-checkly 3.1.0a1794847445
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.