@checkly/pulumi 0.0.1-alpha.1 → 0.0.1-alpha.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +125 -4
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,4 +1,125 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
>
|
|
4
|
-
|
|
1
|
+
**⚠️ This project is still in very early stages and breaking change could happen**
|
|
2
|
+
|
|
3
|
+
<p align="center">
|
|
4
|
+
<img width="400px" src="./assets/pulumi.svg" alt="Pulumi" />
|
|
5
|
+
</p>
|
|
6
|
+
|
|
7
|
+
<p>
|
|
8
|
+
<img height="128" src="./assets/checkly.svg" align="right" />
|
|
9
|
+
<h1>Checkly Pulumi Provider</h1>
|
|
10
|
+
</p>
|
|
11
|
+
|
|
12
|
+
> 🟪 Pulumi provider for the [Checkly](https://checklyhq.com) Delightful Active Monitoring
|
|
13
|
+
|
|
14
|
+
<br>
|
|
15
|
+
|
|
16
|
+
## 🪛 Installing
|
|
17
|
+
|
|
18
|
+
This package is only available for JavaScript and TypeScript but support for other languages/platforms, will be available soon.
|
|
19
|
+
|
|
20
|
+
### Node.js (JavaScript/TypeScript)
|
|
21
|
+
|
|
22
|
+
To use from JavaScript or TypeScript in Node.js, install using either `npm`:
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
npm install @pulumi/checkly
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
or `yarn`:
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
yarn add @pulumi/checkly
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
### Python
|
|
35
|
+
> TBA
|
|
36
|
+
|
|
37
|
+
### Go
|
|
38
|
+
> TBA
|
|
39
|
+
|
|
40
|
+
### .NET
|
|
41
|
+
> TBA
|
|
42
|
+
|
|
43
|
+
<br>
|
|
44
|
+
|
|
45
|
+
## 🔑 Authentication
|
|
46
|
+
|
|
47
|
+
The Pulumi Checkly Provider needs to be configured with Checkly `API Key` and `Account ID` before it can be used to create resources.
|
|
48
|
+
|
|
49
|
+
> If you don't have and `API Key`, you can create one [here](https://app.checklyhq.com/settings/user/api-keys).
|
|
50
|
+
|
|
51
|
+
Once you generated the `API Key` there are two ways to communicate your authorization tokens to Pulumi:
|
|
52
|
+
|
|
53
|
+
1. Set the environment variables `CHECKLY_API_KEY` and `CHECKLY_ACCOUNT_ID`:
|
|
54
|
+
```bash
|
|
55
|
+
$ export CHECKLY_API_KEY=cu_xxx
|
|
56
|
+
$ export CHECKLY_ACCOUNT_ID=xxx
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
2. Set them using `pulumi config` command, if you prefer that they be stored alongside your Pulumi stack for easy multi-user access:
|
|
60
|
+
```bash
|
|
61
|
+
$ pulumi config set checkly:apiKey cu_xxx --secret
|
|
62
|
+
$ pulumi config set checkly:accountId xxx
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
> Remember to pass `--secret` when setting `checkly:apiKey` so it is properly encrypted.
|
|
66
|
+
|
|
67
|
+
<br>
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
## 🦝 Creating Resources
|
|
71
|
+
|
|
72
|
+
```javascript
|
|
73
|
+
const checkly = require("@checkly/pulumi")
|
|
74
|
+
|
|
75
|
+
new checkly.Check("api-check", {
|
|
76
|
+
activated: true,
|
|
77
|
+
frequency: 10,
|
|
78
|
+
type: "API",
|
|
79
|
+
request: {
|
|
80
|
+
method: "GET",
|
|
81
|
+
url: "https://checklyhq.com",
|
|
82
|
+
}
|
|
83
|
+
})
|
|
84
|
+
|
|
85
|
+
new checkly.Check("brwoser-check", {
|
|
86
|
+
activated: true,
|
|
87
|
+
frequency: 10,
|
|
88
|
+
type: "BROWSER",
|
|
89
|
+
script: 'console.log("Hello World!")'
|
|
90
|
+
})
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
> Check the `examples` directory for more detailed code samples.
|
|
94
|
+
|
|
95
|
+
## ⚙️ Configuration
|
|
96
|
+
|
|
97
|
+
The following configuration points are available for the `foo` provider:
|
|
98
|
+
|
|
99
|
+
- `checkly:apiKey` (environment: `CHECKLY_API_KEY`) - the Checkly API Key.
|
|
100
|
+
- `checkly:accountId` (environment: `CHECKLY_ACCOUNT_ID`) - the Checkly account ID.
|
|
101
|
+
|
|
102
|
+
<br>
|
|
103
|
+
|
|
104
|
+
## 📖 Reference
|
|
105
|
+
|
|
106
|
+
For detailed reference documentation, please visit [the Pulumi registry](https://www.pulumi.com/registry/packages/checkly/api-docs/).
|
|
107
|
+
|
|
108
|
+
<br>
|
|
109
|
+
|
|
110
|
+
## 📄 License
|
|
111
|
+
|
|
112
|
+
[MIT](https://github.com/checkly/pulumi-checkly/blob/main/LICENSE)
|
|
113
|
+
|
|
114
|
+
<br>
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
<p align="center">
|
|
118
|
+
<a href="https://checklyhq.com?utm_source=github&utm_medium=sponsor-logo-github&utm_campaign=headless-recorder" target="_blank">
|
|
119
|
+
<img width="100px" src="https://www.checklyhq.com/images/text_racoon_logo.svg" alt="Checkly" />
|
|
120
|
+
</a>
|
|
121
|
+
<br />
|
|
122
|
+
<i><sub>Delightful Active Monitoring for Developers</sub></i>
|
|
123
|
+
<br>
|
|
124
|
+
<b><sub>From Checkly with ♥️</sub></b>
|
|
125
|
+
<p>
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@checkly/pulumi",
|
|
3
|
-
"version": "0.0.1-alpha.
|
|
3
|
+
"version": "0.0.1-alpha.2",
|
|
4
4
|
"description": "A Pulumi package for creating and managing Checkly monitoring resources.",
|
|
5
5
|
"main": "./bin/index.js",
|
|
6
6
|
"types": "./bin/index.d.ts",
|
|
@@ -25,6 +25,6 @@
|
|
|
25
25
|
},
|
|
26
26
|
"pulumi": {
|
|
27
27
|
"resource": true,
|
|
28
|
-
"pluginDownloadURL": "https://github.com/checkly/pulumi-checkly/releases/0.0.1-alpha.
|
|
28
|
+
"pluginDownloadURL": "https://github.com/checkly/pulumi-checkly/releases/0.0.1-alpha.2"
|
|
29
29
|
}
|
|
30
30
|
}
|