From d3491090f8b1844d84b8d09394f11f28545b8355 Mon Sep 17 00:00:00 2001 From: stack72 Date: Sat, 28 Nov 2015 01:03:15 +0000 Subject: Adding some documentation for the StatusCake provider --- index.html.markdown | 38 ++++++++++++++++++++++++++++++++++++++ r/test.html.markdown | 40 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 78 insertions(+) create mode 100644 index.html.markdown create mode 100644 r/test.html.markdown 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 @@ +--- +layout: "statuscake" +page_title: "Provider: StatusCake" +sidebar_current: "docs-statuscake-index" +description: |- + The StatusCake provider configures tests in StatusCake. +--- + +# StatusCake Provider + +The StatusCake provider allows Terraform to create and configure tests in [StatusCake](https://www.statuscake.com/). StatusCake is a tool that helps to +monitor the uptime of your service via a network of monitoring centers throughout the world + +The provider configuration block accepts the following arguments: + +* ``username`` - (Required) The username for the statuscake account. May alternatively be set via the + ``STATUSCAKE_USERNAME`` environment variable. + +* ``apikey`` - (Required) The API auth token to use when making requests. May alternatively + be set via the ``STATUSCAKE_APIKEY`` environment variable. + +Use the navigation to the left to read about the available resources. + +## Example Usage + +``` +provider "statuscake" { + username = "testuser" + apikey = "12345ddfnakn" +} + +resource "statuscake_test" "google" { + website_name = "google.com" + website_url = "www.google.com" + test_type = "HTTP" + check_rate = 300 +} +``` diff --git a/r/test.html.markdown b/r/test.html.markdown new file mode 100644 index 0000000..d2d1572 --- /dev/null +++ b/r/test.html.markdown @@ -0,0 +1,40 @@ +--- +layout: "statuscake" +page_title: "StatusCake: statuscake_test" +sidebar_current: "docs-statuscake-test" +description: |- + The statuscake_test resource allows StatusCake tests to be managed by Terraform. +--- + +# statuscake\_test + +The test resource allows StatusCake tests to be managed by Terraform. + +## Example Usage + +``` +resource "statuscake_test" "google" { + website_name = "google.com" + website_url = "www.google.com" + test_type = "HTTP" + check_rate = 300 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `website_name` - (Required) This is the name of the test and the website to be monitored. +* `website_url` - (Required) The URL of the website to be monitored +* `check_rate` - (Optional) Test check rate in seconds. Defaults to 300 +* `test_type` - (Required) The type of Test. Either HTTP or TCP +* `paused` - (Optional) Whether or not the test is paused. Defaults to false. +* `timeout` - (Optional) The timeout of the test in seconds. + + +## Attributes Reference + +The following attribute is exported: + +* `test_id` - A unique identifier for the test. \ No newline at end of file -- cgit v1.2.3 From 6c360ff24fbac9f995af1a8f3cd0e47963a89664 Mon Sep 17 00:00:00 2001 From: Lee Johnson Date: Fri, 10 Jun 2016 13:37:44 -0400 Subject: Updating the documentation on the website source to reflect the addition. --- index.html.markdown | 1 + r/test.html.markdown | 2 ++ 2 files changed, 3 insertions(+) diff --git a/index.html.markdown b/index.html.markdown index 150b36a..443e892 100644 --- a/index.html.markdown +++ b/index.html.markdown @@ -34,5 +34,6 @@ resource "statuscake_test" "google" { website_url = "www.google.com" test_type = "HTTP" check_rate = 300 + contact_id = 12345 } ``` diff --git a/r/test.html.markdown b/r/test.html.markdown index d2d1572..4ad378a 100644 --- a/r/test.html.markdown +++ b/r/test.html.markdown @@ -18,6 +18,7 @@ resource "statuscake_test" "google" { website_url = "www.google.com" test_type = "HTTP" check_rate = 300 + contact_id = 12345 } ``` @@ -28,6 +29,7 @@ The following arguments are supported: * `website_name` - (Required) This is the name of the test and the website to be monitored. * `website_url` - (Required) The URL of the website to be monitored * `check_rate` - (Optional) Test check rate in seconds. Defaults to 300 +* `contact_id` - (Optional) The id of the contact group to be add to the test. Each test can have only one. * `test_type` - (Required) The type of Test. Either HTTP or TCP * `paused` - (Optional) Whether or not the test is paused. Defaults to false. * `timeout` - (Optional) The timeout of the test in seconds. -- cgit v1.2.3 From 8a16ad02d8a16f9f769dc55163908336f244d4d2 Mon Sep 17 00:00:00 2001 From: stack72 Date: Mon, 29 Aug 2016 00:00:27 +0100 Subject: docs/statuscake: Adding the parameter to the docs --- r/test.html.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/r/test.html.markdown b/r/test.html.markdown index d2d1572..1cb0fcc 100644 --- a/r/test.html.markdown +++ b/r/test.html.markdown @@ -31,6 +31,7 @@ The following arguments are supported: * `test_type` - (Required) The type of Test. Either HTTP or TCP * `paused` - (Optional) Whether or not the test is paused. Defaults to false. * `timeout` - (Optional) The timeout of the test in seconds. +* `contact_id` - (Optional) The ID of the contact group to associate with the test. ## Attributes Reference -- cgit v1.2.3 From 8165842a9591ddc81ae7f9a0bd91fa4d51aa01d5 Mon Sep 17 00:00:00 2001 From: Sam Crang Date: Fri, 13 Jan 2017 11:35:15 +0000 Subject: Add support for StatusCake confirmation servers (#11179) * Add support for StatusCake confirmation servers * Add documentation for new StatusCake confirmations argument --- r/test.html.markdown | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/r/test.html.markdown b/r/test.html.markdown index 1cb0fcc..b3cf174 100644 --- a/r/test.html.markdown +++ b/r/test.html.markdown @@ -26,12 +26,13 @@ resource "statuscake_test" "google" { The following arguments are supported: * `website_name` - (Required) This is the name of the test and the website to be monitored. -* `website_url` - (Required) The URL of the website to be monitored -* `check_rate` - (Optional) Test check rate in seconds. Defaults to 300 -* `test_type` - (Required) The type of Test. Either HTTP or TCP +* `website_url` - (Required) The URL of the website to be monitored. +* `check_rate` - (Optional) Test check rate in seconds. Defaults to 300. +* `test_type` - (Required) The type of Test. Either HTTP or TCP. * `paused` - (Optional) Whether or not the test is paused. Defaults to false. * `timeout` - (Optional) The timeout of the test in seconds. * `contact_id` - (Optional) The ID of the contact group to associate with the test. +* `confirmations` - (Optional) The number of confirmation servers to use in order to detect downtime. Defaults to 0. ## Attributes Reference -- cgit v1.2.3 From 46abe9530a669caa00077d66688ae26bc5560238 Mon Sep 17 00:00:00 2001 From: Paul Stack Date: Wed, 15 Feb 2017 23:29:05 +0000 Subject: provider/statuscake: Add support for Port in statuscake_test (#11966) Fixes: #11923 This required the upstream library to have a PR accepted --- r/test.html.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/r/test.html.markdown b/r/test.html.markdown index b566b0e..61ddb3e 100644 --- a/r/test.html.markdown +++ b/r/test.html.markdown @@ -35,6 +35,7 @@ The following arguments are supported: * `timeout` - (Optional) The timeout of the test in seconds. * `contact_id` - (Optional) The ID of the contact group to associate with the test. * `confirmations` - (Optional) The number of confirmation servers to use in order to detect downtime. Defaults to 0. +* `port` - (Optional) The port to use when specifying a TCP test. ## Attributes Reference -- cgit v1.2.3 From 506e71e564ab3c6571b41626133e4eb6842123b3 Mon Sep 17 00:00:00 2001 From: George Christou Date: Sat, 18 Feb 2017 22:48:50 +0000 Subject: website/docs: Run `terraform fmt` on code examples (#12075) * docs/vsphere: Fix code block * docs: Convert `...` to `# ...` to allow `terraform fmt`ing * docs: Trim trailing whitespace * docs: First-pass run of `terraform fmt` on code examples --- index.html.markdown | 16 ++++++++-------- r/test.html.markdown | 10 +++++----- 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/index.html.markdown b/index.html.markdown index 443e892..9a4d0fb 100644 --- a/index.html.markdown +++ b/index.html.markdown @@ -18,22 +18,22 @@ The provider configuration block accepts the following arguments: * ``apikey`` - (Required) The API auth token to use when making requests. May alternatively be set via the ``STATUSCAKE_APIKEY`` environment variable. - + Use the navigation to the left to read about the available resources. ## Example Usage ``` provider "statuscake" { - username = "testuser" - apikey = "12345ddfnakn" + username = "testuser" + apikey = "12345ddfnakn" } resource "statuscake_test" "google" { - website_name = "google.com" - website_url = "www.google.com" - test_type = "HTTP" - check_rate = 300 - contact_id = 12345 + website_name = "google.com" + website_url = "www.google.com" + test_type = "HTTP" + check_rate = 300 + contact_id = 12345 } ``` diff --git a/r/test.html.markdown b/r/test.html.markdown index 61ddb3e..2912afe 100644 --- a/r/test.html.markdown +++ b/r/test.html.markdown @@ -14,11 +14,11 @@ The test resource allows StatusCake tests to be managed by Terraform. ``` resource "statuscake_test" "google" { - website_name = "google.com" - website_url = "www.google.com" - test_type = "HTTP" - check_rate = 300 - contact_id = 12345 + website_name = "google.com" + website_url = "www.google.com" + test_type = "HTTP" + check_rate = 300 + contact_id = 12345 } ``` -- cgit v1.2.3 From c1e00ec2c4975638914bcc15d2d185b0e723b80e Mon Sep 17 00:00:00 2001 From: Paul Stack Date: Mon, 10 Apr 2017 15:58:41 +0300 Subject: provider/statuscake: Adding TriggerRate param to docs (#13503) --- r/test.html.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/r/test.html.markdown b/r/test.html.markdown index 2912afe..1294f95 100644 --- a/r/test.html.markdown +++ b/r/test.html.markdown @@ -36,6 +36,7 @@ The following arguments are supported: * `contact_id` - (Optional) The ID of the contact group to associate with the test. * `confirmations` - (Optional) The number of confirmation servers to use in order to detect downtime. Defaults to 0. * `port` - (Optional) The port to use when specifying a TCP test. +* `trigger_rate` - (Optional) The number of minutes to wait before sending an alert. Default is `5`. ## Attributes Reference -- cgit v1.2.3 From a154e02f1e53d8a4098cd200e9c354b5f11f9060 Mon Sep 17 00:00:00 2001 From: Alex Boyd Date: Tue, 11 Apr 2017 03:07:33 -0600 Subject: nuke duplicate contact_id in statuscake docs (#13528) --- r/test.html.markdown | 1 - 1 file changed, 1 deletion(-) diff --git a/r/test.html.markdown b/r/test.html.markdown index 1294f95..7623d0d 100644 --- a/r/test.html.markdown +++ b/r/test.html.markdown @@ -33,7 +33,6 @@ The following arguments are supported: * `test_type` - (Required) The type of Test. Either HTTP or TCP * `paused` - (Optional) Whether or not the test is paused. Defaults to false. * `timeout` - (Optional) The timeout of the test in seconds. -* `contact_id` - (Optional) The ID of the contact group to associate with the test. * `confirmations` - (Optional) The number of confirmation servers to use in order to detect downtime. Defaults to 0. * `port` - (Optional) The port to use when specifying a TCP test. * `trigger_rate` - (Optional) The number of minutes to wait before sending an alert. Default is `5`. -- cgit v1.2.3 From b8e9f053ea705c1e554dc03778fef494fdd08a10 Mon Sep 17 00:00:00 2001 From: Max Riveiro Date: Mon, 17 Apr 2017 13:17:54 +0300 Subject: Massively add HCL source tag in docs Markdown files Signed-off-by: Max Riveiro --- index.html.markdown | 2 +- r/test.html.markdown | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/index.html.markdown b/index.html.markdown index 9a4d0fb..d25a866 100644 --- a/index.html.markdown +++ b/index.html.markdown @@ -23,7 +23,7 @@ Use the navigation to the left to read about the available resources. ## Example Usage -``` +```hcl provider "statuscake" { username = "testuser" apikey = "12345ddfnakn" diff --git a/r/test.html.markdown b/r/test.html.markdown index 7623d0d..0a1df9f 100644 --- a/r/test.html.markdown +++ b/r/test.html.markdown @@ -12,7 +12,7 @@ The test resource allows StatusCake tests to be managed by Terraform. ## Example Usage -``` +```hcl resource "statuscake_test" "google" { website_name = "google.com" website_url = "www.google.com" -- cgit v1.2.3 From 9d169efde2420e3f07ba5eac26f1daa6713d5308 Mon Sep 17 00:00:00 2001 From: Jake Champlin Date: Fri, 9 Jun 2017 11:32:22 -0400 Subject: Transfer statuscake provider website --- index.html.markdown | 39 --------------------------------- r/test.html.markdown | 45 --------------------------------------- website/docs/index.html.markdown | 39 +++++++++++++++++++++++++++++++++ website/docs/r/test.html.markdown | 45 +++++++++++++++++++++++++++++++++++++++ 4 files changed, 84 insertions(+), 84 deletions(-) delete mode 100644 index.html.markdown delete mode 100644 r/test.html.markdown create mode 100644 website/docs/index.html.markdown create mode 100644 website/docs/r/test.html.markdown diff --git a/index.html.markdown b/index.html.markdown deleted file mode 100644 index d25a866..0000000 --- a/index.html.markdown +++ /dev/null @@ -1,39 +0,0 @@ ---- -layout: "statuscake" -page_title: "Provider: StatusCake" -sidebar_current: "docs-statuscake-index" -description: |- - The StatusCake provider configures tests in StatusCake. ---- - -# StatusCake Provider - -The StatusCake provider allows Terraform to create and configure tests in [StatusCake](https://www.statuscake.com/). StatusCake is a tool that helps to -monitor the uptime of your service via a network of monitoring centers throughout the world - -The provider configuration block accepts the following arguments: - -* ``username`` - (Required) The username for the statuscake account. May alternatively be set via the - ``STATUSCAKE_USERNAME`` environment variable. - -* ``apikey`` - (Required) The API auth token to use when making requests. May alternatively - be set via the ``STATUSCAKE_APIKEY`` environment variable. - -Use the navigation to the left to read about the available resources. - -## Example Usage - -```hcl -provider "statuscake" { - username = "testuser" - apikey = "12345ddfnakn" -} - -resource "statuscake_test" "google" { - website_name = "google.com" - website_url = "www.google.com" - test_type = "HTTP" - check_rate = 300 - contact_id = 12345 -} -``` diff --git a/r/test.html.markdown b/r/test.html.markdown deleted file mode 100644 index 0a1df9f..0000000 --- a/r/test.html.markdown +++ /dev/null @@ -1,45 +0,0 @@ ---- -layout: "statuscake" -page_title: "StatusCake: statuscake_test" -sidebar_current: "docs-statuscake-test" -description: |- - The statuscake_test resource allows StatusCake tests to be managed by Terraform. ---- - -# statuscake\_test - -The test resource allows StatusCake tests to be managed by Terraform. - -## Example Usage - -```hcl -resource "statuscake_test" "google" { - website_name = "google.com" - website_url = "www.google.com" - test_type = "HTTP" - check_rate = 300 - contact_id = 12345 -} -``` - -## Argument Reference - -The following arguments are supported: - -* `website_name` - (Required) This is the name of the test and the website to be monitored. -* `website_url` - (Required) The URL of the website to be monitored -* `check_rate` - (Optional) Test check rate in seconds. Defaults to 300 -* `contact_id` - (Optional) The id of the contact group to be add to the test. Each test can have only one. -* `test_type` - (Required) The type of Test. Either HTTP or TCP -* `paused` - (Optional) Whether or not the test is paused. Defaults to false. -* `timeout` - (Optional) The timeout of the test in seconds. -* `confirmations` - (Optional) The number of confirmation servers to use in order to detect downtime. Defaults to 0. -* `port` - (Optional) The port to use when specifying a TCP test. -* `trigger_rate` - (Optional) The number of minutes to wait before sending an alert. Default is `5`. - - -## Attributes Reference - -The following attribute is exported: - -* `test_id` - A unique identifier for the test. 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 @@ +--- +layout: "statuscake" +page_title: "Provider: StatusCake" +sidebar_current: "docs-statuscake-index" +description: |- + The StatusCake provider configures tests in StatusCake. +--- + +# StatusCake Provider + +The StatusCake provider allows Terraform to create and configure tests in [StatusCake](https://www.statuscake.com/). StatusCake is a tool that helps to +monitor the uptime of your service via a network of monitoring centers throughout the world + +The provider configuration block accepts the following arguments: + +* ``username`` - (Required) The username for the statuscake account. May alternatively be set via the + ``STATUSCAKE_USERNAME`` environment variable. + +* ``apikey`` - (Required) The API auth token to use when making requests. May alternatively + be set via the ``STATUSCAKE_APIKEY`` environment variable. + +Use the navigation to the left to read about the available resources. + +## Example Usage + +```hcl +provider "statuscake" { + username = "testuser" + apikey = "12345ddfnakn" +} + +resource "statuscake_test" "google" { + website_name = "google.com" + website_url = "www.google.com" + test_type = "HTTP" + check_rate = 300 + contact_id = 12345 +} +``` 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 @@ +--- +layout: "statuscake" +page_title: "StatusCake: statuscake_test" +sidebar_current: "docs-statuscake-test" +description: |- + The statuscake_test resource allows StatusCake tests to be managed by Terraform. +--- + +# statuscake\_test + +The test resource allows StatusCake tests to be managed by Terraform. + +## Example Usage + +```hcl +resource "statuscake_test" "google" { + website_name = "google.com" + website_url = "www.google.com" + test_type = "HTTP" + check_rate = 300 + contact_id = 12345 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `website_name` - (Required) This is the name of the test and the website to be monitored. +* `website_url` - (Required) The URL of the website to be monitored +* `check_rate` - (Optional) Test check rate in seconds. Defaults to 300 +* `contact_id` - (Optional) The id of the contact group to be add to the test. Each test can have only one. +* `test_type` - (Required) The type of Test. Either HTTP or TCP +* `paused` - (Optional) Whether or not the test is paused. Defaults to false. +* `timeout` - (Optional) The timeout of the test in seconds. +* `confirmations` - (Optional) The number of confirmation servers to use in order to detect downtime. Defaults to 0. +* `port` - (Optional) The port to use when specifying a TCP test. +* `trigger_rate` - (Optional) The number of minutes to wait before sending an alert. Default is `5`. + + +## Attributes Reference + +The following attribute is exported: + +* `test_id` - A unique identifier for the test. -- cgit v1.2.3