@checkly/pulumi 0.0.1-alpha.1 → 0.0.1-alpha.10

package/README.md

@@ -1,4 +1,151 @@
-> This provider is a derived work of the [Terraform Provider](https://github.com/checkly/terraform-provider-checkly)
-> distributed under [MPL 2.0](https://www.mozilla.org/en-US/MPL/2.0/). If you encounter a bug or missing feature,
-> first check the [`pulumi/pulumi-checkly` repo](https://github.com/pulumi/pulumi-checkly/issues); however, if that doesn't turn up anything,
-> please consult the source [`checkly/terraform-provider-checkly` repo](https://github.com/checkly/terraform-provider-checkly/issues).
+# Checkly Pulumi Provider
+
+The Checkly Pulumi provider enables you to create and configure Checkly resources using your favourite programming language.
+Note that this project is in its early stages and breaking changes could happen.
+
+## Installation
+
+1. To use this package, please [install the Pulumi CLI first](https://www.pulumi.com/docs/get-started/install/).
+2. This package is only available for JavaScript and TypeScript but support for other languages will be available soon.
+
+### Node.js (JavaScript/TypeScript)
+
+To use from JavaScript or TypeScript in Node.js, install using either `npm`:
+
+```bash
+npm install @checkly/pulumi
+```
+
+or `yarn`:
+
+```bash
+yarn add @checkly/pulumi
+```
+
+Install the provider binary plugin. This is only needed due to an outstanding bug in with Pulumi registry
+
+```bash
+pulumi plugin install resource checkly v0.0.1-alpha.5 --server https://github.com/checkly/pulumi-checkly/releases/download/v0.0.1-alpha.5
+```
+
+### Python, Go & .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](https://app.checklyhq.com/settings/user/api-keys).
+
+Once you generated the `API Key` there are two ways to communicate your authorization tokens to Pulumi:
+
+1. Set the environment variables `CHECKLY_API_KEY` and `CHECKLY_ACCOUNT_ID`:
+    ```bash
+    $ export CHECKLY_API_KEY=cu_xxx
+    $ export CHECKLY_ACCOUNT_ID=xxx
+    ```
+
+2. Set them using `pulumi config` command, if you prefer that they be stored alongside your Pulumi stack for easy multi-user access:
+    ```bash
+    $ 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
+
+The example below shows a basic API check and Browser check.
+
+```javascript
+// index.js
+const checkly = require("@checkly/pulumi")
+
+new checkly.Check("api-check", {
+  type: "API",
+  name: "Public SpaceX API",
+  activated: true,
+  frequency: 10,
+  locations: ["us-east-1"],
+  request: {
+    method: "GET",
+    url: "https://api.spacexdata.com/v3",
+    assertions: [
+      {
+        source: 'STATUS_CODE',
+        comparison: 'EQUALS',
+        target: 200
+      },
+      {
+        source: 'JSON_BODY',
+        property: '$.project_name',
+        comparison: 'EQUALS',
+        target: 'SpaceX-API'
+      }
+    ]
+  }
+})
+
+new checkly.Check("browser-check", {
+  type: "BROWSER",
+  name: "Google.com Playwright check",
+  activated: true,
+  frequency: 10,
+  locations: ["us-east-1"],
+  script: `const { chromium } = require('playwright')
+
+async function run () {
+  const browser = await chromium.launch()
+  const page = await browser.newPage()
+
+  const response = await page.goto('https://google.com')
+
+  if (response.status() > 399) {
+    throw new Error('Failed with response code ${response.status()}')
+  }
+
+  await page.screenshot({ path: 'screenshot.jpg' })
+
+  await page.close()
+  await browser.close()
+}
+
+run()`
+})
+```
+
+> Check the [examples directory](https://github.com/checkly/pulumi-checkly/tree/main/examples) for more detailed code samples.
+
+## Syncing resources
+
+Just run the regular `pulumi up` command
+
+
+## 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](https://www.pulumi.com/registry/packages/checkly/api-docs/).
+
+## License
+
+[MIT](https://github.com/checkly/pulumi-checkly/blob/main/LICENSE)
+
+<br>
+
+
+<p align="center">
+  <a href="https://checklyhq.com?utm_source=github&utm_medium=sponsor-logo-github&utm_campaign=pulumi-checkly" target="_blank">
+  <img width="100px" src="https://www.checklyhq.com/images/text_racoon_logo.svg" alt="Checkly" />
+  </a>
+  <br />
+  <i><sub>Delightful Active Monitoring for Developers</sub></i>
+  <br>
+  <b><sub>From Checkly with ♥️</sub></b>
+<p>

package/alertChannel.ts

@@ -6,133 +6,68 @@ import { input as inputs, output as outputs } from "./types";
 import * as utilities from "./utilities";
 
 /**
- * ## # checkly.AlertChannel
- *
- * The `checkly.AlertChannel` resource allows users to manage Checkly alert channels.
- *
- * Checkly's Alert Channels feature allows you to define global alerting channels for the checks in your account:
+ * Allows you to define alerting channels for the checks and groups in your account
  *
  * ## Example Usage
  *
- * *An Email alert channel*
  * ```typescript
  * import * as pulumi from "@pulumi/pulumi";
- * import * as checkly from "@pulumi/checkly";
+ * import * as pulumi from "@checkly/pulumi";
  *
- * const emailAc = new checkly.AlertChannel("email_ac", {
+ * // An Email alert channel
+ * const emailAc = new checkly.AlertChannel("emailAc", {
  *     email: {
  *         address: "john@example.com",
  *     },
- *     sendDegraded: true,
- *     sendFailure: false,
  *     sendRecovery: true,
+ *     sendFailure: false,
+ *     sendDegraded: true,
  *     sslExpiry: true,
  *     sslExpiryThreshold: 22,
  * });
- * ```
- *
- * *A SMS alert channel*
- * ```typescript
- * import * as pulumi from "@pulumi/pulumi";
- * import * as checkly from "@pulumi/checkly";
- *
- * const smsAc = new checkly.AlertChannel("sms_ac", {
- *     sendFailure: true,
- *     sendRecovery: true,
+ * // A SMS alert channel
+ * const smsAc = new checkly.AlertChannel("smsAc", {
  *     sms: {
  *         name: "john",
- *         number: "0123456789",
- *     },
- * });
- * ```
- *
- * *A Slack alert channel*
- * ```typescript
- * import * as pulumi from "@pulumi/pulumi";
- * import * as checkly from "@pulumi/checkly";
- *
- * const slackAc = new checkly.AlertChannel("slack_ac", {
- *     slack: {
- *         channel: "#checkly-notifications",
- *         url: "https://slack.com/webhook",
- *     },
- * });
- * ```
- *
- * *An Opsgenie alert channel*
- * ```typescript
- * import * as pulumi from "@pulumi/pulumi";
- * import * as checkly from "@pulumi/checkly";
- *
- * const opsgenieAc = new checkly.AlertChannel("opsgenie_ac", {
- *     opsgenie: {
- *         apiKey: "fookey",
- *         name: "opsalerts",
- *         priority: "foopriority",
- *         region: "fooregion",
- *     },
- * });
- * ```
- *
- * *An Pagerduty alert channel*
- * ```typescript
- * import * as pulumi from "@pulumi/pulumi";
- * import * as checkly from "@pulumi/checkly";
- *
- * const pagerdutyAc = new checkly.AlertChannel("pagerduty_ac", {
- *     pagerduty: {
- *         account: "checkly",
- *         serviceKey: "key1",
- *         serviceName: "pdalert",
- *     },
- * });
- * ```
- *
- * *An Webhook alert channel*
- * ```typescript
- * import * as pulumi from "@pulumi/pulumi";
- * import * as checkly from "@pulumi/checkly";
- *
- * const webhookAc = new checkly.AlertChannel("webhook_ac", {
- *     webhook: {
- *         method: "get",
- *         name: "foo",
- *         template: "footemplate",
- *         url: "http://example.com/foo",
- *         webhookSecret: "foosecret",
+ *         number: "+5491100001111",
  *     },
+ *     sendRecovery: true,
+ *     sendFailure: true,
  * });
- * ```
- *
- * *Connecting the alert channel to a check
- * ```typescript
- * import * as pulumi from "@pulumi/pulumi";
- * import * as checkly from "@pulumi/checkly";
- *
+ * // A Slack alert channel
+ * const slackAc = new checkly.AlertChannel("slackAc", {slack: {
+ *     channel: "#checkly-notifications",
+ *     url: "https://slack.com/webhook",
+ * }});
+ * // An Opsgenie alert channel
+ * const opsgenieAc = new checkly.AlertChannel("opsgenieAc", {opsgenie: {
+ *     name: "opsalerts",
+ *     apiKey: "fookey",
+ *     region: "fooregion",
+ *     priority: "foopriority",
+ * }});
+ * // An Pagerduty alert channel
+ * const pagerdutyAc = new checkly.AlertChannel("pagerdutyAc", {pagerduty: {
+ *     account: "checkly",
+ *     serviceKey: "key1",
+ *     serviceName: "pdalert",
+ * }});
+ * // An Webhook alert channel
+ * const webhookAc = new checkly.AlertChannel("webhookAc", {webhook: {
+ *     name: "foo",
+ *     method: "get",
+ *     template: "footemplate",
+ *     url: "https://example.com/foo",
+ *     webhookSecret: "foosecret",
+ * }});
+ * // Connecting the alert channel to a check
  * const example_check = new checkly.Check("example-check", {alertChannelSubscriptions: [
  *     {
- *         channelId: checkly_alert_channel.email_ac.id,
- *         activated: true,
- *     },
- *     {
- *         channelId: checkly_alert_channel.sms_ac.id,
- *         activated: true,
- *     },
- * ]});
- * ```
- *
- * *Connecting the alert channel to a check group
- * ```typescript
- * import * as pulumi from "@pulumi/pulumi";
- * import * as checkly from "@pulumi/checkly";
- *
- * const test_group1 = new checkly.CheckGroup("test-group1", {alertChannelSubscriptions: [
- *     {
- *         channelId: checkly_alert_channel.email_ac.id,
+ *         channelId: emailAc.id,
  *         activated: true,
  *     },
  *     {
- *         channelId: checkly_alert_channel.sms_ac.id,
+ *         channelId: smsAc.id,
  *         activated: true,
  *     },
  * ]});
@@ -166,35 +101,29 @@ export class AlertChannel extends pulumi.CustomResource {
         return obj['__pulumiType'] === AlertChannel.__pulumiType;
     }
 
-    /**
-     * :
-     */
     public readonly email!: pulumi.Output<outputs.AlertChannelEmail | undefined>;
     public readonly opsgenie!: pulumi.Output<outputs.AlertChannelOpsgenie | undefined>;
     public readonly pagerduty!: pulumi.Output<outputs.AlertChannelPagerduty | undefined>;
     /**
-     * . Possible values: `true` | `false`.
+     * (Default `false`)
      */
     public readonly sendDegraded!: pulumi.Output<boolean | undefined>;
     /**
-     * . Possible values: `true` | `false`.
+     * (Default `true`)
      */
     public readonly sendFailure!: pulumi.Output<boolean | undefined>;
     /**
-     * . Possible values: `true` | `false`.
+     * (Default `true`)
      */
     public readonly sendRecovery!: pulumi.Output<boolean | undefined>;
     public readonly slack!: pulumi.Output<outputs.AlertChannelSlack | undefined>;
-    /**
-     * :
-     */
     public readonly sms!: pulumi.Output<outputs.AlertChannelSms | undefined>;
     /**
-     * . Possible values: `true` | `false`.
+     * (Default `false`)
      */
     public readonly sslExpiry!: pulumi.Output<boolean | undefined>;
     /**
-     * . Possible values between 1 and 30. Default is `30`.
+     * Value must be between 1 and 30 (Default `30`)
      */
     public readonly sslExpiryThreshold!: pulumi.Output<number | undefined>;
     public readonly webhook!: pulumi.Output<outputs.AlertChannelWebhook | undefined>;
@@ -237,9 +166,7 @@ export class AlertChannel extends pulumi.CustomResource {
             resourceInputs["sslExpiryThreshold"] = args ? args.sslExpiryThreshold : undefined;
             resourceInputs["webhook"] = args ? args.webhook : undefined;
         }
-        if (!opts.version) {
-            opts = pulumi.mergeOptions(opts, { version: utilities.getVersion()});
-        }
+        opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
         super(AlertChannel.__pulumiType, name, resourceInputs, opts);
     }
 }
@@ -248,35 +175,29 @@ export class AlertChannel extends pulumi.CustomResource {
  * Input properties used for looking up and filtering AlertChannel resources.
  */
 export interface AlertChannelState {
-    /**
-     * :
-     */
     email?: pulumi.Input<inputs.AlertChannelEmail>;
     opsgenie?: pulumi.Input<inputs.AlertChannelOpsgenie>;
     pagerduty?: pulumi.Input<inputs.AlertChannelPagerduty>;
     /**
-     * . Possible values: `true` | `false`.
+     * (Default `false`)
      */
     sendDegraded?: pulumi.Input<boolean>;
     /**
-     * . Possible values: `true` | `false`.
+     * (Default `true`)
      */
     sendFailure?: pulumi.Input<boolean>;
     /**
-     * . Possible values: `true` | `false`.
+     * (Default `true`)
      */
     sendRecovery?: pulumi.Input<boolean>;
     slack?: pulumi.Input<inputs.AlertChannelSlack>;
-    /**
-     * :
-     */
     sms?: pulumi.Input<inputs.AlertChannelSms>;
     /**
-     * . Possible values: `true` | `false`.
+     * (Default `false`)
      */
     sslExpiry?: pulumi.Input<boolean>;
     /**
-     * . Possible values between 1 and 30. Default is `30`.
+     * Value must be between 1 and 30 (Default `30`)
      */
     sslExpiryThreshold?: pulumi.Input<number>;
     webhook?: pulumi.Input<inputs.AlertChannelWebhook>;
@@ -286,35 +207,29 @@ export interface AlertChannelState {
  * The set of arguments for constructing a AlertChannel resource.
  */
 export interface AlertChannelArgs {
-    /**
-     * :
-     */
     email?: pulumi.Input<inputs.AlertChannelEmail>;
     opsgenie?: pulumi.Input<inputs.AlertChannelOpsgenie>;
     pagerduty?: pulumi.Input<inputs.AlertChannelPagerduty>;
     /**
-     * . Possible values: `true` | `false`.
+     * (Default `false`)
      */
     sendDegraded?: pulumi.Input<boolean>;
     /**
-     * . Possible values: `true` | `false`.
+     * (Default `true`)
      */
     sendFailure?: pulumi.Input<boolean>;
     /**
-     * . Possible values: `true` | `false`.
+     * (Default `true`)
      */
     sendRecovery?: pulumi.Input<boolean>;
     slack?: pulumi.Input<inputs.AlertChannelSlack>;
-    /**
-     * :
-     */
     sms?: pulumi.Input<inputs.AlertChannelSms>;
     /**
-     * . Possible values: `true` | `false`.
+     * (Default `false`)
      */
     sslExpiry?: pulumi.Input<boolean>;
     /**
-     * . Possible values between 1 and 30. Default is `30`.
+     * Value must be between 1 and 30 (Default `30`)
      */
     sslExpiryThreshold?: pulumi.Input<number>;
     webhook?: pulumi.Input<inputs.AlertChannelWebhook>;

package/bin/README.md

@@ -1,78 +1,139 @@
-**🚨 This project is still in very early stages and is not stable, _use at your own risk_! 🚨**
+# Checkly Pulumi Provider
 
-<p align="center">
-  <img width="400px" src="./assets/pulumi.svg" alt="Pulumi" />
-</p>
-
-<p>
-  <img height="128" src="./assets/checkly.svg" align="right" />
-  <h1>Checkly Pulumi Provider</h1>
-</p>
+The Checkly Pulumi provider enables you to create and configure Checkly resources using your favourite programming language.
+Note that this project is in its early stages and breaking changes could happen.
 
-> 🟪 Pulumi provider for the [Checkly](https://checklyhq.com) Delightful Active Monitoring
-
-<br>
+## Installation
 
-## 🪛 Installing
-
-This package is available for several languages/platforms:
+1. To use this package, please [install the Pulumi CLI first](https://www.pulumi.com/docs/get-started/install/).
+2. This package is only available for JavaScript and TypeScript but support for other languages will be available soon.
 
 ### Node.js (JavaScript/TypeScript)
 
 To use from JavaScript or TypeScript in Node.js, install using either `npm`:
 
 ```bash
-npm install @pulumi/checkly
+npm install @checkly/pulumi
 ```
 
 or `yarn`:
 
 ```bash
-yarn add @pulumi/checkly
+yarn add @checkly/pulumi
 ```
 
-### Python
-
-To use from Python, install using `pip`:
+Install the provider binary plugin. This is only needed due to an outstanding bug in with Pulumi registry
 
 ```bash
-pip install pulumi_checkly
+pulumi plugin install resource checkly v0.0.1-alpha.5 --server https://github.com/checkly/pulumi-checkly/releases/download/v0.0.1-alpha.5
 ```
 
-### Go
-
-To use from Go, use `go get` to grab the latest version of the library:
-
-```bash
-go get github.com/pulumi/pulumi-checkly/sdk/go/...
+### Python, Go & .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](https://app.checklyhq.com/settings/user/api-keys).
+
+Once you generated the `API Key` there are two ways to communicate your authorization tokens to Pulumi:
+
+1. Set the environment variables `CHECKLY_API_KEY` and `CHECKLY_ACCOUNT_ID`:
+    ```bash
+    $ export CHECKLY_API_KEY=cu_xxx
+    $ export CHECKLY_ACCOUNT_ID=xxx
+    ```
+
+2. Set them using `pulumi config` command, if you prefer that they be stored alongside your Pulumi stack for easy multi-user access:
+    ```bash
+    $ 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
+
+The example below shows a basic API check and Browser check.
+
+```javascript
+// index.js
+const checkly = require("@checkly/pulumi")
+
+new checkly.Check("api-check", {
+  type: "API",
+  name: "Public SpaceX API",
+  activated: true,
+  frequency: 10,
+  locations: ["us-east-1"],
+  request: {
+    method: "GET",
+    url: "https://api.spacexdata.com/v3",
+    assertions: [
+      {
+        source: 'STATUS_CODE',
+        comparison: 'EQUALS',
+        target: 200
+      },
+      {
+        source: 'JSON_BODY',
+        property: '$.project_name',
+        comparison: 'EQUALS',
+        target: 'SpaceX-API'
+      }
+    ]
+  }
+})
+
+new checkly.Check("browser-check", {
+  type: "BROWSER",
+  name: "Google.com Playwright check",
+  activated: true,
+  frequency: 10,
+  locations: ["us-east-1"],
+  script: `const { chromium } = require('playwright')
+
+async function run () {
+  const browser = await chromium.launch()
+  const page = await browser.newPage()
+
+  const response = await page.goto('https://google.com')
+
+  if (response.status() > 399) {
+    throw new Error('Failed with response code ${response.status()}')
+  }
+
+  await page.screenshot({ path: 'screenshot.jpg' })
+
+  await page.close()
+  await browser.close()
+}
+
+run()`
+})
 ```
 
-### .NET
+> Check the [examples directory](https://github.com/checkly/pulumi-checkly/tree/main/examples) for more detailed code samples.
 
-To use from .NET, install using `dotnet add package`:
+## Syncing resources
 
-```bash
-dotnet add package Pulumi.Checkly
-```
+Just run the regular `pulumi up` command
 
-<br>
 
-## ⚙️  Configuration
+## 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.
 
-<br>
-
-## 📖 Reference
+## Reference
 
 For detailed reference documentation, please visit [the Pulumi registry](https://www.pulumi.com/registry/packages/checkly/api-docs/).
 
-<br>
-
-## 📄 License
+## License
 
 [MIT](https://github.com/checkly/pulumi-checkly/blob/main/LICENSE)
 
@@ -80,7 +141,7 @@ For detailed reference documentation, please visit [the Pulumi registry](https:/
 
 
 <p align="center">
-  <a href="https://checklyhq.com?utm_source=github&utm_medium=sponsor-logo-github&utm_campaign=headless-recorder" target="_blank">
+  <a href="https://checklyhq.com?utm_source=github&utm_medium=sponsor-logo-github&utm_campaign=pulumi-checkly" target="_blank">
   <img width="100px" src="https://www.checklyhq.com/images/text_racoon_logo.svg" alt="Checkly" />
   </a>
   <br />