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