diff --git a/modules/datadog-synthetics/CHANGELOG.md b/modules/datadog-synthetics/CHANGELOG.md new file mode 100644 index 000000000..16bb69d8c --- /dev/null +++ b/modules/datadog-synthetics/CHANGELOG.md @@ -0,0 +1,20 @@ +## Changes approximately v1.329.0 + +### API Schema accepted + +Test can now be defined using the Datadog API schema, meaning that the test definition +returned by +- `https://api.datadoghq.com/api/v1/synthetics/tests/api/{public_id}` +- `https://api.datadoghq.com/api/v1/synthetics/tests/browser/{public_id}` + +can be directly used a map value (you still need to supply a key, though). + +You can mix tests using the API schema with tests using the old Terraform schema. +You could probably get away with mixing them in the same test, but it is not recommended. + +### Default locations + +Previously, the default locations for Synthetics tests were "all" public locations. +Now the default is no locations, in favor of locations being specified in each test configuration, +which is more flexible. Also, since the tests are expensive, it is better to err on the side of +too few test locations than too many. diff --git a/modules/datadog-synthetics/README.md b/modules/datadog-synthetics/README.md index 64cccbda8..26eccb1db 100644 --- a/modules/datadog-synthetics/README.md +++ b/modules/datadog-synthetics/README.md @@ -39,41 +39,56 @@ components: Below are examples of Datadog browser and API synthetic tests. -The synthetic tests are defined in YAML using the [Datadog Terraform provider](https://registry.terraform.io/providers/DataDog/datadog/latest/docs/resources/synthetics_test) schema. +The synthetic tests are defined in YAML using either the [Datadog Terraform provider](https://registry.terraform.io/providers/DataDog/datadog/latest/docs/resources/synthetics_test) schema +or the [Datadog Synthetics API](https://docs.datadoghq.com/api/latest/synthetics) schema. +See the `terraform-datadog-platform` Terraform module [README](https://github.com/cloudposse/terraform-datadog-platform/blob/main/modules/synthetics/README.md) for more details. +We recommend using the API schema so you can more create and edit tests using the Datadog +web API and then import them into this module by downloading the test using +the Datadog REST API. (See the Datadog API documentation for the appropriate +`curl` commands to use.) ```yaml +# API schema my-browser-test: - name: "Browser Test" - message: "Browser Test Failed" + name: My Browser Test + status: live type: browser - subtype: http - device_ids: - - "laptop_large" - tags: - - "managed-by:Terraform" - status: "live" - request_definition: - url: "CHANGEME" - method: GET - request_headers: - Accept-Charset: "utf-8, iso-8859-1;q=0.5" - Accept: "text/html" - options_list: - tick_every: 1800 - no_screenshot: false - follow_redirects: false + config: + request: + method: GET + headers: {} + url: https://example.com/login + setCookie: |- + DatadogTest=true + message: "My Browser Test Failed" + options: + device_ids: + - chrome.laptop_large + - edge.tablet + - firefox.mobile_small + ignoreServerCertificateError: false + disableCors: false + disableCsp: false + noScreenshot: false + tick_every: 86400 + min_failure_duration: 0 + min_location_failed: 1 retry: - count: 2 - interval: 10 + count: 0 + interval: 300 monitor_options: - renotify_interval: 300 - browser_step: - - name: "Check current URL" - type: assertCurrentUrl - params: - check: contains - value: "CHANGEME" - + renotify_interval: 0 + ci: + executionRule: non_blocking + rumSettings: + isEnabled: false + enableProfiling: false + enableSecurityTesting: false + locations: + - aws:us-east-1 + - aws:us-west-2 + +# Terraform schema my-api-test: name: "API Test" message: "API Test Failed" @@ -145,7 +160,7 @@ No providers. | Name | Source | Version | |------|--------|---------| | [datadog\_configuration](#module\_datadog\_configuration) | ../datadog-configuration/modules/datadog_keys | n/a | -| [datadog\_synthetics](#module\_datadog\_synthetics) | cloudposse/platform/datadog//modules/synthetics | 1.0.1 | +| [datadog\_synthetics](#module\_datadog\_synthetics) | cloudposse/platform/datadog//modules/synthetics | 1.3.0 | | [datadog\_synthetics\_merge](#module\_datadog\_synthetics\_merge) | cloudposse/config/yaml//modules/deepmerge | 1.0.2 | | [datadog\_synthetics\_private\_location](#module\_datadog\_synthetics\_private\_location) | cloudposse/stack-config/yaml//modules/remote-state | 1.5.0 | | [datadog\_synthetics\_yaml\_config](#module\_datadog\_synthetics\_yaml\_config) | cloudposse/config/yaml | 1.0.2 | @@ -164,7 +179,7 @@ No resources. | [alert\_tags](#input\_alert\_tags) | List of alert tags to add to all alert messages, e.g. `["@opsgenie"]` or `["@devops", "@opsgenie"]` | `list(string)` | `null` | no | | [alert\_tags\_separator](#input\_alert\_tags\_separator) | Separator for the alert tags. All strings from the `alert_tags` variable will be joined into one string using the separator and then added to the alert message | `string` | `"\n"` | no | | [attributes](#input\_attributes) | ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the `delimiter`
and treated as a single ID element. | `list(string)` | `[]` | no | -| [config\_parameters](#input\_config\_parameters) | Map of parameters to Datadog Synthetic configurations | `map(any)` | `{}` | no | +| [config\_parameters](#input\_config\_parameters) | Map of parameter values to interpolate into Datadog Synthetic configurations | `map(any)` | `{}` | no | | [context](#input\_context) | Single object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as `null` to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional\_tag\_map, which are merged. | `any` | 
{
  "additional_tag_map": {},
  "attributes": [],
  "delimiter": null,
  "descriptor_formats": {},
  "enabled": true,
  "environment": null,
  "id_length_limit": null,
  "label_key_case": null,
  "label_order": [],
  "label_value_case": null,
  "labels_as_tags": [
    "unset"
  ],
  "name": null,
  "namespace": null,
  "regex_replace_chars": null,
  "stage": null,
  "tags": {},
  "tenant": null
}
| no | | [context\_tags](#input\_context\_tags) | List of context tags to add to each synthetic check | `set(string)` | 
[
  "namespace",
  "tenant",
  "environment",
  "stage"
]
| no | | [context\_tags\_enabled](#input\_context\_tags\_enabled) | Whether to add context tags to add to each synthetic check | `bool` | `true` | no | @@ -178,7 +193,7 @@ No resources. | [label\_order](#input\_label\_order) | The order in which the labels (ID elements) appear in the `id`.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present. | `list(string)` | `null` | no | | [label\_value\_case](#input\_label\_value\_case) | Controls the letter case of ID elements (labels) as included in `id`,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the `tags` input.
Possible values: `lower`, `title`, `upper` and `none` (no transformation).
Set this to `title` and set `delimiter` to `""` to yield Pascal Case IDs.
Default value: `lower`. | `string` | `null` | no | | [labels\_as\_tags](#input\_labels\_as\_tags) | Set of labels (ID elements) to include as tags in the `tags` output.
Default is to include all labels.
Tags with empty values will not be included in the `tags` output.
Set to `[]` to suppress all generated tags.
**Notes:**
The value of the `name` tag, if included, will be the `id`, not the `name`.
Unlike other `null-label` inputs, the initial setting of `labels_as_tags` cannot be
changed in later chained modules. Attempts to change it will be silently ignored. | `set(string)` | 
[
  "default"
]
| no | -| [locations](#input\_locations) | Array of locations used to run synthetic tests | `list(string)` | 
[
  "all"
]
| no | +| [locations](#input\_locations) | Array of locations used to run synthetic tests | `list(string)` | `[]` | no | | [name](#input\_name) | ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a `tag`.
The "name" tag is set to the full `id` string. There is no tag with the value of the `name` input. | `string` | `null` | no | | [namespace](#input\_namespace) | ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique | `string` | `null` | no | | [private\_location\_test\_enabled](#input\_private\_location\_test\_enabled) | Use private locations or the public locations provided by datadog | `bool` | `false` | no | @@ -195,9 +210,9 @@ No resources. | Name | Description | |------|-------------| | [datadog\_synthetics\_test\_ids](#output\_datadog\_synthetics\_test\_ids) | IDs of the created Datadog synthetic tests | +| [datadog\_synthetics\_test\_maps](#output\_datadog\_synthetics\_test\_maps) | Map (name: id) of the created Datadog synthetic tests | | [datadog\_synthetics\_test\_monitor\_ids](#output\_datadog\_synthetics\_test\_monitor\_ids) | IDs of the monitors associated with the Datadog synthetics tests | | [datadog\_synthetics\_test\_names](#output\_datadog\_synthetics\_test\_names) | Names of the created Datadog synthetic tests | -| [datadog\_synthetics\_tests](#output\_datadog\_synthetics\_tests) | The synthetic tests created in Datadog | ## References diff --git a/modules/datadog-synthetics/catalog/synthetics/examples/browser-test.yaml b/modules/datadog-synthetics/catalog/synthetics/examples/browser-test.yaml index eced215a6..f623d6523 100644 --- a/modules/datadog-synthetics/catalog/synthetics/examples/browser-test.yaml +++ b/modules/datadog-synthetics/catalog/synthetics/examples/browser-test.yaml @@ -1,31 +1,38 @@ my-browser-test: - name: "Browser Test" - message: "Browser Test Failed" + name: My Browser Test + status: live type: browser - subtype: http - device_ids: - - "laptop_large" - tags: - - "managed-by:Terraform" - status: "live" - request_definition: - url: "CHANGEME" - method: GET - request_headers: - Accept-Charset: "utf-8, iso-8859-1;q=0.5" - Accept: "text/html" - options_list: - tick_every: 1800 - no_screenshot: false - follow_redirects: false + config: + request: + method: GET + headers: {} + url: https://example.com/login + setCookie: |- + DatadogTest=true + message: "My Browser Test Failed" + options: + device_ids: + - chrome.laptop_large + - edge.tablet + - firefox.mobile_small + ignoreServerCertificateError: false + disableCors: false + disableCsp: false + noScreenshot: false + tick_every: 86400 + min_failure_duration: 0 + min_location_failed: 1 retry: - count: 2 - interval: 10 + count: 0 + interval: 300 monitor_options: - renotify_interval: 300 - browser_step: - - name: "Check current URL" - type: assertCurrentUrl - params: - check: contains - value: "CHANGEME" + renotify_interval: 0 + ci: + executionRule: non_blocking + rumSettings: + isEnabled: false + enableProfiling: false + enableSecurityTesting: false + locations: + - aws:us-east-1 + - aws:us-west-2 diff --git a/modules/datadog-synthetics/main.tf b/modules/datadog-synthetics/main.tf index f6d16aff7..0cf1493e8 100644 --- a/modules/datadog-synthetics/main.tf +++ b/modules/datadog-synthetics/main.tf @@ -50,9 +50,11 @@ module "datadog_synthetics_merge" { module "datadog_synthetics" { source = "cloudposse/platform/datadog//modules/synthetics" - version = "1.0.1" + version = "1.3.0" - datadog_synthetics = local.synthetics_merged + # Disable default tags because we manage them ourselves in this module, because we want to make them lowercase. + default_tags_enabled = false + datadog_synthetics = local.synthetics_merged locations = distinct(compact(concat( var.locations, diff --git a/modules/datadog-synthetics/outputs.tf b/modules/datadog-synthetics/outputs.tf index ab3daaea4..6b6c811d6 100644 --- a/modules/datadog-synthetics/outputs.tf +++ b/modules/datadog-synthetics/outputs.tf @@ -1,8 +1,3 @@ -output "datadog_synthetics_tests" { - value = module.datadog_synthetics.datadog_synthetic_tests - description = "The synthetic tests created in Datadog" -} - output "datadog_synthetics_test_names" { value = module.datadog_synthetics.datadog_synthetics_test_names description = "Names of the created Datadog synthetic tests" @@ -17,3 +12,8 @@ output "datadog_synthetics_test_monitor_ids" { value = module.datadog_synthetics.datadog_synthetics_test_monitor_ids description = "IDs of the monitors associated with the Datadog synthetics tests" } + +output "datadog_synthetics_test_maps" { + value = { for v in module.datadog_synthetics.datadog_synthetic_tests : v.name => v.id } + description = "Map (name: id) of the created Datadog synthetic tests" +} diff --git a/modules/datadog-synthetics/variables.tf b/modules/datadog-synthetics/variables.tf index c3ff9f236..3cda7a56c 100644 --- a/modules/datadog-synthetics/variables.tf +++ b/modules/datadog-synthetics/variables.tf @@ -34,7 +34,7 @@ variable "context_tags" { variable "config_parameters" { type = map(any) - description = "Map of parameters to Datadog Synthetic configurations" + description = "Map of parameter values to interpolate into Datadog Synthetic configurations" default = {} } @@ -47,7 +47,7 @@ variable "datadog_synthetics_globals" { variable "locations" { type = list(string) description = "Array of locations used to run synthetic tests" - default = ["all"] + default = [] } variable "private_location_test_enabled" { diff --git a/modules/tfstate-backend/README.md b/modules/tfstate-backend/README.md index 44482e130..0de1f8eb3 100644 --- a/modules/tfstate-backend/README.md +++ b/modules/tfstate-backend/README.md @@ -51,6 +51,16 @@ You can configure who is allowed to assume these roles. helpful because it allows that user, presumably SuperAdmin, to deploy the normal components that expect the user does not have direct access to Terraform state. +### Quotas + +When allowing access to both SAML and AWS SSO users, the trust policy for the IAM roles created by this component +can exceed the default 2048 character limit. If you encounter this error, you can increase the limit by +requesting a quota increase [here](https://us-east-1.console.aws.amazon.com/servicequotas/home/services/iam/quotas/L-C07B4B0D). +Note that this is the IAM limit on "The maximum number of characters in an IAM role trust policy" and it must be +configured in the `us-east-1` region, regardless of what region you are deploying to. Normally 3072 characters +is sufficient, and is recommended so that you still have room to expand the trust policy in the future while +perhaps considering how to reduce its size. + ## Usage **Stack Level**: Regional (because DynamoDB is region-specific), but deploy only in a single region and only in the `root` account