Skip to content

Commit 80d1cca

Browse files
Reinhard-Pilz-DynatraceReinhard-Pilz-Dynatrace
committed
Generated docs prior to releasing v1.23.0
1 parent f63943c commit 80d1cca

File tree

15 files changed

+827
-10
lines changed

15 files changed

+827
-10
lines changed

‎docs/data-sources/iam_user.md‎

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,26 @@
11
---
2-
# generated by https://github.com/hashicorp/terraform-plugin-docs
2+
layout: ""
33
page_title: "dynatrace_iam_user Data Source - terraform-provider-dynatrace"
4-
subcategory: ""
54
description: |-
6-
Fetches the groups the user identified with the given email
5+
The data source `dynatrace_iam_user` covers queries for the groups a user is a member of
76
---
87

98
# dynatrace_iam_user (Data Source)
109

11-
Fetches the groups the user identified with the given email
10+
This data source allows you to specify the email address of the user and produces an ordered list of group IDs this user is a member of
1211

12+
## Example Usage
1313

14+
```terraform
15+
data "dynatrace_iam_user" "user_a" {
16+
email = "[email protected]"
17+
}
18+
19+
output "groups" {
20+
value = data.dynatrace_iam_user.user_a.groups
21+
}
22+
23+
```
1424

1525
<!-- schema generated by tfplugindocs -->
1626
## Schema
@@ -22,6 +32,4 @@ Fetches the groups the user identified with the given email
2232
### Read-Only
2333

2434
- `groups` (List of String)
25-
- `id` (String) The ID of this resource.
26-
27-
35+
- `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.22.2"
21+
version = "1.23.0"
2222
source = "dynatrace-oss/dynatrace"
2323
}
2424
}

‎docs/resources/aix_extension.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
layout: ""
3+
page_title: dynatrace_aix_extension Resource - terraform-provider-dynatrace"
4+
description: |-
5+
The resource `dynatrace_aix_extension` covers configuration for AIX kernel extension
6+
---
7+
8+
# dynatrace_aix_extension (Resource)
9+
10+
## Dynatrace Documentation
11+
12+
- Automated injection of deep-code monitoring on AIX - https://www.dynatrace.com/support/help/setup-and-configuration/dynatrace-oneagent/installation-and-operation/aix/operation/enable-auto-injection
13+
14+
- Settings API - https://www.dynatrace.com/support/help/dynatrace-api/environment-api/settings (schemaId: `builtin:host.monitoring.aix-kernel-extension`)
15+
16+
## Export Example Usage
17+
18+
- `terraform-provider-dynatrace -export dynatrace_aix_extension` downloads all existing AIX kernel extension 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_aix_extension" "#name#" {
26+
host_id = "HOST-1234567890000000"
27+
use_global_settings = false
28+
enabled = true
29+
}
30+
```
31+
32+
<!-- schema generated by tfplugindocs -->
33+
## Schema
34+
35+
### Required
36+
37+
- `host_id` (String) The scope of this settings. If the settings should cover the whole environment, just don't specify any scope.
38+
- `use_global_settings` (Boolean) Use global settings
39+
40+
### Optional
41+
42+
- `enabled` (Boolean) This setting is enabled (`true`) or disabled (`false`)
43+
44+
### Read-Only
45+
46+
- `id` (String) The ID of this resource.
47+

‎docs/resources/disk_options.md‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
---
2+
layout: ""
3+
page_title: dynatrace_disk_options Resource - terraform-provider-dynatrace"
4+
description: |-
5+
The resource `dynatrace_disk_options` covers configuration for host disk visibility settings
6+
---
7+
8+
# dynatrace_disk_options (Resource)
9+
10+
## Dynatrace Documentation
11+
12+
- Exclude disks - https://www.dynatrace.com/support/help/platform-modules/infrastructure-monitoring/hosts/configuration/exclude-disks-and-network-traffic#exclude-disks
13+
14+
- Settings API - https://www.dynatrace.com/support/help/dynatrace-api/environment-api/settings (schemaId: `builtin:disk.options`)
15+
16+
## Export Example Usage
17+
18+
- `terraform-provider-dynatrace -export dynatrace_disk_options` downloads all existing host disk visibility settings
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+
# ID vu9U3hXa3q0AAAABABRidWlsdGluOmRpc2sub3B0aW9ucwAESE9TVAAQRDg5NUZGMDdDQzcxMDEyRQAkNmUzNzVmNDQtZmY3YS0zZDBjLThmOGUtYmFiZWU5MWQ2ZTMwvu9U3hXa3q0
26+
resource "dynatrace_disk_options" "#name#" {
27+
nfs_show_all = true
28+
scope = "HOST-1234567890000000"
29+
exclusions {
30+
exclusion {
31+
filesystem = "ntfs"
32+
mountpoint = "C:\\"
33+
os = "OS_TYPE_WINDOWS"
34+
}
35+
}
36+
}
37+
```
38+
39+
<!-- schema generated by tfplugindocs -->
40+
## Schema
41+
42+
### Required
43+
44+
- `exclusions` (Block List, Min: 1, Max: 1) OneAgent automatically detects and monitors all your mount points, however you can create exception rules to remove disks from the monitoring list. (see [below for nested schema](#nestedblock--exclusions))
45+
- `nfs_show_all` (Boolean) When disabled OneAgent will try to deduplicate some of nfs disks. Disabled by default, applies only to Linux hosts. Requires OneAgent 1.209 or later
46+
47+
### Optional
48+
49+
- `scope` (String) The scope of this setting (HOST, HOST_GROUP). Omit this property if you want to cover the whole environment.
50+
51+
### Read-Only
52+
53+
- `id` (String) The ID of this resource.
54+
55+
<a id="nestedblock--exclusions"></a>
56+
### Nested Schema for `exclusions`
57+
58+
Required:
59+
60+
- `exclusion` (Block List, Min: 1) (see [below for nested schema](#nestedblock--exclusions--exclusion))
61+
62+
<a id="nestedblock--exclusions--exclusion"></a>
63+
### Nested Schema for `exclusions.exclusion`
64+
65+
Required:
66+
67+
- `os` (String) Possible Values: `OS_TYPE_AIX`, `OS_TYPE_DARWIN`, `OS_TYPE_HPUX`, `OS_TYPE_LINUX`, `OS_TYPE_SOLARIS`, `OS_TYPE_UNKNOWN`, `OS_TYPE_WINDOWS`, `OS_TYPE_ZOS`
68+
69+
Optional:
70+
71+
- `filesystem` (String) **File system type field:** the type of the file system to be excluded from monitoring. Examples:
72+
73+
* ext4
74+
* ext3
75+
* btrfs
76+
* ext*
77+
78+
⚠️ File system types are case sensitive!
79+
80+
The wildcard in the last example means to exclude matching file systems such as types ext4 and ext3
81+
- `mountpoint` (String) **Disk or mount point path field:** the path to where the disk to be excluded from monitoring is mounted. Examples:
82+
83+
* /mnt/my_disk
84+
* /staff/emp1
85+
* C:\
86+
* /staff/*
87+
* /disk*
88+
89+
⚠️ Mount point paths are case sensitive!
90+
91+
The wildcard in **/staff/*** means to exclude every child folder of /staff.
92+
93+
The wildcard in **/disk*** means to exclude every mount point starting with /disk, for example /disk1, /disk99, /diskabc
94+

‎docs/resources/extension_execution_controller.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
layout: ""
3+
page_title: dynatrace_extension_execution_controller Resource - terraform-provider-dynatrace"
4+
description: |-
5+
The resource `dynatrace_extension_execution_controller` covers Extension Execution Controller configuration for OneAgent deployment
6+
---
7+
8+
# dynatrace_extension_execution_controller (Resource)
9+
10+
## Dynatrace Documentation
11+
12+
- Extensions 2.0 - https://www.dynatrace.com/support/help/extend-dynatrace/extensions20/extensions-concepts
13+
14+
- Settings API - https://www.dynatrace.com/support/help/dynatrace-api/environment-api/settings (schemaId: `builtin:eec.local`)
15+
16+
## Export Example Usage
17+
18+
- `terraform-provider-dynatrace -export dynatrace_extension_execution_controller` downloads all existing Extension Execution Controller 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_extension_execution_controller" "#name#" {
26+
enabled = true
27+
ingest_active = true
28+
performance_profile = "DEFAULT"
29+
scope = "environment"
30+
statsd_active = true
31+
}
32+
```
33+
34+
<!-- schema generated by tfplugindocs -->
35+
## Schema
36+
37+
### Required
38+
39+
- `enabled` (Boolean) This setting is enabled (`true`) or disabled (`false`)
40+
41+
### Optional
42+
43+
- `ingest_active` (Boolean) Enable local PIPE/HTTP metric and Log Ingest API
44+
- `performance_profile` (String) Possible Values: `DEFAULT`, `HIGH`
45+
- `scope` (String) The scope of this setting (HOST, HOST_GROUP). Omit this property if you want to cover the whole environment.
46+
- `statsd_active` (Boolean) Enable Dynatrace StatsD
47+
48+
### Read-Only
49+
50+
- `id` (String) The ID of this resource.
51+

‎docs/resources/iam_permission.md‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
layout: ""
3+
page_title: "dynatrace_iam_permission Resource - terraform-provider-dynatrace"
4+
description: |-
5+
The resource `dynatrace_iam_permission` covers configuration of permissions for user groups via Account Management API for SaaS Accounts
6+
---
7+
8+
# dynatrace_iam_permission (Resource)
9+
10+
## Dynatrace Documentation
11+
12+
- Dynatrace IAM - https://www.dynatrace.com/support/help/how-to-use-dynatrace/user-management-and-sso/manage-groups-and-permissions
13+
14+
- Settings API - https://www.dynatrace.com/support/help/how-to-use-dynatrace/user-management-and-sso/manage-groups-and-permissions/iam/iam-getting-started
15+
16+
## Prerequisites
17+
18+
Using this resource requires an OAuth client to be configured within your account settings.
19+
The scopes of the OAuth Client need to include `account-idm-read`, `account-idm-write`, `account-env-read`, `account-env-write`, `iam-policies-management`, `iam:policies:write`, `iam:policies:read`, `iam:bindings:write`, `iam:bindings:read` and `iam:effective-permissions:read`.
20+
21+
Finally the provider configuration requires the credentials for that OAuth Client.
22+
The configuration section of your provider needs to look like this.
23+
```terraform
24+
provider "dynatrace" {
25+
dt_env_url = "https://########.live.dynatrace.com/"
26+
dt_api_token = "######.########################.################################################################"
27+
28+
iam_client_id = "######.########"
29+
iam_account_id = "########-####-####-####-############"
30+
iam_client_secret = "######.########.################################################################"
31+
}
32+
```
33+
34+
## Resource Example Usage
35+
36+
```terraform
37+
resource "dynatrace_iam_permission" "perm_a" {
38+
name = "tenant-viewer"
39+
group = "74ec0a82-8010-4f11-8579-b29a5ba865f0"
40+
# environment = "siz65484"
41+
# management_zone = "107678256803363569"
42+
account = "023733f0-86d8-47d1-88bd-7f5cc2e22eb8"
43+
}
44+
45+
```
46+
47+
<!-- schema generated by tfplugindocs -->
48+
## Schema
49+
50+
### Required
51+
52+
- `group` (String) The ID of the group this permission is valid for
53+
- `name` (String) Possible values: `account-company-info`, `account-user-management`, `account-viewer`, `tenant-viewer`, `tenant-manage-settings`, `tenant-agent-install`, `tenant-logviewer`, `tenant-view-sensitive-request-data`, `tenant-configure-request-capture-data`, `tenant-replay-sessions-with-masking`, `tenant-replay-sessions-without-masking`, `tenant-manage-security-problems`, `tenant-manage-support-tickets`
54+
55+
### Optional
56+
57+
- `account` (String) The UUID of the account this permission is valid for
58+
- `environment` (String) The environment this permission is valid (`https://<environmentid>.live.dynatrace.com`). Also required in when trying to specify a management zone permission.
59+
- `management_zone` (String) The management zone this permission is valid for. You need to use the attribute `legacy_id` when referring to a resource `dynatrace_management_zone_v2` or a data source `dynatrace_management_zone`. The attribute `environment` is required to get specified also in order to identify the management zone uniquely.
60+
61+
### Read-Only
62+
63+
- `id` (String) The ID of this resource.

0 commit comments

Comments
 (0)