Skip to content

Commit 9b7c027

Browse files
committed
Update documentation for Terraform registry
1 parent 4d10b43 commit 9b7c027

File tree

4 files changed

+120
-0
lines changed

4 files changed

+120
-0
lines changed
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
layout: "statuspage"
3+
page_title: "Statuspage: statuspage_component_group"
4+
sidebar_current: "docs-statuspage-component-group"
5+
description: |-
6+
Statuspage component_group in the Terraform provider Statuspage.
7+
---
8+
9+
# statuspage_component_group
10+
11+
Statuspage component group in the Terraform provider Statuspage.
12+
13+
## Example Usage
14+
15+
```hcl
16+
resource "statuspage_component_group" "my_group" {
17+
page_id = "pageid"
18+
name = "terraform"
19+
description = "Created by terraform"
20+
components = ["${statuspage_component.my_component.id}"]
21+
}
22+
```
23+
24+
## Argument Reference
25+
26+
The following arguments are supported:
27+
28+
* page_id - (Required) the id of the page this component belongs to
29+
* components - (Required) List of component IDs
30+
* name - (Required) name of the component group
31+
* description - description of the component group
32+
33+
## Import Example Usage
34+
35+
```sh
36+
terraform import statuspage_component_group.my_group my-page-id/my-component-group-id
37+
```
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
layout: "statuspage"
3+
page_title: "Statuspage: statuspage_metrics"
4+
sidebar_current: "docs-statuspage-metrics"
5+
description: |-
6+
Statuspage metrics in the Terraform provider Statuspage.
7+
---
8+
9+
# statuspage_metrics
10+
11+
Statuspage metrics in the Terraform provider Statuspage.
12+
13+
## Example Usage
14+
15+
```hcl
16+
resource "statuspage_metric" "website_metrics" {
17+
page_id = "pageid"
18+
metrics_provider_id = "${statuspage_metrics_provider.statuspage_pingdom.id}"
19+
name = "My Website"
20+
metric_identifier = "pingdom_check_id"
21+
}
22+
```
23+
24+
## Argument Reference
25+
26+
The following arguments are supported:
27+
28+
* page_id - (Required) the id of the page this component belongs to
29+
* name - Name of metric
30+
* metric_identifier - The identifier used to look up the metric data from the provider
31+
* transform - The transform to apply to metric before pulling into Statuspage. One of: "average", "count", "max", "min", "sum", "response_time", "uptime". For pingdom metrics_provider allowed values are "response_time" and "uptime".
32+
* suffix - Suffix to describe the units on the graph
33+
* y_axis_min - The lower bound of the y axis
34+
* y_axis_max - The upper bound of the y axis
35+
* y_axis_hidden - Should the values on the y axis be hidden on render
36+
* display - Should the metric be displayed
37+
* decimal_places - How many decimal places to render on the graph
38+
* tooltip_description - A description for the tooltip
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
layout: "statuspage"
3+
page_title: "Statuspage: statuspage_metrics_provider"
4+
sidebar_current: "docs-statuspage-metrics-provider"
5+
description: |-
6+
Statuspage metrics provider in the Terraform provider Statuspage.
7+
---
8+
9+
# statuspage_metrics_provider
10+
11+
Statuspage metrics provider in the Terraform provider Statuspage.
12+
13+
## Example Usage
14+
15+
```hcl
16+
resource "statuspage_metrics_provider" "statuspage_pingdom" {
17+
page_id = "pageid"
18+
19+
password = "pingdom_password"
20+
application_key = "pingdomAppKey"
21+
type = "Pingdom"
22+
}
23+
```
24+
25+
26+
## Argument Reference
27+
28+
The following arguments are supported:
29+
30+
* page_id - (Required) the id of the page this component belongs to
31+
* type - (Required) One of "Pingdom", "NewRelic", "Librato", "Datadog", or "Self"
32+
* email - Required by the Librato and Pingdom type metrics providers.
33+
* password - Required by the Pingdom-type metrics provider.
34+
* api_key - Required by the Datadog and NewRelic type metrics providers.
35+
* api_token - Required by the Librato type metrics provider.
36+
* application_key - Required by the Pingdom and Datadog type metrics providers.
37+
38+
## Import Example Usage
39+
40+
```sh
41+
terraform import statuspage_metrics_provider.statuspage_pingdom my-page-id/my-metrics-provider-id
42+
```

website/statuspage.erb

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@
1515
<ul class="nav nav-visible">
1616
<li<%= sidebar_current("docs-statuspage-resource") %>>
1717
<a href="/docs/providers/statuspage/r/statuspage_component.html">statuspage_component</a>
18+
<a href="/docs/providers/statuspage/r/statuspage_component_group.html">statuspage_component_group</a>
19+
<a href="/docs/providers/statuspage/r/statuspage_metrics.html">statuspage_metrics</a>
20+
<a href="/docs/providers/statuspage/r/statuspage_metrics_provider.html">statuspage_metrics_provider</a>
1821
</li>
1922
</ul>
2023
</li>

0 commit comments

Comments
 (0)