aboutsummaryrefslogtreecommitdiffhomepage
path: root/index.html.markdown
diff options
context:
space:
mode:
authorstack72 <public@paulstack.co.uk>2015-11-28 01:03:15 +0000
committerstack72 <public@paulstack.co.uk>2015-11-30 10:44:21 +0000
commitd3491090f8b1844d84b8d09394f11f28545b8355 (patch)
tree791cd241f065a8a8bd70b01714ffc347adcfe5d0 /index.html.markdown
downloadterraform-provider-statuscake-d3491090f8b1844d84b8d09394f11f28545b8355.tar.gz
terraform-provider-statuscake-d3491090f8b1844d84b8d09394f11f28545b8355.tar.zst
terraform-provider-statuscake-d3491090f8b1844d84b8d09394f11f28545b8355.zip
Adding some documentation for the StatusCake provider
Diffstat (limited to 'index.html.markdown')
-rw-r--r--index.html.markdown38
1 files changed, 38 insertions, 0 deletions
diff --git a/index.html.markdown b/index.html.markdown
new file mode 100644
index 0000000..150b36a
--- /dev/null
+++ b/index.html.markdown
@@ -0,0 +1,38 @@
1---
2layout: "statuscake"
3page_title: "Provider: StatusCake"
4sidebar_current: "docs-statuscake-index"
5description: |-
6 The StatusCake provider configures tests in StatusCake.
7---
8
9# StatusCake Provider
10
11The StatusCake provider allows Terraform to create and configure tests in [StatusCake](https://www.statuscake.com/). StatusCake is a tool that helps to
12monitor the uptime of your service via a network of monitoring centers throughout the world
13
14The provider configuration block accepts the following arguments:
15
16* ``username`` - (Required) The username for the statuscake account. May alternatively be set via the
17 ``STATUSCAKE_USERNAME`` environment variable.
18
19* ``apikey`` - (Required) The API auth token to use when making requests. May alternatively
20 be set via the ``STATUSCAKE_APIKEY`` environment variable.
21
22Use the navigation to the left to read about the available resources.
23
24## Example Usage
25
26```
27provider "statuscake" {
28 username = "testuser"
29 apikey = "12345ddfnakn"
30}
31
32resource "statuscake_test" "google" {
33 website_name = "google.com"
34 website_url = "www.google.com"
35 test_type = "HTTP"
36 check_rate = 300
37}
38```