Skip to content

Commit 2414dd9

Browse files
Generated documentation prior to releasing v1.22.0
1 parent 3abf071 commit 2414dd9

38 files changed

+1578
-18
lines changed

docs/data-sources/alerting_profile.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,4 +39,5 @@ resource "dynatrace_webhook_notification" "my_webhook_notification" {
3939

4040
### Read-Only
4141

42-
- `id` (String) The ID of this resource.
42+
- `id` (String) The ID of this resource.
43+
- `legacy_id` (String)

docs/data-sources/management_zone.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,4 +53,5 @@ resource "dynatrace_calculated_service_metric" "#name#" {
5353
### Read-Only
5454

5555
- `id` (String) The ID of this resource.
56+
- `legacy_id` (String)
5657
- `settings_20_id` (String)

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Use the links to the left to learn about the available resources and data source
1818
terraform {
1919
required_providers {
2020
dynatrace = {
21-
version = "1.21.0"
21+
version = "1.22.0"
2222
source = "dynatrace-oss/dynatrace"
2323
}
2424
}

docs/resources/aws_credentials.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,11 +66,14 @@ Optional:
6666

6767
- `access_key` (String) the access key
6868
- `account_id` (String) the ID of the Amazon account
69-
- `external_id` (String) the external ID token for setting an IAM role. You can obtain it with the `GET /aws/iamExternalId` request
7069
- `iam_role` (String) the IAM role to be used by Dynatrace to get monitoring data
7170
- `secret_key` (String, Sensitive) the secret access key
7271
- `unknowns` (String) Any attributes that aren't yet supported by this provider
7372

73+
Read-Only:
74+
75+
- `external_id` (String) (Read only) the external ID token for setting an IAM role. You can obtain it with the `GET /aws/iamExternalId` request
76+
7477

7578
<a id="nestedblock--supporting_services_to_monitor"></a>
7679
### Nested Schema for `supporting_services_to_monitor`

docs/resources/browser_monitor.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ description: |-
77

88
# dynatrace_browser_monitor (Resource)
99

10+
-> Certain field(s) of this resource has overlap with `dynatrace_browser_monitor_outage`, please review the schema for additional information.
11+
1012
## Dynatrace Documentation
1113

1214
- Synthetic Monitoring - Browser monitors - https://www.dynatrace.com/support/help/shortlink/synthetic-hub#browser-monitors
@@ -231,15 +233,15 @@ Optional:
231233

232234
Optional:
233235

234-
- `global_outage` (Boolean) When enabled (`true`), generate a problem and send an alert when the monitor is unavailable at all configured locations
235-
- `global_outage_policy` (Block List) Global outage handling configuration.
236+
- `global_outage` (Boolean) (Field has overlap with `dynatrace_browser_monitor_outage` and `dynatrace_http_monitor_outage`) When enabled (`true`), generate a problem and send an alert when the monitor is unavailable at all configured locations
237+
- `global_outage_policy` (Block List) (Field has overlap with `dynatrace_browser_monitor_outage` and `dynatrace_http_monitor_outage`) Global outage handling configuration.
236238

237239
Alert if **consecutiveRuns** times consecutively (see [below for nested schema](#nestedblock--anomaly_detection--outage_handling--global_outage_policy))
238-
- `local_outage` (Boolean) When enabled (`true`), generate a problem and send an alert when the monitor is unavailable for one or more consecutive runs at any location
239-
- `local_outage_policy` (Block List) Local outage handling configuration.
240+
- `local_outage` (Boolean) (Field has overlap with `dynatrace_browser_monitor_outage` and `dynatrace_http_monitor_outage`) When enabled (`true`), generate a problem and send an alert when the monitor is unavailable for one or more consecutive runs at any location
241+
- `local_outage_policy` (Block List) (Field has overlap with `dynatrace_browser_monitor_outage` and `dynatrace_http_monitor_outage`) Local outage handling configuration.
240242

241243
Alert if **affectedLocations** of locations are unable to access the web application **consecutiveRuns** times consecutively (see [below for nested schema](#nestedblock--anomaly_detection--outage_handling--local_outage_policy))
242-
- `retry_on_error` (Boolean) Schedule retry if browser monitor execution results in a fail. For HTTP monitors this property is ignored
244+
- `retry_on_error` (Boolean) (Field has overlap with `dynatrace_browser_monitor_outage` and `dynatrace_http_monitor_outage`) Schedule retry if browser monitor execution results in a fail. For HTTP monitors this property is ignored
243245

244246
<a id="nestedblock--anomaly_detection--outage_handling--global_outage_policy"></a>
245247
### Nested Schema for `anomaly_detection.outage_handling.global_outage_policy`
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
layout: ""
3+
page_title: dynatrace_browser_monitor_outage Resource - terraform-provider-dynatrace"
4+
description: |-
5+
The resource `dynatrace_browser_monitor_outage` covers configuration for browser monitor outage handling
6+
---
7+
8+
# dynatrace_browser_monitor_outage (Resource)
9+
10+
-> **Settings 2.0** Certain field(s) of this resource has overlap with `dynatrace_browser_monitor`, therefore it is excluded from the default export. To retrieve this resource via export, directly specify it as a command line argument.
11+
12+
## Dynatrace Documentation
13+
14+
- Synthetic alerting overview - https://www.dynatrace.com/support/help/platform-modules/digital-experience/synthetic-monitoring/analysis-and-alerting/synthetic-alerting-overview
15+
16+
- Settings API - https://www.dynatrace.com/support/help/dynatrace-api/environment-api/settings (schemaId: `builtin:synthetic.browser.outage-handling`)
17+
18+
## Export Example Usage
19+
20+
- `terraform-provider-dynatrace -export dynatrace_browser_monitor_outage` downloads all existing browser monitor outage handling configuration
21+
22+
The full documentation of the export feature is available [here](https://registry.terraform.io/providers/dynatrace-oss/dynatrace/latest/docs/guides/export-v2).
23+
24+
## Resource Example Usage
25+
26+
```terraform
27+
resource "dynatrace_browser_monitor_outage" "#name#" {
28+
global_consecutive_outage_count_threshold = 3
29+
global_outages = true
30+
local_consecutive_outage_count_threshold = 5
31+
local_location_outage_count_threshold = 1
32+
local_outages = true
33+
retry_on_error = true
34+
scope = "environment"
35+
}
36+
```
37+
38+
<!-- schema generated by tfplugindocs -->
39+
## Schema
40+
41+
### Required
42+
43+
- `global_outages` (Boolean) (Field has overlap with `dynatrace_browser_monitor`) Generate a problem and send an alert when the monitor is unavailable at all configured locations.
44+
- `local_outages` (Boolean) (Field has overlap with `dynatrace_browser_monitor`) Generate a problem and send an alert when the monitor is unavailable for one or more consecutive runs at any location.
45+
- `retry_on_error` (Boolean) (Field has overlap with `dynatrace_browser_monitor`) When enabled, which is the default, failing monitor executions are retried immediately one time to avoid false positives and only the second result is used. When disabled, we use the first result right away.
46+
Requires ActiveGate version 1.207+ for private locations.
47+
48+
### Optional
49+
50+
- `global_consecutive_outage_count_threshold` (Number) (Field has overlap with `dynatrace_browser_monitor`) Alert if all locations are unable to access my web application
51+
- `local_consecutive_outage_count_threshold` (Number) (Field has overlap with `dynatrace_browser_monitor`) are unable to access my web application
52+
- `local_location_outage_count_threshold` (Number) (Field has overlap with `dynatrace_browser_monitor`) Alert if at least
53+
- `scope` (String) The scope of this setting (SYNTHETIC_TEST). Omit this property if you want to cover the whole environment.
54+
55+
### Read-Only
56+
57+
- `id` (String) The ID of this resource.
58+
Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
---
2+
layout: ""
3+
page_title: "dynatrace_cloudapp_workloaddetection Resource - terraform-provider-dynatrace"
4+
description: |-
5+
The resource `dynatrace_cloudapp_workloaddetection` merges processes of similar workloads into process groups, and consequently, services. Please note that fine-grained process detection rules will still be applied, while ignoring container or platform specific properties.
6+
---
7+
8+
# dynatrace_cloudapp_workloaddetection (Resource)
9+
10+
11+
## Dynatrace Documentation
12+
13+
- Cloud application and workload detection - https://www.dynatrace.com/support/help/platform-modules/infrastructure-monitoring/process-groups/configuration/cloud-app-and-workload-detection
14+
15+
- Settings API - https://www.dynatrace.com/support/help/dynatrace-api/environment-api/settings (schemaId: `builtin:process-group.cloud-application-workload-detection`)
16+
17+
## Export Example Usage
18+
19+
- `terraform-provider-dynatrace -export dynatrace_cloudapp_workloaddetection` downloads all existing muted requests configuration
20+
21+
The full documentation of the export feature is available [here](https://registry.terraform.io/providers/dynatrace-oss/dynatrace/latest/docs/guides/export-v2).
22+
23+
## Resource Example Usage
24+
25+
```terraform
26+
# ID vu9U3hXa3q0AAAABADpidWlsdGluOnByb2Nlc3MtZ3JvdXAuY2xvdWQtYXBwbGljYXRpb24td29ya2xvYWQtZGV0ZWN0aW9uAAZ0ZW5hbnQABnRlbmFudAAkYjcwNmY4NWYtNWFkNC0zY2ZmLWJhYzMtZDg4YzFmNTkzMjgwvu9U3hXa3q0
27+
resource "dynatrace_cloudapp_workloaddetection" "cloud_app_workload_detection" {
28+
cloud_foundry {
29+
enabled = false
30+
}
31+
docker {
32+
enabled = true
33+
}
34+
kubernetes {
35+
enabled = true
36+
filters {
37+
filter {
38+
enabled = false
39+
inclusion_toggles {
40+
inc_basepod = false
41+
inc_container = true
42+
inc_namespace = true
43+
inc_product = true
44+
inc_stage = true
45+
}
46+
match_filter {
47+
match_operator = "EXISTS"
48+
}
49+
}
50+
}
51+
}
52+
}
53+
```
54+
55+
<!-- schema generated by tfplugindocs -->
56+
## Schema
57+
58+
### Required
59+
60+
- `cloud_foundry` (Block List, Min: 1, Max: 1) Enable this setting to get
61+
* Processes of Cloud Foundry application instances merged into process groups by Cloud Foundry application.
62+
* Container resource metrics (Container group instance entities) and [related screens](https://www.dynatrace.com/support/help/shortlink/container-groups). (see [below for nested schema](#nestedblock--cloud_foundry))
63+
- `docker` (Block List, Min: 1, Max: 1) Enable this setting for plain Docker environments to get
64+
* Container resource metrics (Container group instance entities) and [related screens](https://www.dynatrace.com/support/help/shortlink/container-groups). (see [below for nested schema](#nestedblock--docker))
65+
- `kubernetes` (Block List, Min: 1, Max: 1) Enable this setting to get
66+
* Insights into your Kubernetes namespaces, workloads and pods (cloud application namespace, cloud application and cloud application instance and entities).
67+
* Container resource metrics (container group instance entities) and [related screens](https://www.dynatrace.com/support/help/shortlink/container-groups).
68+
* Similar workloads merged into process groups based on defined rules (see below).
69+
* Version detection for services that run in Kubernetes workloads. (see [below for nested schema](#nestedblock--kubernetes))
70+
71+
### Read-Only
72+
73+
- `id` (String) The ID of this resource.
74+
75+
<a id="nestedblock--cloud_foundry"></a>
76+
### Nested Schema for `cloud_foundry`
77+
78+
Required:
79+
80+
- `enabled` (Boolean) This setting is enabled (`true`) or disabled (`false`)
81+
82+
83+
<a id="nestedblock--docker"></a>
84+
### Nested Schema for `docker`
85+
86+
Required:
87+
88+
- `enabled` (Boolean) This setting is enabled (`true`) or disabled (`false`)
89+
90+
91+
<a id="nestedblock--kubernetes"></a>
92+
### Nested Schema for `kubernetes`
93+
94+
Required:
95+
96+
- `enabled` (Boolean) This setting is enabled (`true`) or disabled (`false`)
97+
- `filters` (Block List, Min: 1, Max: 1) Define rules to merge similar Kubernetes workloads into process groups.
98+
99+
You can use workload properties like namespace name, base pod name or container name as well as the [environment variables DT_RELEASE_STAGE and DT_RELEASE_PRODUCT](https://dt-url.net/sb02v2a) for grouping processes of similar workloads. The first applicable rule will be applied. If no rule matches, “Namespace name” + “Base pod name” + “Container name” is used as fallback. (see [below for nested schema](#nestedblock--kubernetes--filters))
100+
101+
<a id="nestedblock--kubernetes--filters"></a>
102+
### Nested Schema for `kubernetes.filters`
103+
104+
Required:
105+
106+
- `filter` (Block List, Min: 1) (see [below for nested schema](#nestedblock--kubernetes--filters--filter))
107+
108+
<a id="nestedblock--kubernetes--filters--filter"></a>
109+
### Nested Schema for `kubernetes.filters.filter`
110+
111+
Required:
112+
113+
- `enabled` (Boolean) This setting is enabled (`true`) or disabled (`false`)
114+
- `inclusion_toggles` (Block List, Min: 1, Max: 1) ID calculation based on (see [below for nested schema](#nestedblock--kubernetes--filters--filter--inclusion_toggles))
115+
- `match_filter` (Block List, Min: 1, Max: 1) When namespace (see [below for nested schema](#nestedblock--kubernetes--filters--filter--match_filter))
116+
117+
<a id="nestedblock--kubernetes--filters--filter--inclusion_toggles"></a>
118+
### Nested Schema for `kubernetes.filters.filter.inclusion_toggles`
119+
120+
Required:
121+
122+
- `inc_basepod` (Boolean) E.g. "cloud-credential-operator-" for "cloud-credential-operator-5ff6dbff57-gszgq"
123+
- `inc_container` (Boolean) Container name
124+
- `inc_namespace` (Boolean) Namespace name
125+
- `inc_product` (Boolean) If Product is enabled and has no value, it defaults to Base pod name
126+
- `inc_stage` (Boolean) Stage
127+
128+
129+
<a id="nestedblock--kubernetes--filters--filter--match_filter"></a>
130+
### Nested Schema for `kubernetes.filters.filter.match_filter`
131+
132+
Required:
133+
134+
- `match_operator` (String) Possible Values: `CONTAINS`, `ENDS`, `EQUALS`, `EXISTS`, `NOT_CONTAINS`, `NOT_ENDS`, `NOT_EQUALS`, `NOT_STARTS`, `STARTS`
135+
136+
Optional:
137+
138+
- `namespace` (String) Namespace name
139+

docs/resources/credentials.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: |-
88

99
# dynatrace_credentials (Resource)
1010

11-
-> In order to create a this resource, your `dt_api_token` needs to have the `Write credential vault entries` permission.
11+
1212

1313

1414

docs/resources/dashboard.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@ The full documentation of the export feature is available [here](https://registr
2525
resource "dynatrace_dashboard" "#name#" {
2626
dashboard_metadata {
2727
name = "#name#"
28-
shared = false
2928
owner = "Dynatrace"
3029
tags = ["Kubernetes"]
3130
dynamic_filters {
@@ -836,8 +835,8 @@ Optional:
836835
- `dynamic_filters` (Block List, Max: 1) Dashboard filter configuration of a dashboard (see [below for nested schema](#nestedblock--dashboard_metadata--dynamic_filters))
837836
- `filter` (Block List, Max: 1) Global filter Settings for the Dashboard (see [below for nested schema](#nestedblock--dashboard_metadata--filter))
838837
- `preset` (Boolean) the dashboard is a preset (`true`) or not (`false`). Default is `false`.
839-
- `shared` (Boolean) the dashboard is shared (`true`) or private (`false`)
840-
- `sharing_details` (Block List, Max: 1) represents sharing configuration of a dashboard (see [below for nested schema](#nestedblock--dashboard_metadata--sharing_details))
838+
- `shared` (Boolean, Deprecated) the dashboard is shared (`true`) or private (`false`)
839+
- `sharing_details` (Block List, Max: 1, Deprecated) represents sharing configuration of a dashboard (see [below for nested schema](#nestedblock--dashboard_metadata--sharing_details))
841840
- `tags` (Set of String) a set of tags assigned to the dashboard
842841
- `tiles_name_size` (Number) No documentation available
843842
- `unknowns` (String) allows for configuring properties that are not explicitly supported by the current version of this provider

0 commit comments

Comments
 (0)