Skip to content
/ aws-eks-external-dns Public
generated from cloudposse-terraform-components/template

This component creates a Helm deployment for external-dns on a Kubernetes cluster

cloudposse.com/accelerate
0 stars 0 forks Branches Tags Activity
Star

cloudposse-terraform-components/aws-eks-external-dns

BranchesTags

Repository files navigation

Project Banner

Latest ReleaseSlack CommunityGet Support

This component creates a Helm deployment for external-dns on a Kubernetes cluster. external-dns is a Kubernetes addon that configures public DNS servers with information about exposed Kubernetes services to make them discoverable.

Tip

👽 Use Atmos with Terraform

Cloud Posse uses atmos to easily orchestrate multiple environments using Terraform.
Works with Github Actions, Atlantis, or Spacelift.

Watch demo of using Atmos with Terraform
Example of running atmos to manage infrastructure from our Quick Start tutorial.

Usage

Stack Level: Regional

Once the catalog is created, the file can be imported as follows.

import:
  - catalog/eks/external-dns
  ...

The default catalog values e.g. stacks/catalog/eks/external-dns.yaml

components:
  terraform:
    external-dns:
      vars:
        enabled: true
        name: external-dns
        chart: external-dns
        chart_repository: https://kubernetes-sigs.github.io/external-dns/
        chart_version: "1.18.0"
        create_namespace: true
        kubernetes_namespace: external-dns
        resources:
          limits:
            cpu: 200m
            memory: 256Mi
          requests:
            cpu: 100m
            memory: 128Mi
        # Set this to a unique value to avoid conflicts with other external-dns instances managing the same zones.
        # For example, when using blue-green deployment pattern to update EKS cluster.
        txt_prefix: ""
        # You can use `chart_values` to set any other chart options. Treat `chart_values` as the root of the doc.
        # See documentation for latest chart version and list of chart_values: https://artifacthub.io/packages/helm/external-dns/external-dns
        #
        # # For example
        # ---
        # chart_values:
        #   provider:
        #     name: aws
        #   extraArgs:
        #     - --aws-batch-change-size=1000
        chart_values: {}
        # Extra hosted zones to lookup and support by component name
        dns_components:
          - component: dns-primary
          - component: dns-delegated
          - component: dns-delegated/abc
          - component: dns-delegated/123
            environment: "gbl" # Optional (default "gbl")

Important

In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic approach for updating versions to avoid unexpected changes.

Requirements

Name Version
terraform >= 1.0.0
aws >= 4.9.0, < 6.0.0
helm >= 2.0.0, < 3.0.0
kubernetes >= 2.7.1, != 2.21.0

Providers

Name Version
aws >= 4.9.0, < 6.0.0

Modules

Name Source Version
additional_dns_components cloudposse/stack-config/yaml//modules/remote-state 1.8.0
dns_gbl_delegated cloudposse/stack-config/yaml//modules/remote-state 1.8.0
dns_gbl_primary cloudposse/stack-config/yaml//modules/remote-state 1.8.0
eks cloudposse/stack-config/yaml//modules/remote-state 1.8.0
external_dns cloudposse/helm-release/aws 0.10.1
iam_roles ../../account-map/modules/iam-roles n/a
this cloudposse/label/null 0.25.0

Resources

Name Type
aws_eks_cluster_auth.eks data source
aws_partition.current data source

Inputs

Name Description Type Default Required
additional_tag_map 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.		 map(string) {} no
atomic If set, installation process purges chart on fail. The wait flag will be set automatically if atomic is used. bool true no
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
chart 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. string n/a yes
chart_description Set release description attribute (visible in the history). string null no
chart_repository Repository URL where to locate the requested chart. string n/a yes
chart_values Addition map values to yamlencode as helm_release values. any {} no
chart_version Specify the exact chart version to install. If this is not specified, the latest version is installed. string null no
cleanup_on_fail Allow deletion of new resources created in this upgrade when upgrade fails. bool true no
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
crd_enabled Install and use the integrated DNSEndpoint CRD. bool false no
create_namespace Create the namespace if it does not yet exist. Defaults to false. bool null no
delimiter Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.		 string null no
descriptor_formats 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).		 any {} no
dns_components A list of additional DNS components to search for ZoneIDs 
list(object({
    component   = string,
    environment = optional(string)
  }))
 [] no
dns_gbl_delegated_environment_name The name of the environment where global dns_delegated is provisioned string "gbl" no
dns_gbl_primary_environment_name The name of the environment where global dns_primary is provisioned string "gbl" no
eks_component_name The name of the eks component string "eks/cluster" no
enabled Set to false to prevent the module from creating any resources bool null no
environment ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' string null no
helm_manifest_experiment_enabled Enable storing of the rendered manifest for helm_release so the full diff of what is changing can been seen in the plan bool false no
id_length_limit 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.		 number null no
istio_enabled Add istio gateways to monitored sources. bool false no
kube_data_auth_enabled 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.		 bool false no
kube_exec_auth_aws_profile The AWS config profile for aws eks get-token to use string "" no
kube_exec_auth_aws_profile_enabled If true, pass kube_exec_auth_aws_profile as the profile to aws eks get-token bool false no
kube_exec_auth_enabled 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.		 bool true no
kube_exec_auth_role_arn The role ARN for aws eks get-token to use string "" no
kube_exec_auth_role_arn_enabled If true, pass kube_exec_auth_role_arn as the role ARN to aws eks get-token bool true no
kubeconfig_context Context to choose from the Kubernetes config file.
If supplied, kubeconfig_context_format will be ignored.		 string "" no
kubeconfig_context_format 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.		 string "" no
kubeconfig_exec_auth_api_version The Kubernetes API version of the credentials returned by the exec auth plugin string "client.authentication.k8s.io/v1beta1" no
kubeconfig_file The Kubernetes provider config_path setting to use when kubeconfig_file_enabled is true string "" no
kubeconfig_file_enabled If true, configure the Kubernetes provider with kubeconfig_file and use that kubeconfig file for authenticating to the EKS cluster bool false no
kubernetes_namespace The namespace to install the release into. string n/a yes
label_key_case 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.		 string null no
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 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 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
metrics_enabled Whether or not to enable metrics in the helm chart. bool false no
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 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
policy Modify how DNS records are synchronized between sources and providers (options: sync, upsert-only) string "sync" no
rbac_enabled Service Account for pods. bool true no
regex_replace_chars 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.		 string null no
region AWS Region. string n/a yes
resources The cpu and memory of the deployment's limits and requests. 
object({
    limits = object({
      cpu    = string
      memory = string
    })
    requests = object({
      cpu    = string
      memory = string
    })
  })
 
{
  "limits": {
    "cpu": "200m",
    "memory": "256Mi"
  },
  "requests": {
    "cpu": "100m",
    "memory": "128Mi"
  }
}
 no
stage ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' string null no
tags Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.		 map(string) {} no
tenant ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for string null no
timeout Time in seconds to wait for any individual kubernetes operation (like Jobs for hooks). Defaults to 300 seconds number null no
txt_prefix Prefix to create a TXT record with a name following the pattern prefix.<CNAME record>. string "external-dns" no
wait 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. bool null no

Outputs

Name Description
metadata Block status of the deployed release

Related Projects

Check out these related projects.

  • Cloud Posse Terraform Modules - Our collection of reusable Terraform modules used by our reference architectures.
  • Atmos - Atmos is like docker-compose but for your infrastructure

References

For additional context, refer to some of these links.

Tip

Use Terraform Reference Architectures for AWS

Use Cloud Posse's ready-to-go terraform architecture blueprints for AWS to get up and running quickly.

✅ We build it together with your team.
✅ Your team owns everything.
✅ 100% Open Source and backed by fanatical support.

Request Quote

📚 Learn More

Cloud Posse is the leading DevOps Accelerator for funded startups and enterprises.

Your team can operate like a pro today.

Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.

Day-0: Your Foundation for Success

  • Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
  • Deployment Strategy. Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.
  • Site Reliability Engineering. Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.
  • Security Baseline. Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.
  • GitOps. Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.

Request Quote

Day-2: Your Operational Mastery

  • Training. Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.
  • Support. Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.
  • Troubleshooting. Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.
  • Code Reviews. Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.
  • Bug Fixes. Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.
  • Migration Assistance. Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.
  • Customer Workshops. Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.

Request Quote

✨ Contributing

This project is under active development, and we encourage contributions from our community.

Many thanks to our outstanding contributors:

For 🐛 bug reports & feature requests, please use the issue tracker.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

  1. Review our Code of Conduct and Contributor Guidelines.
  2. Fork the repo on GitHub
  3. Clone the project to your own machine
  4. Commit changes to your own branch
  5. Push your work back up to your fork
  6. Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

Running Terraform Tests

We use Atmos to streamline how Terraform tests are run. It centralizes configuration and wraps common test workflows with easy-to-use commands.

All tests are located in the test/ folder.

Under the hood, tests are powered by Terratest together with our internal Test Helpers library, providing robust infrastructure validation.

Setup dependencies:

To run tests:

  • Run all tests: 
    atmos test run
  • Clean up test artifacts: 
    atmos test clean
  • Explore additional test options: 
    atmos test --help

The configuration for test commands is centrally managed. To review what's being imported, see the atmos.yaml file.

Learn more about our automated testing in our documentation or implementing custom commands with atmos.

🌎 Slack Community

Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.

📰 Newsletter

Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week — and usually a 5-minute read.

📆 Office Hours

Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you can’t find anywhere else. It's FREE for everyone!

License

License

Preamble to the Apache License, Version 2.0 

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

Trademarks

All other trademarks referenced herein are the property of their respective owners.

Copyright © 2017-2025 Cloud Posse, LLC

README footer

Beacon

About

This component creates a Helm deployment for external-dns on a Kubernetes cluster

cloudposse.com/accelerate

Topics

terraform terraform-component

Resources

Readme

Code of conduct

Code of conduct

Contributing

Contributing

Security policy

Security policy
Activity
Custom properties

Stars

0 stars

Watchers

6 watching

Forks

0 forks
Report repository

Releases 9

v2.0.0 Latest
Aug 27, 2025
+ 8 releases

Sponsor this project

 
Learn more about GitHub Sponsors

Packages

No packages published

Contributors 14

Languages