Adding some documentation for the StatusCake provider

This commit is contained in:
stack72 2015-11-28 01:03:15 +00:00
parent 88325c3a8c
commit 3ecf722b77
5 changed files with 109 additions and 0 deletions

View File

@ -22,6 +22,7 @@ body.layout-mailgun,
body.layout-openstack,
body.layout-packet,
body.layout-rundeck,
body.layout-statuscake,
body.layout-template,
body.layout-tls,
body.layout-vsphere,

View File

@ -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
}
```

View File

@ -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.

View File

@ -185,6 +185,10 @@
<a href="/docs/providers/rundeck/index.html">Rundeck</a>
</li>
<li<%= sidebar_current("docs-providers-statuscake") %>>
<a href="/docs/providers/statuscake/index.html">StatusCake</a>
</li>
<li<%= sidebar_current("docs-providers-template") %>>
<a href="/docs/providers/template/index.html">Template</a>
</li>

View File

@ -0,0 +1,26 @@
<% wrap_layout :inner do %>
<% content_for :sidebar do %>
<div class="docs-sidebar hidden-print affix-top" role="complementary">
<ul class="nav docs-sidenav">
<li<%= sidebar_current("docs-home") %>>
<a href="/docs/providers/index.html">&laquo; Documentation Home</a>
</li>
<li<%= sidebar_current("docs-statuscake-index") %>>
<a href="/docs/providers/statuscake/index.html">StatusCake Provider</a>
</li>
<li<%= sidebar_current(/^docs-statuscake-resource/) %>>
<a href="#">Resources</a>
<ul class="nav nav-visible">
<li<%= sidebar_current("docs-statuscake-test") %>>
<a href="/docs/providers/statuscake/r/test.html">statuscake_test</a>
</li>
</ul>
</li>
</ul>
</div>
<% end %>
<%= yield %>
<% end %>