Skip to content
This repository has been archived by the owner on Jun 11, 2024. It is now read-only.

Commit

Permalink
Finish docs
Browse files Browse the repository at this point in the history
  • Loading branch information
louy committed Jun 3, 2018
1 parent dd4cfbb commit 0a9cd83
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 15 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,12 @@ resource "uptimerobot_monitor" "main" {
}
resource "uptimerobot_status_page" "main" {
friendly_name = "My Status Page"
custom_domain = "status.example.com"
password = "WeAreAwsome"
sort_monitors = "down-up-paused"
monitors = ["${resource.uptimerobot_monitor.main.id}"]
hide_logo = false # pro only
friendly_name = "My Status Page"
custom_domain = "status.example.com"
password = "WeAreAwsome"
sort_monitors = "down-up-paused"
monitors = ["${resource.uptimerobot_monitor.main.id}"]
hide_url_links = false # pro only
}
resource "aws_route53_record" {
Expand Down
26 changes: 23 additions & 3 deletions website/docs/r/monitor.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,31 @@ resource "uptimerobot_monitor" "my_website" {

## Arguments Reference

TODO
* `friendly_name` - friendly name of the monitor (for making it easier to distinguish from others).
* `url` - the URL/IP of the monitor.
* `type` - the type of the monitor. Can be one of the following:
- *`http`*
- *`keyword`* - will also enable the following options:
- `keyword_type` - if the monitor will be flagged as down when the keyword exists or not exists. Can be one of the following:
- `exists`
- `not exists`
- `keyword_value` - the value of the keyword.
- *`ping`*
- *`port`* - will also enable the following options:
- `sub_type` - which pre-defined port/service is monitored or if a custom port is monitored. Can be one of the following:
- `http`
- `https`
- `ftp`
- `smtp`
- `pop3`
- `imap`
- `custom`
- `port` - the port monitored (only if subtype is `custom`)
* `http_username` - used for password-protected web pages (HTTP Basic Auth). Available for HTTP and keyword monitoring.
* `http_password` - used for password-protected web pages (HTTP Basic Auth). Available for HTTP and keyword monitoring.
* `interval` - the interval for the monitoring check (300 seconds by default).

## Attributes Reference

* `id` - the ID of the monitor (can be used for monitor-specific requests)
* `status` - the status of the monitor (`paused`, `not checked yet`, `up`, `seems down`, or `down`)

TODO
12 changes: 6 additions & 6 deletions website/docs/r/status_page.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ Use this resource to create a status page

```hcl
resource "uptimerobot_status_page" "my_status_page" {
friendly_name = "My Status Page"
custom_domain = "status.example.com"
password = "WeAreAwsome"
sort_monitors = "down-up-paused"
monitors = ["${resource.uptimerobot_monitor.main.id}"]
hide_logo = false # pro only
friendly_name = "My Status Page"
custom_domain = "status.example.com"
password = "WeAreAwsome"
sort_monitors = "down-up-paused"
monitors = ["${resource.uptimerobot_monitor.main.id}"]
hide_url_links = true # pro only
}
```

Expand Down

0 comments on commit 0a9cd83

Please sign in to comment.