|
1 | | -name: "template" |
2 | | - |
| 1 | +name: "aws-datadog-integration" |
3 | 2 | # Canonical GitHub repo |
4 | | -github_repo: "cloudposse-terraform-components/template" |
5 | | - |
| 3 | +github_repo: "cloudposse-terraform-components/aws-datadog-integration" |
6 | 4 | # Short description of this project |
7 | 5 | description: |- |
8 | | - Description of this component |
| 6 | + This component is responsible for provisioning Datadog AWS integrations. It depends on the `datadog-configuration` |
| 7 | + component to get the Datadog API keys. |
| 8 | +
|
| 9 | + See Datadog's [documentation about provisioning keys](https://docs.datadoghq.com/account_management/api-app-keys) for |
| 10 | + more information. |
9 | 11 |
|
10 | | -usage: |- |
11 | | - **Stack Level**: Regional or Test47 |
| 12 | + ## Usage |
| 13 | +
|
| 14 | + **Stack Level**: Global |
| 15 | +
|
| 16 | + Here's an example snippet for how to use this component. It's suggested to apply this component to all accounts which |
| 17 | + you want to track AWS metrics with DataDog. |
12 | 18 |
|
13 | | - Here's an example snippet for how to use this component. |
14 | | - |
15 | 19 | ```yaml |
16 | 20 | components: |
17 | 21 | terraform: |
18 | | - foo: |
| 22 | + datadog-integration: |
| 23 | + settings: |
| 24 | + spacelift: |
| 25 | + workspace_enabled: true |
19 | 26 | vars: |
20 | 27 | enabled: true |
21 | 28 | ``` |
22 | 29 |
|
23 | | -include: |
24 | | - - "docs/terraform.md" |
| 30 | + <!-- prettier-ignore-start --> |
| 31 | + <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK --> |
| 32 | + ## Requirements |
25 | 33 |
|
26 | | -tags: |
27 | | - - terraform |
28 | | - - terraform-modules |
29 | | - - aws |
30 | | - - components |
31 | | - - terraform-components |
32 | | - - root |
33 | | - - geodesic |
34 | | - - reference-implementation |
35 | | - - reference-architecture |
| 34 | + | Name | Version | |
| 35 | + |------|---------| |
| 36 | + | <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0.0 | |
| 37 | + | <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 4.9.0 | |
| 38 | + | <a name="requirement_datadog"></a> [datadog](#requirement\_datadog) | >= 3.3.0 | |
| 39 | +
|
| 40 | + ## Providers |
| 41 | +
|
| 42 | + | Name | Version | |
| 43 | + |------|---------| |
| 44 | + | <a name="provider_aws"></a> [aws](#provider\_aws) | >= 4.9.0 | |
| 45 | +
|
| 46 | + ## Modules |
| 47 | +
|
| 48 | + | Name | Source | Version | |
| 49 | + |------|--------|---------| |
| 50 | + | <a name="module_datadog_configuration"></a> [datadog\_configuration](#module\_datadog\_configuration) | ../datadog-configuration/modules/datadog_keys | n/a | |
| 51 | + | <a name="module_datadog_integration"></a> [datadog\_integration](#module\_datadog\_integration) | cloudposse/datadog-integration/aws | 1.2.0 | |
| 52 | + | <a name="module_iam_roles"></a> [iam\_roles](#module\_iam\_roles) | ../account-map/modules/iam-roles | n/a | |
| 53 | + | <a name="module_store_write"></a> [store\_write](#module\_store\_write) | cloudposse/ssm-parameter-store/aws | 0.11.0 | |
| 54 | + | <a name="module_this"></a> [this](#module\_this) | cloudposse/label/null | 0.25.0 | |
| 55 | +
|
| 56 | + ## Resources |
36 | 57 |
|
| 58 | + | Name | Type | |
| 59 | + |------|------| |
| 60 | + | [aws_regions.all](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/regions) | data source | |
| 61 | +
|
| 62 | + ## Inputs |
| 63 | +
|
| 64 | + | Name | Description | Type | Default | Required | |
| 65 | + |------|-------------|------|---------|:--------:| |
| 66 | + | <a name="input_account_specific_namespace_rules"></a> [account\_specific\_namespace\_rules](#input\_account\_specific\_namespace\_rules) | An object, (in the form {"namespace1":true/false, "namespace2":true/false} ), that enables or disables metric collection for specific AWS namespaces for this AWS account only | `map(string)` | `{}` | no | |
| 67 | + | <a name="input_additional_tag_map"></a> [additional\_tag\_map](#input\_additional\_tag\_map) | Additional key-value pairs to add to each map in `tags_as_list_of_maps`. Not added to `tags` or `id`.<br>This is for some rare cases where resources want additional configuration of tags<br>and therefore take a list of maps with tag key, value, and additional configuration. | `map(string)` | `{}` | no | |
| 68 | + | <a name="input_attributes"></a> [attributes](#input\_attributes) | ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`,<br>in the order they appear in the list. New attributes are appended to the<br>end of the list. The elements of the list are joined by the `delimiter`<br>and treated as a single ID element. | `list(string)` | `[]` | no | |
| 69 | + | <a name="input_context"></a> [context](#input\_context) | Single object for setting entire context at once.<br>See description of individual variables for details.<br>Leave string and numeric variables as `null` to use default value.<br>Individual variable settings (non-null) override settings in context object,<br>except for attributes, tags, and additional\_tag\_map, which are merged. | `any` | <pre>{<br> "additional_tag_map": {},<br> "attributes": [],<br> "delimiter": null,<br> "descriptor_formats": {},<br> "enabled": true,<br> "environment": null,<br> "id_length_limit": null,<br> "label_key_case": null,<br> "label_order": [],<br> "label_value_case": null,<br> "labels_as_tags": [<br> "unset"<br> ],<br> "name": null,<br> "namespace": null,<br> "regex_replace_chars": null,<br> "stage": null,<br> "tags": {},<br> "tenant": null<br>}</pre> | no | |
| 70 | + | <a name="input_context_host_and_filter_tags"></a> [context\_host\_and\_filter\_tags](#input\_context\_host\_and\_filter\_tags) | Automatically add host and filter tags for these context keys | `list(string)` | <pre>[<br> "namespace",<br> "tenant",<br> "stage"<br>]</pre> | no | |
| 71 | + | <a name="input_cspm_resource_collection_enabled"></a> [cspm\_resource\_collection\_enabled](#input\_cspm\_resource\_collection\_enabled) | Enable Datadog Cloud Security Posture Management scanning of your AWS account.<br>See [announcement](https://www.datadoghq.com/product/cloud-security-management/cloud-security-posture-management/) for details. | `bool` | `null` | no | |
| 72 | + | <a name="input_datadog_aws_account_id"></a> [datadog\_aws\_account\_id](#input\_datadog\_aws\_account\_id) | The AWS account ID Datadog's integration servers use for all integrations | `string` | `"464622532012"` | no | |
| 73 | + | <a name="input_delimiter"></a> [delimiter](#input\_delimiter) | Delimiter to be used between ID elements.<br>Defaults to `-` (hyphen). Set to `""` to use no delimiter at all. | `string` | `null` | no | |
| 74 | + | <a name="input_descriptor_formats"></a> [descriptor\_formats](#input\_descriptor\_formats) | Describe additional descriptors to be output in the `descriptors` output map.<br>Map of maps. Keys are names of descriptors. Values are maps of the form<br>`{<br> format = string<br> labels = list(string)<br>}`<br>(Type is `any` so the map values can later be enhanced to provide additional options.)<br>`format` is a Terraform format string to be passed to the `format()` function.<br>`labels` is a list of labels, in order, to pass to `format()` function.<br>Label values will be normalized before being passed to `format()` so they will be<br>identical to how they appear in `id`.<br>Default is `{}` (`descriptors` output will be empty). | `any` | `{}` | no | |
| 75 | + | <a name="input_enabled"></a> [enabled](#input\_enabled) | Set to false to prevent the module from creating any resources | `bool` | `null` | no | |
| 76 | + | <a name="input_environment"></a> [environment](#input\_environment) | ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' | `string` | `null` | no | |
| 77 | + | <a name="input_excluded_regions"></a> [excluded\_regions](#input\_excluded\_regions) | An array of AWS regions to exclude from metrics collection | `list(string)` | `[]` | no | |
| 78 | + | <a name="input_filter_tags"></a> [filter\_tags](#input\_filter\_tags) | An array of EC2 tags (in the form `key:value`) that defines a filter that Datadog use when collecting metrics from EC2. Wildcards, such as ? (for single characters) and * (for multiple characters) can also be used | `list(string)` | `[]` | no | |
| 79 | + | <a name="input_host_tags"></a> [host\_tags](#input\_host\_tags) | An array of tags (in the form `key:value`) to add to all hosts and metrics reporting through this integration | `list(string)` | `[]` | no | |
| 80 | + | <a name="input_id_length_limit"></a> [id\_length\_limit](#input\_id\_length\_limit) | Limit `id` to this many characters (minimum 6).<br>Set to `0` for unlimited length.<br>Set to `null` for keep the existing setting, which defaults to `0`.<br>Does not affect `id_full`. | `number` | `null` | no | |
| 81 | + | <a name="input_included_regions"></a> [included\_regions](#input\_included\_regions) | An array of AWS regions to include in metrics collection | `list(string)` | `[]` | no | |
| 82 | + | <a name="input_integrations"></a> [integrations](#input\_integrations) | List of AWS permission names to apply for different integrations (e.g. 'all', 'core') | `list(string)` | <pre>[<br> "all"<br>]</pre> | no | |
| 83 | + | <a name="input_label_key_case"></a> [label\_key\_case](#input\_label\_key\_case) | Controls the letter case of the `tags` keys (label names) for tags generated by this module.<br>Does not affect keys of tags passed in via the `tags` input.<br>Possible values: `lower`, `title`, `upper`.<br>Default value: `title`. | `string` | `null` | no | |
| 84 | + | <a name="input_label_order"></a> [label\_order](#input\_label\_order) | The order in which the labels (ID elements) appear in the `id`.<br>Defaults to ["namespace", "environment", "stage", "name", "attributes"].<br>You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present. | `list(string)` | `null` | no | |
| 85 | + | <a name="input_label_value_case"></a> [label\_value\_case](#input\_label\_value\_case) | Controls the letter case of ID elements (labels) as included in `id`,<br>set as tag values, and output by this module individually.<br>Does not affect values of tags passed in via the `tags` input.<br>Possible values: `lower`, `title`, `upper` and `none` (no transformation).<br>Set this to `title` and set `delimiter` to `""` to yield Pascal Case IDs.<br>Default value: `lower`. | `string` | `null` | no | |
| 86 | + | <a name="input_labels_as_tags"></a> [labels\_as\_tags](#input\_labels\_as\_tags) | Set of labels (ID elements) to include as tags in the `tags` output.<br>Default is to include all labels.<br>Tags with empty values will not be included in the `tags` output.<br>Set to `[]` to suppress all generated tags.<br>**Notes:**<br> The value of the `name` tag, if included, will be the `id`, not the `name`.<br> Unlike other `null-label` inputs, the initial setting of `labels_as_tags` cannot be<br> changed in later chained modules. Attempts to change it will be silently ignored. | `set(string)` | <pre>[<br> "default"<br>]</pre> | no | |
| 87 | + | <a name="input_metrics_collection_enabled"></a> [metrics\_collection\_enabled](#input\_metrics\_collection\_enabled) | When enabled, a metric-by-metric crawl of the CloudWatch API pulls data and sends it<br>to Datadog. New metrics are pulled every ten minutes, on average. | `bool` | `null` | no | |
| 88 | + | <a name="input_name"></a> [name](#input\_name) | ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.<br>This is the only ID element not also included as a `tag`.<br>The "name" tag is set to the full `id` string. There is no tag with the value of the `name` input. | `string` | `null` | no | |
| 89 | + | <a name="input_namespace"></a> [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 | |
| 90 | + | <a name="input_regex_replace_chars"></a> [regex\_replace\_chars](#input\_regex\_replace\_chars) | Terraform regular expression (regex) string.<br>Characters matching the regex will be removed from the ID elements.<br>If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits. | `string` | `null` | no | |
| 91 | + | <a name="input_region"></a> [region](#input\_region) | AWS Region | `string` | n/a | yes | |
| 92 | + | <a name="input_resource_collection_enabled"></a> [resource\_collection\_enabled](#input\_resource\_collection\_enabled) | Some Datadog products leverage information about how your AWS resources<br>(such as S3 Buckets, RDS snapshots, and CloudFront distributions) are configured.<br>When `resource_collection_enabled` is `true`, Datadog collects this information<br>by making read-only API calls into your AWS account. | `bool` | `null` | no | |
| 93 | + | <a name="input_stage"></a> [stage](#input\_stage) | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | `string` | `null` | no | |
| 94 | + | <a name="input_tags"></a> [tags](#input\_tags) | Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`).<br>Neither the tag keys nor the tag values will be modified by this module. | `map(string)` | `{}` | no | |
| 95 | + | <a name="input_tenant"></a> [tenant](#input\_tenant) | ID element \_(Rarely used, not included by default)\_. A customer identifier, indicating who this instance of a resource is for | `string` | `null` | no | |
| 96 | +
|
| 97 | + ## Outputs |
| 98 | +
|
| 99 | + | Name | Description | |
| 100 | + |------|-------------| |
| 101 | + | <a name="output_aws_account_id"></a> [aws\_account\_id](#output\_aws\_account\_id) | AWS Account ID of the IAM Role for the Datadog integration | |
| 102 | + | <a name="output_aws_role_name"></a> [aws\_role\_name](#output\_aws\_role\_name) | Name of the AWS IAM Role for the Datadog integration | |
| 103 | + | <a name="output_datadog_external_id"></a> [datadog\_external\_id](#output\_datadog\_external\_id) | Datadog integration external ID | |
| 104 | + <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK --> |
| 105 | + <!-- prettier-ignore-end --> |
| 106 | +
|
| 107 | + ## References |
| 108 | +
|
| 109 | + - Datadog's [documentation about provisioning keys](https://docs.datadoghq.com/account_management/api-app-keys) |
| 110 | + - [cloudposse/terraform-aws-components](https://github.com/cloudposse/terraform-aws-components/tree/main/modules/datadog-integration) - |
| 111 | + Cloud Posse's upstream component |
| 112 | +tags: |
| 113 | + - component/datadog-integration |
| 114 | + - layer/datadog |
| 115 | + - provider/aws |
| 116 | + - provider/datadog |
37 | 117 | # Categories of this project |
38 | 118 | categories: |
39 | | - - terraform-modules/root |
40 | | - - terraform-components |
41 | | - |
| 119 | + - component/datadog-integration |
| 120 | + - layer/datadog |
| 121 | + - provider/aws |
| 122 | + - provider/datadog |
42 | 123 | # License of this project |
43 | 124 | license: "APACHE2" |
44 | | - |
45 | 125 | # Badges to display |
46 | 126 | badges: |
47 | | - - name: "Latest Release" |
48 | | - image: "https://img.shields.io/github/release/cloudposse-terraform-components/template.svg?style=for-the-badge" |
49 | | - url: "https://github.com/cloudposse-terraform-components/template/releases/latest" |
50 | | - - name: "Slack Community" |
51 | | - image: "https://slack.cloudposse.com/for-the-badge.svg" |
52 | | - url: "https://slack.cloudposse.com" |
53 | | - |
54 | | -references: |
55 | | - - name: "Cloud Posse Documentation" |
56 | | - description: "Complete documentation for the Cloud Posse solution" |
57 | | - url: "https://docs.cloudposse.com" |
58 | | - - name: "Reference Architectures" |
59 | | - description: "Launch effortlessly with our turnkey reference architectures, built either by your team or ours." |
60 | | - url: "https://cloudposse.com/" |
61 | | - |
| 127 | + - name: Latest Release |
| 128 | + image: https://img.shields.io/github/release/cloudposse-terraform-components/aws-datadog-integration.svg?style=for-the-badge |
| 129 | + url: https://github.com/cloudposse-terraform-components/aws-datadog-integration/releases/latest |
| 130 | + - name: Slack Community |
| 131 | + image: https://slack.cloudposse.com/for-the-badge.svg |
| 132 | + url: https://slack.cloudposse.com |
62 | 133 | related: |
63 | | -- name: "Cloud Posse Terraform Modules" |
64 | | - description: Our collection of reusable Terraform modules used by our reference architectures. |
65 | | - url: "https://docs.cloudposse.com/modules/" |
66 | | -- name: "Atmos" |
67 | | - description: "Atmos is like docker-compose but for your infrastructure" |
68 | | - url: "https://atmos.tools" |
69 | | - |
| 134 | + - name: "Cloud Posse Terraform Modules" |
| 135 | + description: Our collection of reusable Terraform modules used by our reference architectures. |
| 136 | + url: "https://docs.cloudposse.com/modules/" |
| 137 | + - name: "Atmos" |
| 138 | + description: "Atmos is like docker-compose but for your infrastructure" |
| 139 | + url: "https://atmos.tools" |
70 | 140 | contributors: [] # If included generates contribs |
0 commit comments