external-dns

ExternalDNS is a Kubernetes addon that configures public DNS servers with information about exposed Kubernetes services to make them discoverable.

TL;DR;

$ helm install bitnami/external-dns

Introduction

This chart bootstraps a ExternalDNS deployment on a Kubernetes cluster using the Helm package manager.

Prerequisites

Kubernetes 1.4+ with Beta APIs enabled
PV provisioner support in the underlying infrastructure

Installing the Chart

To install the chart with the release name my-release:

$ helm install --name my-release bitnami/external-dns

The command deploys ExternalDNS on the Kubernetes cluster in the default configuration. The configuration section lists the parameters that can be configured during installation.

Tip

: List all releases using helm list

Uninstalling the Chart

To uninstall/delete the my-release deployment:

$ helm delete my-release

The command removes all the Kubernetes components associated with the chart and deletes the release.

Configuration

The following table lists the configurable parameters of the external-dns chart and their default values.

Parameter	Description	Default
`image.registry`	ExternalDNS image registry	`docker.io`
`image.repository`	ExternalDNS Image name	`bitnami/external-dns`
`image.tag`	ExternalDNS Image tag	`{VERSION}`
`image.pullPolicy`	ExternalDNS image pull policy	`Always`
`image.pullSecrets`	Specify image pull secrets	`nil` (does not add image pull secrets to deployed pods)
`image.debug`	Specify if debug values should be set	`false`
`sources`	List of resource types to be observed for new DNS entries by ExternalDNS	`[service, ingress]`
`provider`	DNS provider where the DNS records will be created (mandatory). E.g.: aws, azure, google, ...	`nil`
`publishInternalServices`	Whether to publish DNS records for ClusterIP services or not	`false`
`policy`	Method to synchronise DNS records between sources and providers (accepted values: sync, upsert-only)	`upsert-only`
`registry`	Registry type (accepted values: txt, noop)	`txt`
`txtOwnerId`	TXT Registry Identifier	`"default"`
`txtPrefix`	Prefix to create a TXT record with a name following the pattern prefix.	`nil`
`logLevel`	Verbosity of the ExternalDNS logs (accepted values: panic, debug, info, warn, error, fatal)	`info`
`domainFilters`	Limit possible target zones by domain suffixes	`[]`
`annotationFilter`	Filter sources managed by external-dns via annotation using label selector semantics	`nil`
`extraArgs`	Extra Arguments to passed to external-dns	`{}`
`extraEnv`	Extra env. variable to set on external-dns container	`{}`
`aws.accessKey`	`AWS_ACCESS_KEY_ID` to set (only if provider == 'aws')	`""`
`aws.secretKey`	`AWS_SECRET_ACCESS_KEY` to set (only if provider == 'aws')	`""`
`aws.region`	`AWS_DEFAULT_REGION` to set (only if provider == 'aws')	`us-east-1`
`aws.roleArn`	Use this `role_arn` if role credentials are used (only if provider == 'aws')	`""`
`aws.zoneType`	Filter for zones of this type (only if provider == 'aws', accepted values: public, private)	`""`
`azure.resoureGroup`	Azure Resource Group (only if provider == 'azure')	`""`
`cloudflare.apiKey`	`CF_API_KEY` to set in the environment (only if provider == 'cloudflare')	`""`
`cloudflare.email`	`CF_API_EMAIL` to set in the environment (only if provider == 'cloudflare')	`""`
`google.project`	Google project (only if provider == 'google')	`""`
`google.serviceAccountSecret`	Secret which contains credentials.json for Google (only if provider == 'google')	`""`
`service.type`	Kubernetes Service type	`ClusterIP`
`service.port`	ExternalDNS client port	`7979`
`service.nodePort`	Port to bind to for NodePort service type (client port)	`nil`
`service.annotations`	Annotations for ExternalDNS service	{}
`service.loadBalancerIP`	loadBalancerIP if ExternalDNS service type is `LoadBalancer`	`nil`
`rbac.create`	Wether to create & use RBAC resources or not	`false`
`rbac.serviceAccountName`	ServiceAccount (ignored if rbac.create == true)	`default`
`rbac.apiVersion`	Version of the RBAC API	`v1beta1`
`securityContext.enabled`	Enable security context	`true`
`securityContext.fsGroup`	Group ID for the container	`1001`
`securityContext.runAsUser`	User ID for the container	`1001`
`nodeSelector`	Node labels for pod assignment	`{}`
`tolerations`	Toleration labels for pod assignment	`[]`
`podAnnotations`	Additional annotations to apply to the pod.	`{}`
`replicas`	Desired number of ExternalDNS replicas	`1`
`resources`	CPU/Memory resource requests/limits	Memory: `256Mi`, CPU: `250m`
`livenessProbe.enabled`	Turn on and off liveness probe	`true`
`livenessProbe.initialDelaySeconds`	Delay before liveness probe is initiated	10
`livenessProbe.periodSeconds`	How often to perform the probe	10
`livenessProbe.timeoutSeconds`	When the probe times out	5
`livenessProbe.failureThreshold`	Minimum consecutive failures for the probe to be considered failed after having succeeded.	2
`livenessProbe.successThreshold`	Minimum consecutive successes for the probe to be considered successful after having failed	1
`readinessProbe.enabled`	Turn on and off readiness probe	`true`
`readinessProbe.initialDelaySeconds`	Delay before liveness probe is initiated	5
`readinessProbe.periodSeconds`	How often to perform the probe	10
`readinessProbe.timeoutSeconds`	When the probe times out	5
`readinessProbe.failureThreshold`	Minimum consecutive failures for the probe to be considered failed after having succeeded.	6
`readinessProbe.successThreshold`	Minimum consecutive successes for the probe to be considered successful after having failed	1

Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

$ helm install --name my-release \
  --set auth.rootPassword=secretpassword bitnami/external-dns

Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,

$ helm install --name my-release -f values.yaml bitnami/external-dns

Tip

: You can use the default values.yaml

Tutorials

Find information about the requirements for each DNS provider on the link below:

ExternalDNS Tutorials