Skip to content

Commit 1cc1ea7

Browse files
Reinhard-Pilz-DynatraceReinhard-Pilz-Dynatrace
committed
Generated documentation before 1.13.1 release
1 parent 36b4247 commit 1cc1ea7

File tree

4 files changed

+125
-33
lines changed

4 files changed

+125
-33
lines changed

‎README.md‎

Lines changed: 3 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -8,26 +8,8 @@
88
Please check the documentation within the [Terraform Registry](https://registry.terraform.io/providers/dynatrace-oss/dynatrace/latest/docs) for how to use and configure this Provider as well as for currrently supported resources and data sources.
99

1010
## Exporting existing configuration from a Dynatrace Environment
11+
1112
In addition to acting as a Terraform Provider Plugin the executable `terraform-provider-dynatrace` (`terraform-provider-dynatrace.exe` on Windows) can also get directly invoked.
1213
The utility then reaches out to the Dynatrace Environment specified by the command line arguments and fetches all currently supported configuration items. These results will then automatically get transformed into HCL (the configuration language to be used for `.tf` files) and places each configuration item into its own `.tf` file).
13-
### Command Line Syntax
14-
Invoking the export functionality requires
15-
* The environment varibale `DYNATRACE_ENV_URL` as the URL of your Dynatrace Environment
16-
* The environment variable `DYNATRACE_API_TOKEN` as the API Token with the following permissions:
17-
- `Read configuration`
18-
- `Capture request data`
19-
- `Read SLO`
20-
- `Read settings`
21-
- `Read synthetic monitors, locations, and nodes`
22-
* Optinonally the environment variable `DYNATRACE_TARGET_FOLDER`. If it's not set, the output folder `./configuration` is assumed
23-
#### Windows
24-
`terraform-provider-dynatrace.exe export *[<resourcename>[=<id>]]`
25-
#### Linux
26-
`./terraform-provider-dynatrace export *[<resourcename>[=<id>]]`
27-
#### Usage Examples
28-
* `./terraform-provider-dynatrace export` downloads all available configuration settings
29-
* `./terraform-provider-dynatrace export dynatrace_dashboard` downloads all available dashboards
30-
* `./terraform-provider-dynatrace export dynatrace_dashboard dynatrace_slo` downloads all available dashboards and all available SLOs
31-
* `./terraform-provider-dynatrace export dynatrace_dashboard=4f5942d4-3450-40a8-818f-c5faeb3563d0` downloads only the dashboard with the id `4f5942d4-3450-40a8-818f-c5faeb3563d0`
32-
* `./terraform-provider-dynatrace export dynatrace_dashboard=4f5942d4-3450-40a8-818f-c5faeb3563d0 dynatrace_dashboard=9c4b75f1-9a64-4b44-a8e4-149154fd5325` downloads only the dashboards with the ids `4f5942d4-3450-40a8-818f-c5faeb3563d0` and `9c4b75f1-9a64-4b44-a8e4-149154fd5325`
33-
* `./terraform-provider-dynatrace export dynatrace_slo dynatrace_dashboard=4f5942d4-3450-40a8-818f-c5faeb3563d0 dynatrace_dashboard=9c4b75f1-9a64-4b44-a8e4-149154fd5325` downloads all available SLOs and only the dashboards with the ids `4f5942d4-3450-40a8-818f-c5faeb3563d0` and `9c4b75f1-9a64-4b44-a8e4-149154fd5
14+
15+
Please check out the documentation within the [Terraform Registry](https://registry.terraform.io/providers/dynatrace-oss/dynatrace/latest/docs#exporting-existing-configuration-from-a-dynatrace-environment) for detailed information about how to use that functionality.

‎docs/index.md‎

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@ Use the links to the left to learn about the available resources.
1818
terraform {
1919
required_providers {
2020
dynatrace = {
21-
version = "1.12.0"
21+
version = "1.13.1"
2222
source = "dynatrace-oss/dynatrace"
2323
}
2424
}
2525
}
2626
```
27-
# Configure the Dynatrace provider
27+
## Configure the Dynatrace provider
2828
```
2929
provider "dynatrace" {
3030
dt_env_url = "https://########.live.dynatrace.com"
@@ -33,6 +33,31 @@ provider "dynatrace" {
3333
```
3434
where `dt_env_url` represents the URL of your Dynatrace Environment and `dt_api_token` needs to be an API Token with the permissions `Read configuration` and `Capture request data`.
3535

36+
## Exporting existing configuration from a Dynatrace Environment
37+
In addition to acting as a Terraform Provider Plugin the executable `terraform-provider-dynatrace` (`terraform-provider-dynatrace.exe` on Windows) can also get directly invoked.
38+
The utility then reaches out to the Dynatrace Environment specified by the command line arguments and fetches all currently supported configuration items. These results will then automatically get transformed into HCL (the configuration language to be used for `.tf` files) and places each configuration item into its own `.tf` file).
39+
### Command Line Syntax
40+
Invoking the export functionality requires
41+
* The environment varibale `DYNATRACE_ENV_URL` as the URL of your Dynatrace Environment
42+
* The environment variable `DYNATRACE_API_TOKEN` as the API Token with the following permissions:
43+
- `Read configuration`
44+
- `Capture request data`
45+
- `Read SLO`
46+
- `Read settings`
47+
- `Read synthetic monitors, locations, and nodes`
48+
* Optinonally the environment variable `DYNATRACE_TARGET_FOLDER`. If it's not set, the output folder `./configuration` is assumed
49+
#### Windows
50+
`terraform-provider-dynatrace.exe export *[<resourcename>[=<id>]]`
51+
#### Linux
52+
`./terraform-provider-dynatrace export *[<resourcename>[=<id>]]`
53+
#### Usage Examples
54+
* `./terraform-provider-dynatrace export` downloads all available configuration settings
55+
* `./terraform-provider-dynatrace export dynatrace_dashboard` downloads all available dashboards
56+
* `./terraform-provider-dynatrace export dynatrace_dashboard dynatrace_slo` downloads all available dashboards and all available SLOs
57+
* `./terraform-provider-dynatrace export dynatrace_dashboard=4f5942d4-3450-40a8-818f-c5faeb3563d0` downloads only the dashboard with the id `4f5942d4-3450-40a8-818f-c5faeb3563d0`
58+
* `./terraform-provider-dynatrace export dynatrace_dashboard=4f5942d4-3450-40a8-818f-c5faeb3563d0 dynatrace_dashboard=9c4b75f1-9a64-4b44-a8e4-149154fd5325` downloads only the dashboards with the ids `4f5942d4-3450-40a8-818f-c5faeb3563d0` and `9c4b75f1-9a64-4b44-a8e4-149154fd5325`
59+
* `./terraform-provider-dynatrace export dynatrace_slo dynatrace_dashboard=4f5942d4-3450-40a8-818f-c5faeb3563d0 dynatrace_dashboard=9c4b75f1-9a64-4b44-a8e4-149154fd5325` downloads all available SLOs and only the dashboards with the ids `4f5942d4-3450-40a8-818f-c5faeb3563d0` and `9c4b75f1-9a64-4b44-a8e4-149154fd5
60+
3661
<!-- schema generated by tfplugindocs -->
3762
## Schema
3863

‎docs/resources/queue_manager.md‎

Lines changed: 68 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,78 @@
11
---
2-
# generated by https://github.com/hashicorp/terraform-plugin-docs
2+
layout: ""
33
page_title: "dynatrace_queue_manager Resource - terraform-provider-dynatrace"
4-
subcategory: ""
54
description: |-
6-
5+
The resource `dynatrace_queue_manager` covers configuration for IBM MQ Queue Managers
76
---
87

98
# dynatrace_queue_manager (Resource)
109

11-
12-
13-
10+
## Dynatrace Documentation
11+
12+
IBM MQ tracing - https://www.dynatrace.com/support/help/how-to-use-dynatrace/queues/configuration/ibm-mq-tracing
13+
14+
Settings API - https://www.dynatrace.com/support/help/dynatrace-api/environment-api/settings (schemaId: `builtin:ibmmq.queue-managers`)
15+
16+
## Export Example Usage
17+
18+
`terraform-provider-dynatrace export dynatrace_queue_manager` downloads all existing queue manager configuration
19+
20+
## Resource Example Usage
21+
22+
```terraform
23+
resource "dynatrace_queue_manager" "#name#" {
24+
name = "#name#"
25+
clusters = ["Cluster 1","Cluster 2"]
26+
alias_queues {
27+
alias_queue {
28+
alias_queue_name = "Alias Queue A"
29+
base_queue_name = "Base Queue A"
30+
}
31+
alias_queue {
32+
alias_queue_name = "Alias Queue B"
33+
base_queue_name = "Base Queue B"
34+
cluster_visibility = ["Cluster 1"]
35+
}
36+
alias_queue {
37+
alias_queue_name = "Alias Queue C"
38+
base_queue_name = "Base Queue C"
39+
cluster_visibility = ["Cluster 1", "Cluster 2"]
40+
}
41+
}
42+
remote_queues {
43+
remote_queue {
44+
local_queue_name = "Local Queue A"
45+
remote_queue_name = "Remote Queue A"
46+
remote_queue_manager = "Remote Queue Manager A"
47+
}
48+
remote_queue {
49+
local_queue_name = "Local Queue B"
50+
remote_queue_name = "Remote Queue B"
51+
remote_queue_manager = "Remote Queue Manager B"
52+
cluster_visibility = ["Cluster 1"]
53+
}
54+
remote_queue {
55+
local_queue_name = "Local Queue C"
56+
remote_queue_name = "Remote Queue C"
57+
remote_queue_manager = "Remote Queue Manager C"
58+
cluster_visibility = ["Cluster 1","Cluster 2"]
59+
}
60+
}
61+
cluster_queues {
62+
cluster_queue {
63+
local_queue_name = "Local Queue A"
64+
}
65+
cluster_queue {
66+
local_queue_name = "Local Queue B"
67+
cluster_visibility = ["Cluster 1"]
68+
}
69+
cluster_queue {
70+
local_queue_name = "Local Queue C"
71+
cluster_visibility = ["Cluster 1", "Cluster 2"]
72+
}
73+
}
74+
}
75+
```
1476

1577
<!-- schema generated by tfplugindocs -->
1678
## Schema
@@ -90,5 +152,3 @@ Required:
90152
Optional:
91153

92154
- `cluster_visibility` (Set of String) Name of the cluster(s) this local definition of the remote queue should be visible in
93-
94-

‎templates/index.md.tmpl‎

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@ Use the links to the left to learn about the available resources.
1818
terraform {
1919
required_providers {
2020
dynatrace = {
21-
version = "1.13.0"
21+
version = "1.13.1"
2222
source = "dynatrace-oss/dynatrace"
2323
}
2424
}
2525
}
2626
```
27-
# Configure the Dynatrace provider
27+
## Configure the Dynatrace provider
2828
```
2929
provider "dynatrace" {
3030
dt_env_url = "https://########.live.dynatrace.com"
@@ -33,4 +33,29 @@ provider "dynatrace" {
3333
```
3434
where `dt_env_url` represents the URL of your Dynatrace Environment and `dt_api_token` needs to be an API Token with the permissions `Read configuration` and `Capture request data`.
3535

36+
## Exporting existing configuration from a Dynatrace Environment
37+
In addition to acting as a Terraform Provider Plugin the executable `terraform-provider-dynatrace` (`terraform-provider-dynatrace.exe` on Windows) can also get directly invoked.
38+
The utility then reaches out to the Dynatrace Environment specified by the command line arguments and fetches all currently supported configuration items. These results will then automatically get transformed into HCL (the configuration language to be used for `.tf` files) and places each configuration item into its own `.tf` file).
39+
### Command Line Syntax
40+
Invoking the export functionality requires
41+
* The environment varibale `DYNATRACE_ENV_URL` as the URL of your Dynatrace Environment
42+
* The environment variable `DYNATRACE_API_TOKEN` as the API Token with the following permissions:
43+
- `Read configuration`
44+
- `Capture request data`
45+
- `Read SLO`
46+
- `Read settings`
47+
- `Read synthetic monitors, locations, and nodes`
48+
* Optinonally the environment variable `DYNATRACE_TARGET_FOLDER`. If it's not set, the output folder `./configuration` is assumed
49+
#### Windows
50+
`terraform-provider-dynatrace.exe export *[<resourcename>[=<id>]]`
51+
#### Linux
52+
`./terraform-provider-dynatrace export *[<resourcename>[=<id>]]`
53+
#### Usage Examples
54+
* `./terraform-provider-dynatrace export` downloads all available configuration settings
55+
* `./terraform-provider-dynatrace export dynatrace_dashboard` downloads all available dashboards
56+
* `./terraform-provider-dynatrace export dynatrace_dashboard dynatrace_slo` downloads all available dashboards and all available SLOs
57+
* `./terraform-provider-dynatrace export dynatrace_dashboard=4f5942d4-3450-40a8-818f-c5faeb3563d0` downloads only the dashboard with the id `4f5942d4-3450-40a8-818f-c5faeb3563d0`
58+
* `./terraform-provider-dynatrace export dynatrace_dashboard=4f5942d4-3450-40a8-818f-c5faeb3563d0 dynatrace_dashboard=9c4b75f1-9a64-4b44-a8e4-149154fd5325` downloads only the dashboards with the ids `4f5942d4-3450-40a8-818f-c5faeb3563d0` and `9c4b75f1-9a64-4b44-a8e4-149154fd5325`
59+
* `./terraform-provider-dynatrace export dynatrace_slo dynatrace_dashboard=4f5942d4-3450-40a8-818f-c5faeb3563d0 dynatrace_dashboard=9c4b75f1-9a64-4b44-a8e4-149154fd5325` downloads all available SLOs and only the dashboards with the ids `4f5942d4-3450-40a8-818f-c5faeb3563d0` and `9c4b75f1-9a64-4b44-a8e4-149154fd5
60+
3661
{{ .SchemaMarkdown | trimspace }}

0 commit comments

Comments
 (0)