diff options
-rw-r--r-- | website/docs/index.html.markdown | 39 | ||||
-rw-r--r-- | website/docs/r/test.html.markdown | 45 |
2 files changed, 84 insertions, 0 deletions
diff --git a/website/docs/index.html.markdown b/website/docs/index.html.markdown new file mode 100644 index 0000000..d25a866 --- /dev/null +++ b/website/docs/index.html.markdown | |||
@@ -0,0 +1,39 @@ | |||
1 | --- | ||
2 | layout: "statuscake" | ||
3 | page_title: "Provider: StatusCake" | ||
4 | sidebar_current: "docs-statuscake-index" | ||
5 | description: |- | ||
6 | The StatusCake provider configures tests in StatusCake. | ||
7 | --- | ||
8 | |||
9 | # StatusCake Provider | ||
10 | |||
11 | The StatusCake provider allows Terraform to create and configure tests in [StatusCake](https://www.statuscake.com/). StatusCake is a tool that helps to | ||
12 | monitor the uptime of your service via a network of monitoring centers throughout the world | ||
13 | |||
14 | The 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 | |||
22 | Use the navigation to the left to read about the available resources. | ||
23 | |||
24 | ## Example Usage | ||
25 | |||
26 | ```hcl | ||
27 | provider "statuscake" { | ||
28 | username = "testuser" | ||
29 | apikey = "12345ddfnakn" | ||
30 | } | ||
31 | |||
32 | resource "statuscake_test" "google" { | ||
33 | website_name = "google.com" | ||
34 | website_url = "www.google.com" | ||
35 | test_type = "HTTP" | ||
36 | check_rate = 300 | ||
37 | contact_id = 12345 | ||
38 | } | ||
39 | ``` | ||
diff --git a/website/docs/r/test.html.markdown b/website/docs/r/test.html.markdown new file mode 100644 index 0000000..0a1df9f --- /dev/null +++ b/website/docs/r/test.html.markdown | |||
@@ -0,0 +1,45 @@ | |||
1 | --- | ||
2 | layout: "statuscake" | ||
3 | page_title: "StatusCake: statuscake_test" | ||
4 | sidebar_current: "docs-statuscake-test" | ||
5 | description: |- | ||
6 | The statuscake_test resource allows StatusCake tests to be managed by Terraform. | ||
7 | --- | ||
8 | |||
9 | # statuscake\_test | ||
10 | |||
11 | The test resource allows StatusCake tests to be managed by Terraform. | ||
12 | |||
13 | ## Example Usage | ||
14 | |||
15 | ```hcl | ||
16 | resource "statuscake_test" "google" { | ||
17 | website_name = "google.com" | ||
18 | website_url = "www.google.com" | ||
19 | test_type = "HTTP" | ||
20 | check_rate = 300 | ||
21 | contact_id = 12345 | ||
22 | } | ||
23 | ``` | ||
24 | |||
25 | ## Argument Reference | ||
26 | |||
27 | The following arguments are supported: | ||
28 | |||
29 | * `website_name` - (Required) This is the name of the test and the website to be monitored. | ||
30 | * `website_url` - (Required) The URL of the website to be monitored | ||
31 | * `check_rate` - (Optional) Test check rate in seconds. Defaults to 300 | ||
32 | * `contact_id` - (Optional) The id of the contact group to be add to the test. Each test can have only one. | ||
33 | * `test_type` - (Required) The type of Test. Either HTTP or TCP | ||
34 | * `paused` - (Optional) Whether or not the test is paused. Defaults to false. | ||
35 | * `timeout` - (Optional) The timeout of the test in seconds. | ||
36 | * `confirmations` - (Optional) The number of confirmation servers to use in order to detect downtime. Defaults to 0. | ||
37 | * `port` - (Optional) The port to use when specifying a TCP test. | ||
38 | * `trigger_rate` - (Optional) The number of minutes to wait before sending an alert. Default is `5`. | ||
39 | |||
40 | |||
41 | ## Attributes Reference | ||
42 | |||
43 | The following attribute is exported: | ||
44 | |||
45 | * `test_id` - A unique identifier for the test. | ||