Merge pull request #13526 from hashicorp/dns-parititon-docs

docs: Clarify section on partitioned node DNS lookups
This commit is contained in:
Kyle Havlovitz 2022-06-22 10:59:04 -07:00 committed by GitHub
commit 6c85770ff8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 7 deletions

View File

@ -469,7 +469,9 @@ options.
## Namespaced/Partitioned Services and Nodes <EnterpriseAlert inline /> ## Namespaced/Partitioned Services and Nodes <EnterpriseAlert inline />
Consul Enterprise supports resolving namespaced and partitioned services and nodes via DNS. Consul Enterprise supports resolving namespaced and partitioned services via DNS.
The DNS server in Consul Enterprise can resolve services assigned to namespaces and partitions.
The DNS server can also resolve nodes assigned to partitions.
To maintain backwards compatibility existing queries can be used and these will To maintain backwards compatibility existing queries can be used and these will
resolve services within the `default` namespace and partition. However, for resolving resolve services within the `default` namespace and partition. However, for resolving
services from other namespaces or partitions the following form can be used: services from other namespaces or partitions the following form can be used:
@ -478,12 +480,18 @@ services from other namespaces or partitions the following form can be used:
[tag.]<service>.service.<namespace>.ns.<partition>.ap.<datacenter>.dc.<domain> [tag.]<service>.service.<namespace>.ns.<partition>.ap.<datacenter>.dc.<domain>
``` ```
This is the canonical name of a Consul Enterprise service. Currently at least 2 of This sequence is the canonical naming convention of a Consul Enterprise service. At least two of the following
`[namespace, partition, datacenter]` must be present - in a future version (once the fields must be present:
[`prefer_namespace` configuration](/docs/agent/config/config-files#dns_prefer_namespace) has been * `namespace`
deprecated), the namespace, partition and datacenter components will all become optional * `partition`
and may be individually omitted to default to the `default` namespace, local partition * `datacenter`
or local datacenter respectively.
For node lookups, only the partition and datacenter need to be specified as nodes cannot be
namespaced.
```text
[tag.]<service>.service.<partition>.ap.<datacenter>.dc.<domain>
```
For node lookups, only the partition and datacenter need to be specified (nodes cannot be For node lookups, only the partition and datacenter need to be specified (nodes cannot be
namespaced): namespaced):