Skip to content

Commit

Permalink
docs: Update External DNS module docs
Browse files Browse the repository at this point in the history
  • Loading branch information
grifonas committed Dec 13, 2023
1 parent 0af14c0 commit dde6819
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions external-dns/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,31 @@ module "external_dns" {
hosted_zone_id = [ Route53 hosted zone ID ]
aws_route53_domain = [ Route53 domain ]
}
```


## Using External DNS
Extensive docs can be found in [External DNS project Github](https://github.com/kubernetes-sigs/external-dns/tree/master#readme).

**TL;DR**:

Once installed you can annotate your services in order for DNS records to be created for them:

* For LoadBalancer Services:
```bash
kubectl annotate service nginx "external-dns.alpha.kubernetes.io/hostname=nginx.example.org."
```


* For ClusterIP Services:

Use the internal-hostname annotation to create DNS records with ClusterIP as the target.

```bash
kubectl annotate service nginx "external-dns.alpha.kubernetes.io/internal-hostname=nginx.internal.example.org."
```

Optionally, you can customize the TTL value of the resulting DNS record by using the `external-dns.alpha.kubernetes.io/ttl` annotation:
```bash
kubectl annotate service nginx "external-dns.alpha.kubernetes.io/ttl=10"
```

0 comments on commit dde6819

Please sign in to comment.