Documentation
¶
Index ¶
- Variables
- type DnsCacheCircuitBreakers
- func (*DnsCacheCircuitBreakers) Descriptor() ([]byte, []int)deprecated
- 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
- type DnsCacheCircuitBreakersValidationError
- func (e DnsCacheCircuitBreakersValidationError) Cause() error
- func (e DnsCacheCircuitBreakersValidationError) Error() string
- func (e DnsCacheCircuitBreakersValidationError) ErrorName() string
- func (e DnsCacheCircuitBreakersValidationError) Field() string
- func (e DnsCacheCircuitBreakersValidationError) Key() bool
- func (e DnsCacheCircuitBreakersValidationError) Reason() string
- type DnsCacheConfig
- func (*DnsCacheConfig) Descriptor() ([]byte, []int)deprecated
- 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
- type DnsCacheConfigValidationError
- func (e DnsCacheConfigValidationError) Cause() error
- func (e DnsCacheConfigValidationError) Error() string
- func (e DnsCacheConfigValidationError) ErrorName() string
- func (e DnsCacheConfigValidationError) Field() string
- func (e DnsCacheConfigValidationError) Key() bool
- func (e DnsCacheConfigValidationError) Reason() string
Constants ¶
This section is empty.
Variables ¶
var File_envoy_extensions_common_dynamic_forward_proxy_v3_dns_cache_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type DnsCacheCircuitBreakers ¶ added in v0.9.6
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
deprecated
added in
v0.9.6
func (*DnsCacheCircuitBreakers) Descriptor() ([]byte, []int)
Deprecated: Use DnsCacheCircuitBreakers.ProtoReflect.Descriptor instead.
func (*DnsCacheCircuitBreakers) GetMaxPendingRequests ¶ added in v0.9.6
func (x *DnsCacheCircuitBreakers) GetMaxPendingRequests() *wrappers.UInt32Value
func (*DnsCacheCircuitBreakers) ProtoMessage ¶ added in v0.9.6
func (*DnsCacheCircuitBreakers) ProtoMessage()
func (*DnsCacheCircuitBreakers) ProtoReflect ¶ added in v0.9.6
func (x *DnsCacheCircuitBreakers) ProtoReflect() protoreflect.Message
func (*DnsCacheCircuitBreakers) Reset ¶ added in v0.9.6
func (x *DnsCacheCircuitBreakers) Reset()
func (*DnsCacheCircuitBreakers) String ¶ added in v0.9.6
func (x *DnsCacheCircuitBreakers) String() string
func (*DnsCacheCircuitBreakers) Validate ¶ added in v0.9.6
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 ¶ added in v0.9.6
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 (DnsCacheCircuitBreakersValidationError) Cause ¶ added in v0.9.6
func (e DnsCacheCircuitBreakersValidationError) Cause() error
Cause function returns cause value.
func (DnsCacheCircuitBreakersValidationError) Error ¶ added in v0.9.6
func (e DnsCacheCircuitBreakersValidationError) Error() string
Error satisfies the builtin error interface
func (DnsCacheCircuitBreakersValidationError) ErrorName ¶ added in v0.9.6
func (e DnsCacheCircuitBreakersValidationError) ErrorName() string
ErrorName returns error name.
func (DnsCacheCircuitBreakersValidationError) Field ¶ added in v0.9.6
func (e DnsCacheCircuitBreakersValidationError) Field() string
Field function returns field value.
func (DnsCacheCircuitBreakersValidationError) Key ¶ added in v0.9.6
func (e DnsCacheCircuitBreakersValidationError) Key() bool
Key function returns key value.
func (DnsCacheCircuitBreakersValidationError) Reason ¶ added in v0.9.6
func (e DnsCacheCircuitBreakersValidationError) Reason() string
Reason function returns reason value.
type DnsCacheConfig ¶
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 `` /* 162-byte string literal not displayed */
// 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 `` /* 128-byte string literal not displayed */
// The config of circuit breakers for resolver. It provides a configurable threshold.
// If `envoy.reloadable_features.enable_dns_cache_circuit_breakers` is enabled,
// envoy will use dns cache circuit breakers with default settings even if this value is not set.
DnsCacheCircuitBreaker *DnsCacheCircuitBreakers `` /* 131-byte string literal not displayed */
// [#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
deprecated
func (*DnsCacheConfig) Descriptor() ([]byte, []int)
Deprecated: Use DnsCacheConfig.ProtoReflect.Descriptor instead.
func (*DnsCacheConfig) GetDnsCacheCircuitBreaker ¶ added in v0.9.6
func (x *DnsCacheConfig) GetDnsCacheCircuitBreaker() *DnsCacheCircuitBreakers
func (*DnsCacheConfig) GetDnsFailureRefreshRate ¶ added in v0.9.5
func (x *DnsCacheConfig) GetDnsFailureRefreshRate() *v3.Cluster_RefreshRate
func (*DnsCacheConfig) GetDnsLookupFamily ¶
func (x *DnsCacheConfig) GetDnsLookupFamily() v3.Cluster_DnsLookupFamily
func (*DnsCacheConfig) GetDnsRefreshRate ¶
func (x *DnsCacheConfig) GetDnsRefreshRate() *duration.Duration
func (*DnsCacheConfig) GetHostTtl ¶
func (x *DnsCacheConfig) GetHostTtl() *duration.Duration
func (*DnsCacheConfig) GetMaxHosts ¶
func (x *DnsCacheConfig) GetMaxHosts() *wrappers.UInt32Value
func (*DnsCacheConfig) GetName ¶
func (x *DnsCacheConfig) GetName() string
func (*DnsCacheConfig) GetUseTcpForDnsLookups ¶ added in v0.9.7
func (x *DnsCacheConfig) GetUseTcpForDnsLookups() bool
func (*DnsCacheConfig) ProtoMessage ¶
func (*DnsCacheConfig) ProtoMessage()
func (*DnsCacheConfig) ProtoReflect ¶ added in v0.9.6
func (x *DnsCacheConfig) ProtoReflect() protoreflect.Message
func (*DnsCacheConfig) Reset ¶
func (x *DnsCacheConfig) Reset()
func (*DnsCacheConfig) String ¶
func (x *DnsCacheConfig) String() string
func (*DnsCacheConfig) Validate ¶
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 ¶
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 (DnsCacheConfigValidationError) Cause ¶
func (e DnsCacheConfigValidationError) Cause() error
Cause function returns cause value.
func (DnsCacheConfigValidationError) Error ¶
func (e DnsCacheConfigValidationError) Error() string
Error satisfies the builtin error interface
func (DnsCacheConfigValidationError) ErrorName ¶
func (e DnsCacheConfigValidationError) ErrorName() string
ErrorName returns error name.
func (DnsCacheConfigValidationError) Field ¶
func (e DnsCacheConfigValidationError) Field() string
Field function returns field value.
func (DnsCacheConfigValidationError) Key ¶
func (e DnsCacheConfigValidationError) Key() bool
Key function returns key value.
func (DnsCacheConfigValidationError) Reason ¶
func (e DnsCacheConfigValidationError) Reason() string
Reason function returns reason value.