Skip to main content
Sponsor @cloudposse

datadog-agent

This component installs the datadog-agent for EKS clusters.

Usage​

Stack Level: Regional

Use this in the catalog as default values.

components:
  terraform:
    datadog-agent:
      settings:
        spacelift:
          workspace_enabled: true
      vars:
        enabled: true
        eks_component_name: eks/cluster
        name: "datadog"
        description: "Datadog Kubernetes Agent"
        kubernetes_namespace: "monitoring"
        create_namespace: true
        repository: "https://helm.datadoghq.com"
        chart: "datadog"
        chart_version: "3.29.2"
        timeout: 1200
        wait: true
        atomic: true
        cleanup_on_fail: true
        cluster_checks_enabled: false
        helm_manifest_experiment_enabled: false
        secrets_store_type: SSM
        tags:
          team: sre
          service: datadog-agent
          app: monitoring
        # datadog-agent shouldn't be deployed to the Fargate nodes
        values:
          agents:
            affinity:
              nodeAffinity:
                requiredDuringSchedulingIgnoredDuringExecution:
                  nodeSelectorTerms:
                    - matchExpressions:
                        - key: eks.amazonaws.com/compute-type
                          operator: NotIn
                          values:
                            - fargate
          datadog:
            env:
              - name: DD_EC2_PREFER_IMDSV2 # this merges ec2 instances and the node in the hostmap section
                value: "true"

Deploy this to a particular environment such as dev, prod, etc.

This will add cluster checks to a specific environment.

components:
  terraform:
    datadog-agent:
      vars:
        # Order affects merge order. Later takes priority. We append lists though.
        datadog_cluster_check_config_paths:
          - catalog/cluster-checks/defaults/*.yaml
          - catalog/cluster-checks/dev/*.yaml
        datadog_cluster_check_config_parameters: {}
        # add additional tags to all data coming in from this agent.
        datadog_tags:
          - "env:dev"
          - "region:us-west-2"
          - "stage:dev"

Cluster Checks​

Cluster Checks are configurations that allow us to setup external URLs to be monitored. They can be configured through the datadog agent or annotations on kubernetes services.

Cluster Checks are similar to synthetics checks, they are not as indepth, but significantly cheaper. Use Cluster Checks when you need a simple health check beyond the kubernetes pod health check.

Public addresses that test endpoints must use the agent configuration, whereas service addresses internal to the cluster can be tested by annotations.

Adding Cluster Checks​

Cluster Checks can be enabled or disabled via the cluster_checks_enabled variable. We recommend this be set to true.

New Cluster Checks can be added to defaults to be applied in every account. Alternatively they can be placed in an individual stage folder which will be applied to individual stages. This is controlled by the datadog_cluster_check_config_parameters variable, which determines the paths of yaml files to look for cluster checks per stage.

Once they are added, and properly configured, the new checks show up in the network monitor creation under ssl and Http

Please note: the yaml file name doesn't matter, but the root key inside which is something.yaml does matter. this is following datadogs docs for <integration name>.yaml.

Sample Yaml​

warning

The key of a filename must match datadog docs, which is <INTEGRATION_NAME>.yaml > Datadog Cluster Checks

Cluster Checks can be used for external URL testing (loadbalancer endpoints), whereas annotations must be used for kubernetes services.

http_check.yaml:
  cluster_check: true
  init_config:
  instances:
    - name: "[${stage}] Echo Server"
      url: "https://echo.${stage}.uw2.acme.com"
    - name: "[${stage}] Portal"
      url: "https://portal.${stage}.uw2.acme.com"
    - name: "[${stage}] ArgoCD"
      url: "https://argocd.${stage}.uw2.acme.com"

Monitoring Cluster Checks​

Using Cloudposse's datadog-monitor component. The following yaml snippet will monitor all HTTP Cluster Checks, this can be added to each stage (usually via a defaults folder).

https-checks:
  name: "(Network Check) ${stage} - HTTPS Check"
  type: service check
  query: |
    "http.can_connect".over("stage:${stage}").by("instance").last(2).count_by_status()
  message: |
    HTTPS Check failed on <code>{{instance.name}}</code>
      in Stage: <code>{{stage.name}}</code>
  escalation_message: ""
  tags:
    managed-by: Terraform
  notify_no_data: false
  notify_audit: false
  require_full_window: true
  enable_logs_sample: false
  force_delete: true
  include_tags: true
  locked: false
  renotify_interval: 0
  timeout_h: 0
  evaluation_delay: 0
  new_host_delay: 0
  new_group_delay: 0
  no_data_timeframe: 2
  threshold_windows: {}
  thresholds:
    critical: 1
    warning: 1
    ok: 1

References​

Variables​

Required Variables​

chart (string) required

Chart name to be installed. The chart name can be local path, a URL to a chart, or the name of the chart if repository is specified. It is also possible to use the <repository>/<chart> format here if you are running Terraform on a system that the repository has been added to with helm repo add but this is not recommended

kubernetes_namespace (string) required

Kubernetes namespace to install the release into

region (string) required

AWS Region

Optional Variables​

atomic (bool) optional

If set, installation process purges chart on fail. The wait flag will be set automatically if atomic is used


Default value: true

chart_version (string) optional

Specify the exact chart version to install. If this is not specified, the latest version is installed


Default value: null

cleanup_on_fail (bool) optional

Allow deletion of new resources created in this upgrade when upgrade fails


Default value: true

cluster_checks_enabled (bool) optional

Enable Cluster Checks for the Datadog Agent


Default value: false

create_namespace (bool) optional

Create the Kubernetes namespace if it does not yet exist


Default value: true

datadog_cluster_check_auto_added_tags (list(string)) optional

List of tags to add to Datadog Cluster Check


Default value:

[
  "stage",
  "environment"
]
datadog_cluster_check_config_parameters (map(any)) optional

Map of parameters to Datadog Cluster Check configurations


Default value: { }

datadog_cluster_check_config_paths (list(string)) optional

List of paths to Datadog Cluster Check configurations


Default value: [ ]

datadog_tags (set(string)) optional

List of static tags to attach to every metric, event and service check collected by the agent


Default value: [ ]

description (string) optional

Release description attribute (visible in the history)


Default value: null

eks_component_name (string) optional

The name of the EKS component. Used to get the remote state


Default value: "eks/eks"

helm_manifest_experiment_enabled (bool) optional

Enable storing of the rendered manifest for helm_release so the full diff of what is changing can been seen in the plan


Default value: false

kube_data_auth_enabled (bool) optional

If true, use an aws_eks_cluster_auth data source to authenticate to the EKS cluster.
Disabled by kubeconfig_file_enabled or kube_exec_auth_enabled.



Default value: false

kube_exec_auth_aws_profile (string) optional

The AWS config profile for aws eks get-token to use


Default value: ""

kube_exec_auth_aws_profile_enabled (bool) optional

If true, pass kube_exec_auth_aws_profile as the profile to aws eks get-token


Default value: false

kube_exec_auth_enabled (bool) optional

If true, use the Kubernetes provider exec feature to execute aws eks get-token to authenticate to the EKS cluster.
Disabled by kubeconfig_file_enabled, overrides kube_data_auth_enabled.



Default value: true

kube_exec_auth_role_arn (string) optional

The role ARN for aws eks get-token to use


Default value: ""

kube_exec_auth_role_arn_enabled (bool) optional

If true, pass kube_exec_auth_role_arn as the role ARN to aws eks get-token


Default value: true

kubeconfig_context (string) optional

Context to choose from the Kubernetes config file.
If supplied, kubeconfig_context_format will be ignored.



Default value: ""

kubeconfig_context_format (string) optional

A format string to use for creating the kubectl context name when
kubeconfig_file_enabled is true and kubeconfig_context is not supplied.
Must include a single %s which will be replaced with the cluster name.



Default value: ""

kubeconfig_exec_auth_api_version (string) optional

The Kubernetes API version of the credentials returned by the exec auth plugin


Default value: "client.authentication.k8s.io/v1beta1"

kubeconfig_file (string) optional

The Kubernetes provider config_path setting to use when kubeconfig_file_enabled is true


Default value: ""

kubeconfig_file_enabled (bool) optional

If true, configure the Kubernetes provider with kubeconfig_file and use that kubeconfig file for authenticating to the EKS cluster


Default value: false

repository (string) optional

Repository URL where to locate the requested chart


Default value: null

timeout (number) optional

Time in seconds to wait for any individual kubernetes operation (like Jobs for hooks). Defaults to 300 seconds


Default value: null

values (any) optional

Additional values to yamlencode as helm_release values.


Default value: { }

verify (bool) optional

Verify the package before installing it. Helm uses a provenance file to verify the integrity of the chart; this must be hosted alongside the chart


Default value: false

wait (bool) optional

Will wait until all resources are in a ready state before marking the release as successful. It will wait for as long as timeout. Defaults to true


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.

additional_tag_map (map(string)) optional

Additional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.
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)) optional

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.


Required: No

Default value: [ ]

context (any) optional

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.


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) optional

Delimiter 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) optional

Describe 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 is any so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to the format() function.
labels is a list of labels, in order, to pass to format() function.
Label values will be normalized before being passed to format() so they will be
identical to how they appear in id.
Default is {} (descriptors output will be empty).


Required: No

Default value: { }

enabled (bool) optional

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional

Limit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for keep the existing setting, which defaults to 0.
Does not affect id_full.


Required: No

Default value: null

label_key_case (string) optional

Controls the letter case of the tags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags input.
Possible values: lower, title, upper.
Default value: title.


Required: No

Default value: null

label_order (list(string)) optional

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.


Required: No

Default value: null

label_value_case (string) optional

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.


Required: No

Default value: null

labels_as_tags (set(string)) optional

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.


Required: No

Default value:

[
  "default"
]
name (string) optional

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.


Required: No

Default value: null

namespace (string) optional

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional

Terraform 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) optional

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional

Additional 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) optional

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs​

cluster_checks

Cluster Checks for the cluster

metadata

Block status of the deployed release

Dependencies​

Requirements​

  • terraform, version: >= 1.0.0
  • aws, version: >= 4.9.0, < 6.0.0
  • helm, version: >= 2.7
  • kubernetes, version: >= 2.14.0, != 2.21.0
  • utils, version: >= 1.10.0

Providers​

  • aws, version: >= 4.9.0, < 6.0.0

Modules​

NameVersionSourceDescription
datadog_agent0.10.1cloudposse/helm-release/awsn/a
datadog_cluster_check_yaml_config1.0.2cloudposse/config/yamln/a
datadog_configurationv1.535.6github.com/cloudposse-terraform-components/aws-datadog-credentials//src/modules/datadog_keysn/a
eks1.8.0cloudposse/stack-config/yaml//modules/remote-staten/a
iam_roleslatest../../account-map/modules/iam-rolesn/a
this0.25.0cloudposse/label/nulln/a
values_merge1.0.2cloudposse/config/yaml//modules/deepmergen/a

Resources​

The following resources are used by this module:

Data Sources​

The following data sources are used by this module:

References​