package envoy.data.dns.v3

Get desktop application:
View/edit binary Protocol Buffers messages

This message contains the configuration for the DNS Filter if populated from the control plane

Used in: extensions.filters.udp.dns_filter.v3.DnsFilterConfig.ServerContextConfig

• uint32 external_retry_count = 1

  Control how many times Envoy makes an attempt to forward a query to an external DNS server

• repeated DnsTable.DnsVirtualDomain virtual_domains = 2

  Fully qualified domain names for which Envoy will respond to DNS queries. By leaving this list empty, Envoy will forward all queries to external resolvers

• repeated type.matcher.v3.StringMatcher known_suffixes = 3

  This field is deprecated and no longer used in Envoy. The filter's behavior has changed internally to use a different data structure allowing the filter to determine whether a query is for known domain without the use of this field. This field serves to help Envoy determine whether it can authoritatively answer a query for a name matching a suffix in this list. If the query name does not match a suffix in this list, Envoy will forward the query to an upstream DNS server

This message contains a list of IP addresses returned for a query for a known name

Used in: DnsEndpoint

• repeated string address = 1

  This field contains a well formed IP address that is returned in the answer for a name query. The address field can be an IPv4 or IPv6 address. Address family detection is done automatically when Envoy parses the string. Since this field is repeated, Envoy will return as many entries from this list in the DNS response while keeping the response under 512 bytes

Used in: DnsVirtualDomain

• oneof endpoint_config

  • AddressList address_list = 1

    Define a list of addresses to return for the specified endpoint

  • string cluster_name = 2

    Define a cluster whose addresses are returned for the specified endpoint

  • DnsServiceList service_list = 3

    Define a DNS Service List for the specified endpoint

This message defines a service selection record returned for a service query in a domain

Used in: DnsServiceList

• string service_name = 1

  The name of the service without the protocol or domain name

• optional DnsServiceProtocol protocol = 2

  The service protocol. This can be specified as a string or the numeric value of the protocol

• optional google.protobuf.Duration ttl = 3

  The service entry time to live. This is independent from the DNS Answer record TTL

• repeated DnsServiceTarget targets = 4

  The list of targets hosting the service

Define a list of service records for a given service

Used in: DnsEndpoint

• repeated DnsService services = 1

Specify the service protocol using a numeric or string value

Used in: DnsService

• oneof protocol_config

  • uint32 number = 1

    Specify the protocol number for the service. Envoy will try to resolve the number to the protocol name. For example, 6 will resolve to "tcp". Refer to: https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml for protocol names and numbers

  • string name = 2

    Specify the protocol name for the service.

Specify the target for a given DNS service [#next-free-field: 6]

Used in: DnsService

• oneof endpoint_type

  Specify the name of the endpoint for the Service. The name is a hostname or a cluster

  • string host_name = 1

    Use a resolvable hostname as the endpoint for a service.

  • string cluster_name = 2

    Use a cluster name as the endpoint for a service.

• uint32 priority = 3

  The priority of the service record target

• uint32 weight = 4

  The weight of the service record target

• uint32 port = 5

  The port to which the service is bound. This value is optional if the target is a cluster. Setting port to zero in this case makes the filter use the port value from the cluster host

Used in: DnsTable

• string name = 1

  A domain name for which Envoy will respond to query requests. Wildcard records are supported on the first label only, e.g. ``*.example.com`` or ``*.subdomain.example.com``. Names such as ``*example.com``, ``subdomain.*.example.com``, ``*subdomain.example.com``, etc are not valid wildcard names and asterisk will be interpreted as a literal ``*`` character. Wildcard records match subdomains on any levels, e.g. ``*.example.com`` will match ``foo.example.com``, ``bar.foo.example.com``, ``baz.bar.foo.example.com``, etc. In case there are multiple wildcard records, the longest wildcard match will be used, e.g. if there are wildcard records for ``*.example.com`` and ``*.foo.example.com`` and the query is for ``bar.foo.example.com``, the latter will be used. Specific records will always take precedence over wildcard records.

• optional DnsEndpoint endpoint = 2

  The configuration containing the method to determine the address of this endpoint

• optional google.protobuf.Duration answer_ttl = 3

  Sets the TTL in DNS answers from Envoy returned to the client. The default TTL is 300s