datadog-configuration
This component is responsible for provisioning SSM or ASM entries for Datadog API keys.
It's required that the DataDog API and APP secret keys are available in the var.datadog_secrets_source_store_account
account in AWS SSM Parameter Store at the /datadog/%v/datadog_app_key
paths (where %v
are the corresponding account
names).
This component copies keys from the source account (e.g. auto
) to the destination account where this is being
deployed. The purpose of using this formatted copying of keys handles a couple of problems.
- The keys are needed in each account where datadog resources will be deployed.
- The keys might need to be different per account or tenant, or any subset of accounts.
- If the keys need to be rotated they can be rotated from a single management account.
This module also has a submodule which allows other resources to quickly use it to create a datadog provider.
See Datadog's documentation about provisioning keys for more information.
Usage
Stack Level: Global
This component should be deployed to every account where you want to provision datadog resources. This is usually every
account except root
and identity
Here's an example snippet for how to use this component. It's suggested to apply this component to all accounts which
you want to track AWS metrics with DataDog. In this example we use the key paths /datadog/%v/datadog_api_key
and
/datadog/%v/datadog_app_key
where %v
is default
, this can be changed through datadog_app_secret_key
&
datadog_api_secret_key
variables. The output Keys in the deployed account will be /datadog/datadog_api_key
and
/datadog/datadog_app_key
.
components:
terraform:
datadog-configuration:
settings:
spacelift:
workspace_enabled: true
vars:
enabled: true
name: datadog-configuration
datadog_secrets_store_type: SSM
datadog_secrets_source_store_account_stage: auto
datadog_secrets_source_store_account_region: "us-east-2"
Here is a snippet of using the datadog_keys
submodule:
module "datadog_configuration" {
source = "../datadog-configuration/modules/datadog_keys"
enabled = true
context = module.this.context
}
provider "datadog" {
api_key = module.datadog_configuration.datadog_api_key
app_key = module.datadog_configuration.datadog_app_key
api_url = module.datadog_configuration.datadog_api_url
validate = local.enabled
}
Variables
Required Variables
region
(string
) requiredAWS Region
Optional Variables
datadog_api_secret_key
(string
) optionalThe name of the Datadog API secret
Default value:
"default"
datadog_api_secret_key_source_pattern
(string
) optionalThe format string (%v will be replaced by the var.datadog_api_secret_key) for the key of the Datadog API secret in the source account
Default value:
"/datadog/%v/datadog_api_key"
datadog_api_secret_key_target_pattern
(string
) optionalThe format string (%v will be replaced by the var.datadog_api_secret_key) for the key of the Datadog API secret in the target account
Default value:
"/datadog/datadog_api_key"
datadog_app_secret_key
(string
) optionalThe name of the Datadog APP secret
Default value:
"default"
datadog_app_secret_key_source_pattern
(string
) optionalThe format string (%v will be replaced by the var.datadog_app_secret_key) for the key of the Datadog APP secret in the source account
Default value:
"/datadog/%v/datadog_app_key"
datadog_app_secret_key_target_pattern
(string
) optionalThe format string (%v will be replaced by the var.datadog_api_secret_key) for the key of the Datadog APP secret in the target account
Default value:
"/datadog/datadog_app_key"
datadog_secrets_source_store_account_region
(string
) optionalRegion for holding Secret Store Datadog Keys, leave as null to use the same region as the stack
Default value:
null
datadog_secrets_source_store_account_stage
(string
) optionalStage holding Secret Store for Datadog API and app keys.
Default value:
"auto"
datadog_secrets_source_store_account_tenant
(string
) optionalTenant holding Secret Store for Datadog API and app keys.
Default value:
"core"
datadog_secrets_store_type
(string
) optionalSecret Store type for Datadog API and app keys. Valid values:
SSM
,ASM
Default value:
"SSM"
datadog_site_url
(string
) optionalThe Datadog Site URL, https://docs.datadoghq.com/getting_started/site/
Default value:
null
Context Variables
The following variables are defined in the context.tf
file of this module and part of the terraform-null-label pattern.
context.tf
file of this module and part of the terraform-null-label pattern.additional_tag_map
(map(string)
) optionalAdditional key-value pairs to add to each map in
tags_as_list_of_maps
. Not added totags
orid
.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.Required: No
Default value:
{ }
attributes
(list(string)
) optionalID element. Additional attributes (e.g.
workers
orcluster
) to add toid
,
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 thedelimiter
and treated as a single ID element.Required: No
Default value:
[ ]
context
(any
) optionalSingle object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables asnull
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.Required: No
Default value:
{
"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
}delimiter
(string
) optionalDelimiter to be used between ID elements.
Defaults to-
(hyphen). Set to""
to use no delimiter at all.Required: No
Default value:
null
descriptor_formats
(any
) optionalDescribe additional descriptors to be output in the
descriptors
output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
\{<br/> format = string<br/> labels = list(string)<br/> \}
(Type isany
so the map values can later be enhanced to provide additional options.)
format
is a Terraform format string to be passed to theformat()
function.
labels
is a list of labels, in order, to pass toformat()
function.
Label values will be normalized before being passed toformat()
so they will be
identical to how they appear inid
.
Default is{}
(descriptors
output will be empty).Required: No
Default value:
{ }
enabled
(bool
) optionalSet to false to prevent the module from creating any resources
Required: NoDefault value:
null
environment
(string
) optionalID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: NoDefault value:
null
id_length_limit
(number
) optionalLimit
id
to this many characters (minimum 6).
Set to0
for unlimited length.
Set tonull
for keep the existing setting, which defaults to0
.
Does not affectid_full
.Required: No
Default value:
null
label_key_case
(string
) optionalControls the letter case of the
tags
keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via thetags
input.
Possible values:lower
,title
,upper
.
Default value:title
.Required: No
Default value:
null
label_order
(list(string)
) optionalThe 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.Required: No
Default value:
null
label_value_case
(string
) optionalControls 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 thetags
input.
Possible values:lower
,title
,upper
andnone
(no transformation).
Set this totitle
and setdelimiter
to""
to yield Pascal Case IDs.
Default value:lower
.Required: No
Default value:
null
labels_as_tags
(set(string)
) optionalSet 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 thetags
output.
Set to[]
to suppress all generated tags.
Notes:
The value of thename
tag, if included, will be theid
, not thename
.
Unlike othernull-label
inputs, the initial setting oflabels_as_tags
cannot be
changed in later chained modules. Attempts to change it will be silently ignored.Required: No
Default value:
[
"default"
]name
(string
) optionalID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as atag
.
The "name" tag is set to the fullid
string. There is no tag with the value of thename
input.Required: No
Default value:
null
namespace
(string
) optionalID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: NoDefault value:
null
regex_replace_chars
(string
) optionalTerraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set,"/[^a-zA-Z0-9-]/"
is used to remove all characters other than hyphens, letters and digits.Required: No
Default value:
null
stage
(string
) optionalID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: NoDefault value:
null
tags
(map(string)
) optionalAdditional tags (e.g.
{'BusinessUnit': 'XYZ'}
).
Neither the tag keys nor the tag values will be modified by this module.Required: No
Default value:
{ }
tenant
(string
) optionalID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: NoDefault value:
null
Outputs
datadog_api_key_location
The Datadog API key in the secrets store
datadog_api_url
The URL of the Datadog API
datadog_app_key_location
The Datadog APP key location in the secrets store
datadog_secrets_store_type
The type of the secrets store to use for Datadog API and APP keys
datadog_site
The Datadog site to use
region
The region where the keys will be created
Dependencies
Requirements
terraform
, version:>= 1.0.0
aws
, version:>= 4.9.0
Providers
aws
, version:>= 4.9.0
Modules
Name | Version | Source | Description |
---|---|---|---|
iam_roles | latest | ../account-map/modules/iam-roles | n/a |
iam_roles_datadog_secrets | latest | ../account-map/modules/iam-roles | n/a |
store_write | 0.10.0 | cloudposse/ssm-parameter-store/aws | n/a |
this | 0.25.0 | cloudposse/label/null | n/a |
Resources
The following resources are used by this module:
Data Sources
The following data sources are used by this module:
aws_secretsmanager_secret.datadog_api_key
(data source)aws_secretsmanager_secret.datadog_app_key
(data source)aws_secretsmanager_secret_version.datadog_api_key
(data source)aws_secretsmanager_secret_version.datadog_app_key
(data source)aws_ssm_parameter.datadog_api_key
(data source)aws_ssm_parameter.datadog_app_key
(data source)
References
- Datadog's documentation about provisioning keys
- cloudposse/terraform-aws-components - Cloud Posse's upstream component