Skip to content

Commit d9a20d1

Browse files
docs: clarify hostname annotation behavior (kubernetes-sigs#5912)
* docs: clarify hostname annotation behavior * docs: specify how hostname annotation behavior can be configured Co-authored-by: Michel Loiseleur <[email protected]> --------- Co-authored-by: Michel Loiseleur <[email protected]>
1 parent 5f3d9dc commit d9a20d1

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

docs/annotations/annotations.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Otherwise, use the `IP` of each of the `Service`'s `Endpoints`'s `Addresses`.
6464

6565
## external-dns.alpha.kubernetes.io/hostname
6666

67-
Specifies the domain for the resource's DNS records.
67+
Specifies additional domains for the resource's DNS records.
6868

6969
Multiple hostnames can be specified through a comma-separated list, e.g.
7070
`svc.mydomain1.com,svc.mydomain2.com`.
@@ -73,7 +73,8 @@ For `Pods`, uses the `Pod`'s `Status.PodIP`, unless they are `hostNetwork: true`
7373

7474
Notes:
7575

76-
- This annotation `overrides` any automatically derived hostnames (e.g., from Ingress.spec.rules[].host).
76+
- This annotation can override or add extra hostnames alongside any automatically derived hostnames (e.g., from Ingress.spec.rules[].host).
77+
- The [`ingress-hostname-source`](#external-dnsalphakubernetesioingress-hostname-source) annotation may be used to specify where to get the domain for an `Ingress` resource.
7778
- Hostnames must match the domain filter set in ExternalDNS (e.g., --domain-filter=example.com).
7879
- This is an alpha annotation — subject to change; newer versions may support alternatives or deprecate it.
7980
- This annotation is helpful for:

0 commit comments

Comments
 (0)