import "github.com/envoyproxy/go-control-plane/envoy/extensions/common/dynamic_forward_proxy/v3"
dns_cache.pb.go dns_cache.pb.validate.go
var File_envoy_extensions_common_dynamic_forward_proxy_v3_dns_cache_proto protoreflect.FileDescriptor
type DnsCacheCircuitBreakers struct { // The maximum number of pending requests that Envoy will allow to the // resolver. If not specified, the default is 1024. MaxPendingRequests *wrappers.UInt32Value `protobuf:"bytes,1,opt,name=max_pending_requests,json=maxPendingRequests,proto3" json:"max_pending_requests,omitempty"` // contains filtered or unexported fields }
Configuration of circuit breakers for resolver.
func (*DnsCacheCircuitBreakers) Descriptor() ([]byte, []int)
Deprecated: Use DnsCacheCircuitBreakers.ProtoReflect.Descriptor instead.
func (x *DnsCacheCircuitBreakers) GetMaxPendingRequests() *wrappers.UInt32Value
func (*DnsCacheCircuitBreakers) ProtoMessage()
func (x *DnsCacheCircuitBreakers) ProtoReflect() protoreflect.Message
func (x *DnsCacheCircuitBreakers) Reset()
func (x *DnsCacheCircuitBreakers) String() string
func (m *DnsCacheCircuitBreakers) Validate() error
Validate checks the field values on DnsCacheCircuitBreakers with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type DnsCacheCircuitBreakersValidationError struct {
// contains filtered or unexported fields
}
DnsCacheCircuitBreakersValidationError is the validation error returned by DnsCacheCircuitBreakers.Validate if the designated constraints aren't met.
func (e DnsCacheCircuitBreakersValidationError) Cause() error
Cause function returns cause value.
func (e DnsCacheCircuitBreakersValidationError) Error() string
Error satisfies the builtin error interface
func (e DnsCacheCircuitBreakersValidationError) ErrorName() string
ErrorName returns error name.
func (e DnsCacheCircuitBreakersValidationError) Field() string
Field function returns field value.
func (e DnsCacheCircuitBreakersValidationError) Key() bool
Key function returns key value.
func (e DnsCacheCircuitBreakersValidationError) Reason() string
Reason function returns reason value.
type DnsCacheConfig struct { // The name of the cache. Multiple named caches allow independent dynamic forward proxy // configurations to operate within a single Envoy process using different configurations. All // configurations with the same name *must* otherwise have the same settings when referenced // from different configuration components. Configuration will fail to load if this is not // the case. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // The DNS lookup family to use during resolution. // // [#comment:TODO(mattklein123): Figure out how to support IPv4/IPv6 "happy eyeballs" mode. The // way this might work is a new lookup family which returns both IPv4 and IPv6 addresses, and // then configures a host to have a primary and fall back address. With this, we could very // likely build a "happy eyeballs" connection pool which would race the primary / fall back // address and return the one that wins. This same method could potentially also be used for // QUIC to TCP fall back.] DnsLookupFamily v3.Cluster_DnsLookupFamily `protobuf:"varint,2,opt,name=dns_lookup_family,json=dnsLookupFamily,proto3,enum=envoy.config.cluster.v3.Cluster_DnsLookupFamily" json:"dns_lookup_family,omitempty"` // The DNS refresh rate for currently cached DNS hosts. If not specified defaults to 60s. // // .. note: // // The returned DNS TTL is not currently used to alter the refresh rate. This feature will be // added in a future change. // // .. note: // // The refresh rate is rounded to the closest millisecond, and must be at least 1ms. DnsRefreshRate *duration.Duration `protobuf:"bytes,3,opt,name=dns_refresh_rate,json=dnsRefreshRate,proto3" json:"dns_refresh_rate,omitempty"` // The TTL for hosts that are unused. Hosts that have not been used in the configured time // interval will be purged. If not specified defaults to 5m. // // .. note: // // The TTL is only checked at the time of DNS refresh, as specified by *dns_refresh_rate*. This // means that if the configured TTL is shorter than the refresh rate the host may not be removed // immediately. // // .. note: // // The TTL has no relation to DNS TTL and is only used to control Envoy's resource usage. HostTtl *duration.Duration `protobuf:"bytes,4,opt,name=host_ttl,json=hostTtl,proto3" json:"host_ttl,omitempty"` // The maximum number of hosts that the cache will hold. If not specified defaults to 1024. // // .. note: // // The implementation is approximate and enforced independently on each worker thread, thus // it is possible for the maximum hosts in the cache to go slightly above the configured // value depending on timing. This is similar to how other circuit breakers work. MaxHosts *wrappers.UInt32Value `protobuf:"bytes,5,opt,name=max_hosts,json=maxHosts,proto3" json:"max_hosts,omitempty"` // If the DNS failure refresh rate is specified, // this is used as the cache's DNS refresh rate when DNS requests are failing. If this setting is // not specified, the failure refresh rate defaults to the dns_refresh_rate. DnsFailureRefreshRate *v3.Cluster_RefreshRate `protobuf:"bytes,6,opt,name=dns_failure_refresh_rate,json=dnsFailureRefreshRate,proto3" json:"dns_failure_refresh_rate,omitempty"` // The config of circuit breakers for resolver. It provides a configurable threshold. // Envoy will use dns cache circuit breakers with default settings even if this value is not set. DnsCacheCircuitBreaker *DnsCacheCircuitBreakers `protobuf:"bytes,7,opt,name=dns_cache_circuit_breaker,json=dnsCacheCircuitBreaker,proto3" json:"dns_cache_circuit_breaker,omitempty"` // [#next-major-version: Reconcile DNS options in a single message.] // Always use TCP queries instead of UDP queries for DNS lookups. // Setting this value causes failure if the // ``envoy.restart_features.use_apple_api_for_dns_lookups`` runtime value is true during // server startup. Apple' API only uses UDP for DNS resolution. UseTcpForDnsLookups bool `protobuf:"varint,8,opt,name=use_tcp_for_dns_lookups,json=useTcpForDnsLookups,proto3" json:"use_tcp_for_dns_lookups,omitempty"` // contains filtered or unexported fields }
Configuration for the dynamic forward proxy DNS cache. See the :ref:`architecture overview <arch_overview_http_dynamic_forward_proxy>` for more information. [#next-free-field: 9]
func (*DnsCacheConfig) Descriptor() ([]byte, []int)
Deprecated: Use DnsCacheConfig.ProtoReflect.Descriptor instead.
func (x *DnsCacheConfig) GetDnsCacheCircuitBreaker() *DnsCacheCircuitBreakers
func (x *DnsCacheConfig) GetDnsFailureRefreshRate() *v3.Cluster_RefreshRate
func (x *DnsCacheConfig) GetDnsLookupFamily() v3.Cluster_DnsLookupFamily
func (x *DnsCacheConfig) GetDnsRefreshRate() *duration.Duration
func (x *DnsCacheConfig) GetHostTtl() *duration.Duration
func (x *DnsCacheConfig) GetMaxHosts() *wrappers.UInt32Value
func (x *DnsCacheConfig) GetName() string
func (x *DnsCacheConfig) GetUseTcpForDnsLookups() bool
func (*DnsCacheConfig) ProtoMessage()
func (x *DnsCacheConfig) ProtoReflect() protoreflect.Message
func (x *DnsCacheConfig) Reset()
func (x *DnsCacheConfig) String() string
func (m *DnsCacheConfig) Validate() error
Validate checks the field values on DnsCacheConfig with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type DnsCacheConfigValidationError struct {
// contains filtered or unexported fields
}
DnsCacheConfigValidationError is the validation error returned by DnsCacheConfig.Validate if the designated constraints aren't met.
func (e DnsCacheConfigValidationError) Cause() error
Cause function returns cause value.
func (e DnsCacheConfigValidationError) Error() string
Error satisfies the builtin error interface
func (e DnsCacheConfigValidationError) ErrorName() string
ErrorName returns error name.
func (e DnsCacheConfigValidationError) Field() string
Field function returns field value.
func (e DnsCacheConfigValidationError) Key() bool
Key function returns key value.
func (e DnsCacheConfigValidationError) Reason() string
Reason function returns reason value.
Package envoy_extensions_common_dynamic_forward_proxy_v3 imports 21 packages (graph) and is imported by 10 packages. Updated 2021-01-19. Refresh now. Tools for package owners.