Skip to content

Commit 9d9ac67

Browse files
Reinhard-Pilz-DynatraceReinhard-Pilz-Dynatrace
committed
updated documentation in preparation of release 1.17.0
1 parent cd8c1b9 commit 9d9ac67

File tree

12 files changed

+308
-4
lines changed

12 files changed

+308
-4
lines changed

‎docs/data-sources/entities.md‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
---
2+
layout: ""
3+
page_title: "dynatrace_entities Data Source - terraform-provider-dynatrace"
4+
description: |-
5+
The data source `dynatrace_entities` covers queries for the list of entities based off of type
6+
---
7+
8+
# dynatrace_entities (Data Source)
9+
10+
The entities data source allows all entities to be retrieved by its type.
11+
12+
- `type` (String) Type of the entity, e.g. SERVICE. All available entity types can be retrieved with [/api/v2/entityTypes](https://www.dynatrace.com/support/help/dynatrace-api/environment-api/entity-v2/get-all-entity-types).
13+
14+
## Example Usage
15+
16+
```terraform
17+
data "dynatrace_entities" "Test" {
18+
type = "SERVICE"
19+
}
20+
21+
output "Service_List" {
22+
value = data.dynatrace_entities.Test.entities
23+
}
24+
```
25+
26+
<!-- schema generated by tfplugindocs -->
27+
## Schema
28+
29+
### Required
30+
31+
- `type` (String)
32+
33+
### Optional
34+
35+
- `entities` (Block List, Max: 1) (see [below for nested schema](#nestedblock--entities))
36+
37+
### Read-Only
38+
39+
- `id` (String) The ID of this resource.
40+
41+
<a id="nestedblock--entities"></a>
42+
### Nested Schema for `entities`
43+
44+
Optional:
45+
46+
- `entity` (Block List) A list of monitored entities. (see [below for nested schema](#nestedblock--entities--entity))
47+
48+
<a id="nestedblock--entities--entity"></a>
49+
### Nested Schema for `entities.entity`
50+
51+
Optional:
52+
53+
- `display_name` (String) The name of the entity, displayed in the UI.
54+
- `entity_id` (String) The ID of the entity.
55+
- `tags` (Block List) A set of tags assigned to the entity. (see [below for nested schema](#nestedblock--entities--entity--tags))
56+
- `type` (String) The type of the entity.
57+
58+
<a id="nestedblock--entities--entity--tags"></a>
59+
### Nested Schema for `entities.entity.tags`
60+
61+
Optional:
62+
63+
- `tag` (Block List) A tag assigned to the entity (see [below for nested schema](#nestedblock--entities--entity--tags--tag))
64+
65+
<a id="nestedblock--entities--entity--tags--tag"></a>
66+
### Nested Schema for `entities.entity.tags.tag`
67+
68+
Required:
69+
70+
- `context` (String) The origin of the tag, such as AWS or Cloud Foundry. Custom tags use the `CONTEXTLESS` value
71+
- `key` (String) The key of the tag. Custom tags have the tag value here
72+
73+
Optional:
74+
75+
- `string_representation` (String) The string representation of the tag
76+
- `value` (String) The value of the tag. Not applicable to custom tags

‎docs/data-sources/entity.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
layout: ""
3+
page_title: "dynatrace_entity Data Source - terraform-provider-dynatrace"
4+
description: |-
5+
The data source `dynatrace_entity` covers queries for the ID of a entity based on name and type
6+
---
7+
8+
# dynatrace_entity (Data Source)
9+
10+
The entity data source allows the entity ID to be retrieved by its name and type.
11+
12+
- `name` (String) Display name of the entity
13+
- `type` (String) Type of the entity, e.g. SERVICE. All available entity types can be retrieved with [/api/v2/entityTypes](https://www.dynatrace.com/support/help/dynatrace-api/environment-api/entity-v2/get-all-entity-types).
14+
15+
If multiple services match the given criteria, the first result will be retrieved.
16+
17+
## Example Usage
18+
19+
```terraform
20+
data "dynatrace_entity" "Test" {
21+
type = "SERVICE"
22+
name = "BookingService"
23+
}
24+
25+
output "id" {
26+
value = data.dynatrace_entity.Test.id
27+
}
28+
```
29+
30+
<!-- schema generated by tfplugindocs -->
31+
## Schema
32+
33+
### Required
34+
35+
- `name` (String)
36+
- `type` (String)
37+
38+
### Read-Only
39+
40+
- `id` (String) The ID of this resource.

‎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.16.0"
21+
version = "1.17.0"
2222
source = "dynatrace-oss/dynatrace"
2323
}
2424
}

‎docs/resources/alerting_profile.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -255,4 +255,5 @@ Required:
255255

256256
Optional:
257257

258+
- `string_representation` (String) The string representation of the tag
258259
- `value` (String) The value of the tag. Not applicable to custom tags

‎docs/resources/custom_anomalies.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -385,5 +385,6 @@ Required:
385385

386386
Optional:
387387

388+
- `string_representation` (String) The string representation of the tag
388389
- `value` (String) The value of the tag. Not applicable to custom tags
389390

‎docs/resources/ddu_pool.md‎

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
---
2+
layout: ""
3+
page_title: "dynatrace_ddu_pool Resource - terraform-provider-dynatrace"
4+
description: |-
5+
The resource `dynatrace_ddu_pool` covers configuration for Davis Data Unit Pools
6+
---
7+
8+
# dynatrace_ddu_pool (Resource)
9+
10+
11+
## Dynatrace Documentation
12+
13+
- DDU Pools - https://www.dynatrace.com/support/help/monitoring-consumption/davis-data-units#ddu-pools
14+
15+
- Settings API - https://www.dynatrace.com/support/help/dynatrace-api/environment-api/settings (schemaId: `builtin:accounting.ddu.limit`)
16+
17+
## Resource Example Usage
18+
19+
```terraform
20+
resource "dynatrace_ddu_pool" "#name#" {
21+
metrics {
22+
enabled = true
23+
type = "MONTHLY"
24+
value = 123
25+
}
26+
log_monitoring {
27+
enabled = true
28+
type = "MONTHLY"
29+
value = 124
30+
}
31+
events {
32+
enabled = true
33+
type = "MONTHLY"
34+
value = 125
35+
}
36+
serverless {
37+
enabled = true
38+
type = "MONTHLY"
39+
value = 126
40+
}
41+
traces {
42+
enabled = true
43+
type = "MONTHLY"
44+
value = 127
45+
}
46+
}
47+
```
48+
49+
<!-- schema generated by tfplugindocs -->
50+
## Schema
51+
52+
### Optional
53+
54+
- `events` (Block List, Max: 1) DDU pool settings for Events (see [below for nested schema](#nestedblock--events))
55+
- `log_monitoring` (Block List, Max: 1) DDU pool settings for Log Monitoring (see [below for nested schema](#nestedblock--log_monitoring))
56+
- `metrics` (Block List, Max: 1) DDU pool settings for Metrics (see [below for nested schema](#nestedblock--metrics))
57+
- `serverless` (Block List, Max: 1) DDU pool settings for Serverless (see [below for nested schema](#nestedblock--serverless))
58+
- `traces` (Block List, Max: 1) DDU pool settings for Traces (see [below for nested schema](#nestedblock--traces))
59+
60+
### Read-Only
61+
62+
- `id` (String) The ID of this resource.
63+
64+
<a id="nestedblock--events"></a>
65+
### Nested Schema for `events`
66+
67+
Required:
68+
69+
- `enabled` (Boolean) Is the limit configuration enabled
70+
71+
Optional:
72+
73+
- `type` (String) Type of the limit applied: MONTHLY or ANNUAL
74+
- `value` (Number) Value of the DDU limit applied for provided timerange
75+
76+
77+
<a id="nestedblock--log_monitoring"></a>
78+
### Nested Schema for `log_monitoring`
79+
80+
Required:
81+
82+
- `enabled` (Boolean) Is the limit configuration enabled
83+
84+
Optional:
85+
86+
- `type` (String) Type of the limit applied: MONTHLY or ANNUAL
87+
- `value` (Number) Value of the DDU limit applied for provided timerange
88+
89+
90+
<a id="nestedblock--metrics"></a>
91+
### Nested Schema for `metrics`
92+
93+
Required:
94+
95+
- `enabled` (Boolean) Is the limit configuration enabled
96+
97+
Optional:
98+
99+
- `type` (String) Type of the limit applied: MONTHLY or ANNUAL
100+
- `value` (Number) Value of the DDU limit applied for provided timerange
101+
102+
103+
<a id="nestedblock--serverless"></a>
104+
### Nested Schema for `serverless`
105+
106+
Required:
107+
108+
- `enabled` (Boolean) Is the limit configuration enabled
109+
110+
Optional:
111+
112+
- `type` (String) Type of the limit applied: MONTHLY or ANNUAL
113+
- `value` (Number) Value of the DDU limit applied for provided timerange
114+
115+
116+
<a id="nestedblock--traces"></a>
117+
### Nested Schema for `traces`
118+
119+
Required:
120+
121+
- `enabled` (Boolean) Is the limit configuration enabled
122+
123+
Optional:
124+
125+
- `type` (String) Type of the limit applied: MONTHLY or ANNUAL
126+
- `value` (Number) Value of the DDU limit applied for provided timerange

‎docs/resources/disk_anomalies.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,5 +84,6 @@ Required:
8484

8585
Optional:
8686

87+
- `string_representation` (String) The string representation of the tag
8788
- `value` (String) The value of the tag. Not applicable to custom tags
8889

‎docs/resources/network_zone.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The full documentation of the export feature is available [here](https://registr
2424

2525
### Optional
2626

27-
- `alternative_zones` (Set of String) A list of alternative network zones.
27+
- `alternative_zones` (List of String) A list of alternative network zones.
2828
- `description` (String) A short description of the network zone
2929
- `num_of_configured_activegates` (Number) The number of ActiveGates in the network zone.
3030
- `num_of_configured_oneagents` (Number) The number of OneAgents that are configured to use the network zone as primary.

‎docs/resources/pg_anomalies.md‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
layout: ""
3+
page_title: dynatrace_pg_anomalies Resource - terraform-provider-dynatrace"
4+
description: |-
5+
The resource `dynatrace_pg_anomalies` covers configuration for process group anomaly detection
6+
---
7+
8+
# dynatrace_pg_anomalies (Resource)
9+
10+
## Dynatrace Documentation
11+
12+
- Process groups - https://www.dynatrace.com/support/help/how-to-use-dynatrace/process-groups
13+
14+
- Anomaly detection API - Process groups - https://www.dynatrace.com/support/help/dynatrace-api/configuration-api/anomaly-detection-api/anomaly-detection-api-process-groups
15+
16+
## Export Example Usage
17+
18+
- `terraform-provider-dynatrace -export dynatrace_pg_anomalies` downloads all existing process group detection configuration
19+
20+
The full documentation of the export feature is available [here](https://registry.terraform.io/providers/dynatrace-oss/dynatrace/latest/docs/guides/export-v2).
21+
22+
## Resource Example Usage
23+
24+
```terraform
25+
resource "dynatrace_pg_anomalies" "#name#" {
26+
pg_id = "PROCESS_GROUP-XXXXXXXXXXXXXXXX"
27+
availability {
28+
method = "MINIMUM_THRESHOLD"
29+
minimum_threshold = 5
30+
}
31+
}
32+
```
33+
34+
<!-- schema generated by tfplugindocs -->
35+
## Schema
36+
37+
### Required
38+
39+
- `pg_id` (String) The ID of the process group
40+
41+
### Optional
42+
43+
- `availability` (Block List, Max: 1) Configuration of the availability monitoring for the process group. (see [below for nested schema](#nestedblock--availability))
44+
45+
### Read-Only
46+
47+
- `id` (String) The ID of this resource.
48+
49+
<a id="nestedblock--availability"></a>
50+
### Nested Schema for `availability`
51+
52+
Required:
53+
54+
- `method` (String) How to monitor the availability of the process group: * `PROCESS_IMPACT`: Alert if any process of the group becomes unavailable. * `MINIMUM_THRESHOLD`: Alert if the number of active processes in the group falls below the specified threshold. * `OFF`: Availability monitoring is disabled.
55+
56+
Optional:
57+
58+
- `minimum_threshold` (Number) Alert if the number of active processes in the group is lower than this value.
59+

‎templates/index.md.tmpl‎

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.16.0"
21+
version = "1.17.0"
2222
source = "dynatrace-oss/dynatrace"
2323
}
2424
}

0 commit comments

Comments
 (0)