envoy_config_bootstrap_v3

package
v0.0.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 1, 2023 License: Apache-2.0 Imports: 31 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	Watchdog_WatchdogAction_WatchdogEvent_name = map[int32]string{
		0: "UNKNOWN",
		1: "KILL",
		2: "MULTIKILL",
		3: "MEGAMISS",
		4: "MISS",
	}
	Watchdog_WatchdogAction_WatchdogEvent_value = map[string]int32{
		"UNKNOWN":   0,
		"KILL":      1,
		"MULTIKILL": 2,
		"MEGAMISS":  3,
		"MISS":      4,
	}
)

Enum value maps for Watchdog_WatchdogAction_WatchdogEvent.

View Source
var (
	CustomInlineHeader_InlineHeaderType_name = map[int32]string{
		0: "REQUEST_HEADER",
		1: "REQUEST_TRAILER",
		2: "RESPONSE_HEADER",
		3: "RESPONSE_TRAILER",
	}
	CustomInlineHeader_InlineHeaderType_value = map[string]int32{
		"REQUEST_HEADER":   0,
		"REQUEST_TRAILER":  1,
		"RESPONSE_HEADER":  2,
		"RESPONSE_TRAILER": 3,
	}
)

Enum value maps for CustomInlineHeader_InlineHeaderType.

View Source
var File_envoy_config_bootstrap_v3_bootstrap_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type Admin

type Admin struct {

	// Configuration for :ref:`access logs <arch_overview_access_logs>`
	// emitted by the administration server.
	AccessLog []*v34.AccessLog `protobuf:"bytes,5,rep,name=access_log,json=accessLog,proto3" json:"access_log,omitempty"`
	// The path to write the access log for the administration server. If no
	// access log is desired specify ‘/dev/null’. This is only required if
	// :ref:`address <envoy_v3_api_field_config.bootstrap.v3.Admin.address>` is set.
	// Deprecated in favor of *access_log* which offers more options.
	//
	// Deprecated: Do not use.
	AccessLogPath string `protobuf:"bytes,1,opt,name=access_log_path,json=accessLogPath,proto3" json:"access_log_path,omitempty"`
	// The cpu profiler output path for the administration server. If no profile
	// path is specified, the default is ‘/var/log/envoy/envoy.prof’.
	ProfilePath string `protobuf:"bytes,2,opt,name=profile_path,json=profilePath,proto3" json:"profile_path,omitempty"`
	// The TCP address that the administration server will listen on.
	// If not specified, Envoy will not start an administration server.
	Address *v3.Address `protobuf:"bytes,3,opt,name=address,proto3" json:"address,omitempty"`
	// Additional socket options that may not be present in Envoy source code or
	// precompiled binaries.
	SocketOptions []*v3.SocketOption `protobuf:"bytes,4,rep,name=socket_options,json=socketOptions,proto3" json:"socket_options,omitempty"`
	// contains filtered or unexported fields
}

Administration interface :ref:`operations documentation <operations_admin_interface>`. [#next-free-field: 6]

func (*Admin) Descriptor deprecated

func (*Admin) Descriptor() ([]byte, []int)

Deprecated: Use Admin.ProtoReflect.Descriptor instead.

func (*Admin) GetAccessLog

func (x *Admin) GetAccessLog() []*v34.AccessLog

func (*Admin) GetAccessLogPath deprecated

func (x *Admin) GetAccessLogPath() string

Deprecated: Do not use.

func (*Admin) GetAddress

func (x *Admin) GetAddress() *v3.Address

func (*Admin) GetProfilePath

func (x *Admin) GetProfilePath() string

func (*Admin) GetSocketOptions

func (x *Admin) GetSocketOptions() []*v3.SocketOption

func (*Admin) ProtoMessage

func (*Admin) ProtoMessage()

func (*Admin) ProtoReflect

func (x *Admin) ProtoReflect() protoreflect.Message

func (*Admin) Reset

func (x *Admin) Reset()

func (*Admin) String

func (x *Admin) String() string

func (*Admin) Validate

func (m *Admin) Validate() error

Validate checks the field values on Admin with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type AdminValidationError

type AdminValidationError struct {
	// contains filtered or unexported fields
}

AdminValidationError is the validation error returned by Admin.Validate if the designated constraints aren't met.

func (AdminValidationError) Cause

func (e AdminValidationError) Cause() error

Cause function returns cause value.

func (AdminValidationError) Error

func (e AdminValidationError) Error() string

Error satisfies the builtin error interface

func (AdminValidationError) ErrorName

func (e AdminValidationError) ErrorName() string

ErrorName returns error name.

func (AdminValidationError) Field

func (e AdminValidationError) Field() string

Field function returns field value.

func (AdminValidationError) Key

func (e AdminValidationError) Key() bool

Key function returns key value.

func (AdminValidationError) Reason

func (e AdminValidationError) Reason() string

Reason function returns reason value.

type Bootstrap

type Bootstrap struct {

	// Node identity to present to the management server and for instance
	// identification purposes (e.g. in generated headers).
	Node *v3.Node `protobuf:"bytes,1,opt,name=node,proto3" json:"node,omitempty"`
	// A list of :ref:`Node <envoy_v3_api_msg_config.core.v3.Node>` field names
	// that will be included in the context parameters of the effective
	// xdstp:// URL that is sent in a discovery request when resource
	// locators are used for LDS/CDS. Any non-string field will have its JSON
	// encoding set as the context parameter value, with the exception of
	// metadata, which will be flattened (see example below). The supported field
	// names are:
	// - "cluster"
	// - "id"
	// - "locality.region"
	// - "locality.sub_zone"
	// - "locality.zone"
	// - "metadata"
	// - "user_agent_build_version.metadata"
	// - "user_agent_build_version.version"
	// - "user_agent_name"
	// - "user_agent_version"
	//
	// The node context parameters act as a base layer dictionary for the context
	// parameters (i.e. more specific resource specific context parameters will
	// override). Field names will be prefixed with “udpa.node.” when included in
	// context parameters.
	//
	// For example, if node_context_params is “["user_agent_name", "metadata"]“,
	// the implied context parameters might be::
	//
	//   node.user_agent_name: "envoy"
	//   node.metadata.foo: "{\"bar\": \"baz\"}"
	//   node.metadata.some: "42"
	//   node.metadata.thing: "\"thing\""
	//
	// [#not-implemented-hide:]
	NodeContextParams []string `protobuf:"bytes,26,rep,name=node_context_params,json=nodeContextParams,proto3" json:"node_context_params,omitempty"`
	// Statically specified resources.
	StaticResources *Bootstrap_StaticResources `protobuf:"bytes,2,opt,name=static_resources,json=staticResources,proto3" json:"static_resources,omitempty"`
	// xDS configuration sources.
	DynamicResources *Bootstrap_DynamicResources `protobuf:"bytes,3,opt,name=dynamic_resources,json=dynamicResources,proto3" json:"dynamic_resources,omitempty"`
	// Configuration for the cluster manager which owns all upstream clusters
	// within the server.
	ClusterManager *ClusterManager `protobuf:"bytes,4,opt,name=cluster_manager,json=clusterManager,proto3" json:"cluster_manager,omitempty"`
	// Health discovery service config option.
	// (:ref:`core.ApiConfigSource <envoy_v3_api_msg_config.core.v3.ApiConfigSource>`)
	HdsConfig *v3.ApiConfigSource `protobuf:"bytes,14,opt,name=hds_config,json=hdsConfig,proto3" json:"hds_config,omitempty"`
	// Optional file system path to search for startup flag files.
	FlagsPath string `protobuf:"bytes,5,opt,name=flags_path,json=flagsPath,proto3" json:"flags_path,omitempty"`
	// Optional set of stats sinks.
	StatsSinks []*v31.StatsSink `protobuf:"bytes,6,rep,name=stats_sinks,json=statsSinks,proto3" json:"stats_sinks,omitempty"`
	// Configuration for internal processing of stats.
	StatsConfig *v31.StatsConfig `protobuf:"bytes,13,opt,name=stats_config,json=statsConfig,proto3" json:"stats_config,omitempty"`
	// Optional duration between flushes to configured stats sinks. For
	// performance reasons Envoy latches counters and only flushes counters and
	// gauges at a periodic interval. If not specified the default is 5000ms (5
	// seconds). Only one of `stats_flush_interval` or `stats_flush_on_admin`
	// can be set.
	// Duration must be at least 1ms and at most 5 min.
	StatsFlushInterval *duration.Duration `protobuf:"bytes,7,opt,name=stats_flush_interval,json=statsFlushInterval,proto3" json:"stats_flush_interval,omitempty"`
	// Types that are assignable to StatsFlush:
	//	*Bootstrap_StatsFlushOnAdmin
	StatsFlush isBootstrap_StatsFlush `protobuf_oneof:"stats_flush"`
	// Optional watchdog configuration.
	// This is for a single watchdog configuration for the entire system.
	// Deprecated in favor of *watchdogs* which has finer granularity.
	//
	// Deprecated: Do not use.
	Watchdog *Watchdog `protobuf:"bytes,8,opt,name=watchdog,proto3" json:"watchdog,omitempty"`
	// Optional watchdogs configuration.
	// This is used for specifying different watchdogs for the different subsystems.
	// [#extension-category: envoy.guarddog_actions]
	Watchdogs *Watchdogs `protobuf:"bytes,27,opt,name=watchdogs,proto3" json:"watchdogs,omitempty"`
	// Configuration for an external tracing provider.
	//
	// .. attention::
	//  This field has been deprecated in favor of :ref:`HttpConnectionManager.Tracing.provider
	//  <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.Tracing.provider>`.
	//
	// Deprecated: Do not use.
	Tracing *v32.Tracing `protobuf:"bytes,9,opt,name=tracing,proto3" json:"tracing,omitempty"`
	// Configuration for the runtime configuration provider. If not
	// specified, a “null” provider will be used which will result in all defaults
	// being used.
	LayeredRuntime *LayeredRuntime `protobuf:"bytes,17,opt,name=layered_runtime,json=layeredRuntime,proto3" json:"layered_runtime,omitempty"`
	// Configuration for the local administration HTTP server.
	Admin *Admin `protobuf:"bytes,12,opt,name=admin,proto3" json:"admin,omitempty"`
	// Optional overload manager configuration.
	OverloadManager *v33.OverloadManager `protobuf:"bytes,15,opt,name=overload_manager,json=overloadManager,proto3" json:"overload_manager,omitempty"`
	// Enable :ref:`stats for event dispatcher <operations_performance>`, defaults to false.
	// Note that this records a value for each iteration of the event loop on every thread. This
	// should normally be minimal overhead, but when using
	// :ref:`statsd <envoy_v3_api_msg_config.metrics.v3.StatsdSink>`, it will send each observed value
	// over the wire individually because the statsd protocol doesn't have any way to represent a
	// histogram summary. Be aware that this can be a very large volume of data.
	EnableDispatcherStats bool `` /* 128-byte string literal not displayed */
	// Optional string which will be used in lieu of x-envoy in prefixing headers.
	//
	// For example, if this string is present and set to X-Foo, then x-envoy-retry-on will be
	// transformed into x-foo-retry-on etc.
	//
	// Note this applies to the headers Envoy will generate, the headers Envoy will sanitize, and the
	// headers Envoy will trust for core code and core extensions only. Be VERY careful making
	// changes to this string, especially in multi-layer Envoy deployments or deployments using
	// extensions which are not upstream.
	HeaderPrefix string `protobuf:"bytes,18,opt,name=header_prefix,json=headerPrefix,proto3" json:"header_prefix,omitempty"`
	// Optional proxy version which will be used to set the value of :ref:`server.version statistic
	// <server_statistics>` if specified. Envoy will not process this value, it will be sent as is to
	// :ref:`stats sinks <envoy_v3_api_msg_config.metrics.v3.StatsSink>`.
	StatsServerVersionOverride *wrappers.UInt64Value `` /* 144-byte string literal not displayed */
	// Always use TCP queries instead of UDP queries for DNS lookups.
	// This may be overridden on a per-cluster basis in cds_config,
	// when :ref:`dns_resolvers <envoy_v3_api_field_config.cluster.v3.Cluster.dns_resolvers>` and
	// :ref:`use_tcp_for_dns_lookups <envoy_v3_api_field_config.cluster.v3.Cluster.use_tcp_for_dns_lookups>` are
	// specified.
	// 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.
	// This field is deprecated in favor of *dns_resolution_config*
	// which aggregates all of the DNS resolver configuration in a single message.
	//
	// Deprecated: Do not use.
	UseTcpForDnsLookups bool `` /* 126-byte string literal not displayed */
	// DNS resolution configuration which includes the underlying dns resolver addresses and options.
	// This may be overridden on a per-cluster basis in cds_config, when
	// :ref:`dns_resolution_config <envoy_v3_api_field_config.cluster.v3.Cluster.dns_resolution_config>`
	// is specified.
	// *dns_resolution_config* will be deprecated once
	// :ref:'typed_dns_resolver_config <envoy_v3_api_field_config.bootstrap.v3.Bootstrap.typed_dns_resolver_config>'
	// is fully supported.
	DnsResolutionConfig *v3.DnsResolutionConfig `protobuf:"bytes,30,opt,name=dns_resolution_config,json=dnsResolutionConfig,proto3" json:"dns_resolution_config,omitempty"`
	// DNS resolver type configuration extension. This extension can be used to configure c-ares, apple,
	// or any other DNS resolver types and the related parameters.
	// For example, an object of :ref:`DnsResolutionConfig <envoy_v3_api_msg_config.core.v3.DnsResolutionConfig>`
	// can be packed into this *typed_dns_resolver_config*. This configuration will replace the
	// :ref:'dns_resolution_config <envoy_v3_api_field_config.bootstrap.v3.Bootstrap.dns_resolution_config>'
	// configuration eventually.
	// TODO(yanjunxiang): Investigate the deprecation plan for *dns_resolution_config*.
	// During the transition period when both *dns_resolution_config* and *typed_dns_resolver_config* exists,
	// this configuration is optional.
	// When *typed_dns_resolver_config* is in place, Envoy will use it and ignore *dns_resolution_config*.
	// When *typed_dns_resolver_config* is missing, the default behavior is in place.
	// [#not-implemented-hide:]
	TypedDnsResolverConfig *v3.TypedExtensionConfig `` /* 132-byte string literal not displayed */
	// Specifies optional bootstrap extensions to be instantiated at startup time.
	// Each item contains extension specific configuration.
	// [#extension-category: envoy.bootstrap]
	BootstrapExtensions []*v3.TypedExtensionConfig `protobuf:"bytes,21,rep,name=bootstrap_extensions,json=bootstrapExtensions,proto3" json:"bootstrap_extensions,omitempty"`
	// Specifies optional extensions instantiated at startup time and
	// invoked during crash time on the request that caused the crash.
	FatalActions []*FatalAction `protobuf:"bytes,28,rep,name=fatal_actions,json=fatalActions,proto3" json:"fatal_actions,omitempty"`
	// Configuration sources that will participate in
	// xdstp:// URL authority resolution. The algorithm is as
	// follows:
	// 1. The authority field is taken from the xdstp:// URL, call
	//    this *resource_authority*.
	// 2. *resource_authority* is compared against the authorities in any peer
	//    *ConfigSource*. The peer *ConfigSource* is the configuration source
	//    message which would have been used unconditionally for resolution
	//    with opaque resource names. If there is a match with an authority, the
	//    peer *ConfigSource* message is used.
	// 3. *resource_authority* is compared sequentially with the authorities in
	//    each configuration source in *config_sources*. The first *ConfigSource*
	//    to match wins.
	// 4. As a fallback, if no configuration source matches, then
	//    *default_config_source* is used.
	// 5. If *default_config_source* is not specified, resolution fails.
	// [#not-implemented-hide:]
	ConfigSources []*v3.ConfigSource `protobuf:"bytes,22,rep,name=config_sources,json=configSources,proto3" json:"config_sources,omitempty"`
	// Default configuration source for xdstp:// URLs if all
	// other resolution fails.
	// [#not-implemented-hide:]
	DefaultConfigSource *v3.ConfigSource `protobuf:"bytes,23,opt,name=default_config_source,json=defaultConfigSource,proto3" json:"default_config_source,omitempty"`
	// Optional overriding of default socket interface. The value must be the name of one of the
	// socket interface factories initialized through a bootstrap extension
	DefaultSocketInterface string `` /* 130-byte string literal not displayed */
	// Global map of CertificateProvider instances. These instances are referred to by name in the
	// :ref:`CommonTlsContext.CertificateProviderInstance.instance_name
	// <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CommonTlsContext.CertificateProviderInstance.instance_name>`
	// field.
	// [#not-implemented-hide:]
	CertificateProviderInstances map[string]*v3.TypedExtensionConfig `` /* 236-byte string literal not displayed */
	// Specifies a set of headers that need to be registered as inline header. This configuration
	// allows users to customize the inline headers on-demand at Envoy startup without modifying
	// Envoy's source code.
	//
	// Note that the 'set-cookie' header cannot be registered as inline header.
	InlineHeaders []*CustomInlineHeader `protobuf:"bytes,32,rep,name=inline_headers,json=inlineHeaders,proto3" json:"inline_headers,omitempty"`
	// Deprecated: Do not use.
	HiddenEnvoyDeprecatedRuntime *Runtime `` /* 150-byte string literal not displayed */
	// contains filtered or unexported fields
}

Bootstrap :ref:`configuration overview <config_overview_bootstrap>`. [#next-free-field: 33]

func (*Bootstrap) Descriptor deprecated

func (*Bootstrap) Descriptor() ([]byte, []int)

Deprecated: Use Bootstrap.ProtoReflect.Descriptor instead.

func (*Bootstrap) GetAdmin

func (x *Bootstrap) GetAdmin() *Admin

func (*Bootstrap) GetBootstrapExtensions

func (x *Bootstrap) GetBootstrapExtensions() []*v3.TypedExtensionConfig

func (*Bootstrap) GetCertificateProviderInstances

func (x *Bootstrap) GetCertificateProviderInstances() map[string]*v3.TypedExtensionConfig

func (*Bootstrap) GetClusterManager

func (x *Bootstrap) GetClusterManager() *ClusterManager

func (*Bootstrap) GetConfigSources

func (x *Bootstrap) GetConfigSources() []*v3.ConfigSource

func (*Bootstrap) GetDefaultConfigSource

func (x *Bootstrap) GetDefaultConfigSource() *v3.ConfigSource

func (*Bootstrap) GetDefaultSocketInterface

func (x *Bootstrap) GetDefaultSocketInterface() string

func (*Bootstrap) GetDnsResolutionConfig

func (x *Bootstrap) GetDnsResolutionConfig() *v3.DnsResolutionConfig

func (*Bootstrap) GetDynamicResources

func (x *Bootstrap) GetDynamicResources() *Bootstrap_DynamicResources

func (*Bootstrap) GetEnableDispatcherStats

func (x *Bootstrap) GetEnableDispatcherStats() bool

func (*Bootstrap) GetFatalActions

func (x *Bootstrap) GetFatalActions() []*FatalAction

func (*Bootstrap) GetFlagsPath

func (x *Bootstrap) GetFlagsPath() string

func (*Bootstrap) GetHdsConfig

func (x *Bootstrap) GetHdsConfig() *v3.ApiConfigSource

func (*Bootstrap) GetHeaderPrefix

func (x *Bootstrap) GetHeaderPrefix() string

func (*Bootstrap) GetHiddenEnvoyDeprecatedRuntime deprecated

func (x *Bootstrap) GetHiddenEnvoyDeprecatedRuntime() *Runtime

Deprecated: Do not use.

func (*Bootstrap) GetInlineHeaders

func (x *Bootstrap) GetInlineHeaders() []*CustomInlineHeader

func (*Bootstrap) GetLayeredRuntime

func (x *Bootstrap) GetLayeredRuntime() *LayeredRuntime

func (*Bootstrap) GetNode

func (x *Bootstrap) GetNode() *v3.Node

func (*Bootstrap) GetNodeContextParams

func (x *Bootstrap) GetNodeContextParams() []string

func (*Bootstrap) GetOverloadManager

func (x *Bootstrap) GetOverloadManager() *v33.OverloadManager

func (*Bootstrap) GetStaticResources

func (x *Bootstrap) GetStaticResources() *Bootstrap_StaticResources

func (*Bootstrap) GetStatsConfig

func (x *Bootstrap) GetStatsConfig() *v31.StatsConfig

func (*Bootstrap) GetStatsFlush

func (m *Bootstrap) GetStatsFlush() isBootstrap_StatsFlush

func (*Bootstrap) GetStatsFlushInterval

func (x *Bootstrap) GetStatsFlushInterval() *duration.Duration

func (*Bootstrap) GetStatsFlushOnAdmin

func (x *Bootstrap) GetStatsFlushOnAdmin() bool

func (*Bootstrap) GetStatsServerVersionOverride

func (x *Bootstrap) GetStatsServerVersionOverride() *wrappers.UInt64Value

func (*Bootstrap) GetStatsSinks

func (x *Bootstrap) GetStatsSinks() []*v31.StatsSink

func (*Bootstrap) GetTracing deprecated

func (x *Bootstrap) GetTracing() *v32.Tracing

Deprecated: Do not use.

func (*Bootstrap) GetTypedDnsResolverConfig

func (x *Bootstrap) GetTypedDnsResolverConfig() *v3.TypedExtensionConfig

func (*Bootstrap) GetUseTcpForDnsLookups deprecated

func (x *Bootstrap) GetUseTcpForDnsLookups() bool

Deprecated: Do not use.

func (*Bootstrap) GetWatchdog deprecated

func (x *Bootstrap) GetWatchdog() *Watchdog

Deprecated: Do not use.

func (*Bootstrap) GetWatchdogs

func (x *Bootstrap) GetWatchdogs() *Watchdogs

func (*Bootstrap) ProtoMessage

func (*Bootstrap) ProtoMessage()

func (*Bootstrap) ProtoReflect

func (x *Bootstrap) ProtoReflect() protoreflect.Message

func (*Bootstrap) Reset

func (x *Bootstrap) Reset()

func (*Bootstrap) String

func (x *Bootstrap) String() string

func (*Bootstrap) Validate

func (m *Bootstrap) Validate() error

Validate checks the field values on Bootstrap with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type BootstrapValidationError

type BootstrapValidationError struct {
	// contains filtered or unexported fields
}

BootstrapValidationError is the validation error returned by Bootstrap.Validate if the designated constraints aren't met.

func (BootstrapValidationError) Cause

func (e BootstrapValidationError) Cause() error

Cause function returns cause value.

func (BootstrapValidationError) Error

func (e BootstrapValidationError) Error() string

Error satisfies the builtin error interface

func (BootstrapValidationError) ErrorName

func (e BootstrapValidationError) ErrorName() string

ErrorName returns error name.

func (BootstrapValidationError) Field

func (e BootstrapValidationError) Field() string

Field function returns field value.

func (BootstrapValidationError) Key

Key function returns key value.

func (BootstrapValidationError) Reason

func (e BootstrapValidationError) Reason() string

Reason function returns reason value.

type Bootstrap_DynamicResources

type Bootstrap_DynamicResources struct {

	// All :ref:`Listeners <envoy_v3_api_msg_config.listener.v3.Listener>` are provided by a single
	// :ref:`LDS <arch_overview_dynamic_config_lds>` configuration source.
	LdsConfig *v3.ConfigSource `protobuf:"bytes,1,opt,name=lds_config,json=ldsConfig,proto3" json:"lds_config,omitempty"`
	// xdstp:// resource locator for listener collection.
	// [#not-implemented-hide:]
	LdsResourcesLocator string `protobuf:"bytes,5,opt,name=lds_resources_locator,json=ldsResourcesLocator,proto3" json:"lds_resources_locator,omitempty"`
	// All post-bootstrap :ref:`Cluster <envoy_v3_api_msg_config.cluster.v3.Cluster>` definitions are
	// provided by a single :ref:`CDS <arch_overview_dynamic_config_cds>`
	// configuration source.
	CdsConfig *v3.ConfigSource `protobuf:"bytes,2,opt,name=cds_config,json=cdsConfig,proto3" json:"cds_config,omitempty"`
	// xdstp:// resource locator for cluster collection.
	// [#not-implemented-hide:]
	CdsResourcesLocator string `protobuf:"bytes,6,opt,name=cds_resources_locator,json=cdsResourcesLocator,proto3" json:"cds_resources_locator,omitempty"`
	// A single :ref:`ADS <config_overview_ads>` source may be optionally
	// specified. This must have :ref:`api_type
	// <envoy_v3_api_field_config.core.v3.ApiConfigSource.api_type>` :ref:`GRPC
	// <envoy_v3_api_enum_value_config.core.v3.ApiConfigSource.ApiType.GRPC>`. Only
	// :ref:`ConfigSources <envoy_v3_api_msg_config.core.v3.ConfigSource>` that have
	// the :ref:`ads <envoy_v3_api_field_config.core.v3.ConfigSource.ads>` field set will be
	// streamed on the ADS channel.
	AdsConfig *v3.ApiConfigSource `protobuf:"bytes,3,opt,name=ads_config,json=adsConfig,proto3" json:"ads_config,omitempty"`
	// contains filtered or unexported fields
}

[#next-free-field: 7]

func (*Bootstrap_DynamicResources) Descriptor deprecated

func (*Bootstrap_DynamicResources) Descriptor() ([]byte, []int)

Deprecated: Use Bootstrap_DynamicResources.ProtoReflect.Descriptor instead.

func (*Bootstrap_DynamicResources) GetAdsConfig

func (x *Bootstrap_DynamicResources) GetAdsConfig() *v3.ApiConfigSource

func (*Bootstrap_DynamicResources) GetCdsConfig

func (x *Bootstrap_DynamicResources) GetCdsConfig() *v3.ConfigSource

func (*Bootstrap_DynamicResources) GetCdsResourcesLocator

func (x *Bootstrap_DynamicResources) GetCdsResourcesLocator() string

func (*Bootstrap_DynamicResources) GetLdsConfig

func (x *Bootstrap_DynamicResources) GetLdsConfig() *v3.ConfigSource

func (*Bootstrap_DynamicResources) GetLdsResourcesLocator

func (x *Bootstrap_DynamicResources) GetLdsResourcesLocator() string

func (*Bootstrap_DynamicResources) ProtoMessage

func (*Bootstrap_DynamicResources) ProtoMessage()

func (*Bootstrap_DynamicResources) ProtoReflect

func (*Bootstrap_DynamicResources) Reset

func (x *Bootstrap_DynamicResources) Reset()

func (*Bootstrap_DynamicResources) String

func (x *Bootstrap_DynamicResources) String() string

func (*Bootstrap_DynamicResources) Validate

func (m *Bootstrap_DynamicResources) Validate() error

Validate checks the field values on Bootstrap_DynamicResources with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type Bootstrap_DynamicResourcesValidationError

type Bootstrap_DynamicResourcesValidationError struct {
	// contains filtered or unexported fields
}

Bootstrap_DynamicResourcesValidationError is the validation error returned by Bootstrap_DynamicResources.Validate if the designated constraints aren't met.

func (Bootstrap_DynamicResourcesValidationError) Cause

Cause function returns cause value.

func (Bootstrap_DynamicResourcesValidationError) Error

Error satisfies the builtin error interface

func (Bootstrap_DynamicResourcesValidationError) ErrorName

ErrorName returns error name.

func (Bootstrap_DynamicResourcesValidationError) Field

Field function returns field value.

func (Bootstrap_DynamicResourcesValidationError) Key

Key function returns key value.

func (Bootstrap_DynamicResourcesValidationError) Reason

Reason function returns reason value.

type Bootstrap_StaticResources

type Bootstrap_StaticResources struct {

	// Static :ref:`Listeners <envoy_v3_api_msg_config.listener.v3.Listener>`. These listeners are
	// available regardless of LDS configuration.
	Listeners []*v36.Listener `protobuf:"bytes,1,rep,name=listeners,proto3" json:"listeners,omitempty"`
	// If a network based configuration source is specified for :ref:`cds_config
	// <envoy_v3_api_field_config.bootstrap.v3.Bootstrap.DynamicResources.cds_config>`, it's necessary
	// to have some initial cluster definitions available to allow Envoy to know
	// how to speak to the management server. These cluster definitions may not
	// use :ref:`EDS <arch_overview_dynamic_config_eds>` (i.e. they should be static
	// IP or DNS-based).
	Clusters []*v37.Cluster `protobuf:"bytes,2,rep,name=clusters,proto3" json:"clusters,omitempty"`
	// These static secrets can be used by :ref:`SdsSecretConfig
	// <envoy_v3_api_msg_extensions.transport_sockets.tls.v3.SdsSecretConfig>`
	Secrets []*v38.Secret `protobuf:"bytes,3,rep,name=secrets,proto3" json:"secrets,omitempty"`
	// contains filtered or unexported fields
}

func (*Bootstrap_StaticResources) Descriptor deprecated

func (*Bootstrap_StaticResources) Descriptor() ([]byte, []int)

Deprecated: Use Bootstrap_StaticResources.ProtoReflect.Descriptor instead.

func (*Bootstrap_StaticResources) GetClusters

func (x *Bootstrap_StaticResources) GetClusters() []*v37.Cluster

func (*Bootstrap_StaticResources) GetListeners

func (x *Bootstrap_StaticResources) GetListeners() []*v36.Listener

func (*Bootstrap_StaticResources) GetSecrets

func (x *Bootstrap_StaticResources) GetSecrets() []*v38.Secret

func (*Bootstrap_StaticResources) ProtoMessage

func (*Bootstrap_StaticResources) ProtoMessage()

func (*Bootstrap_StaticResources) ProtoReflect

func (*Bootstrap_StaticResources) Reset

func (x *Bootstrap_StaticResources) Reset()

func (*Bootstrap_StaticResources) String

func (x *Bootstrap_StaticResources) String() string

func (*Bootstrap_StaticResources) Validate

func (m *Bootstrap_StaticResources) Validate() error

Validate checks the field values on Bootstrap_StaticResources with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type Bootstrap_StaticResourcesValidationError

type Bootstrap_StaticResourcesValidationError struct {
	// contains filtered or unexported fields
}

Bootstrap_StaticResourcesValidationError is the validation error returned by Bootstrap_StaticResources.Validate if the designated constraints aren't met.

func (Bootstrap_StaticResourcesValidationError) Cause

Cause function returns cause value.

func (Bootstrap_StaticResourcesValidationError) Error

Error satisfies the builtin error interface

func (Bootstrap_StaticResourcesValidationError) ErrorName

ErrorName returns error name.

func (Bootstrap_StaticResourcesValidationError) Field

Field function returns field value.

func (Bootstrap_StaticResourcesValidationError) Key

Key function returns key value.

func (Bootstrap_StaticResourcesValidationError) Reason

Reason function returns reason value.

type Bootstrap_StatsFlushOnAdmin

type Bootstrap_StatsFlushOnAdmin struct {
	// Flush stats to sinks only when queried for on the admin interface. If set,
	// a flush timer is not created. Only one of `stats_flush_on_admin` or
	// `stats_flush_interval` can be set.
	StatsFlushOnAdmin bool `protobuf:"varint,29,opt,name=stats_flush_on_admin,json=statsFlushOnAdmin,proto3,oneof"`
}

type ClusterManager

type ClusterManager struct {

	// Name of the local cluster (i.e., the cluster that owns the Envoy running
	// this configuration). In order to enable :ref:`zone aware routing
	// <arch_overview_load_balancing_zone_aware_routing>` this option must be set.
	// If *local_cluster_name* is defined then :ref:`clusters
	// <envoy_v3_api_msg_config.cluster.v3.Cluster>` must be defined in the :ref:`Bootstrap
	// static cluster resources
	// <envoy_v3_api_field_config.bootstrap.v3.Bootstrap.StaticResources.clusters>`. This is unrelated to
	// the :option:`--service-cluster` option which does not `affect zone aware
	// routing <https://github.com/envoyproxy/envoy/issues/774>`_.
	LocalClusterName string `protobuf:"bytes,1,opt,name=local_cluster_name,json=localClusterName,proto3" json:"local_cluster_name,omitempty"`
	// Optional global configuration for outlier detection.
	OutlierDetection *ClusterManager_OutlierDetection `protobuf:"bytes,2,opt,name=outlier_detection,json=outlierDetection,proto3" json:"outlier_detection,omitempty"`
	// Optional configuration used to bind newly established upstream connections.
	// This may be overridden on a per-cluster basis by upstream_bind_config in the cds_config.
	UpstreamBindConfig *v3.BindConfig `protobuf:"bytes,3,opt,name=upstream_bind_config,json=upstreamBindConfig,proto3" json:"upstream_bind_config,omitempty"`
	// A management server endpoint to stream load stats to via
	// *StreamLoadStats*. This must have :ref:`api_type
	// <envoy_v3_api_field_config.core.v3.ApiConfigSource.api_type>` :ref:`GRPC
	// <envoy_v3_api_enum_value_config.core.v3.ApiConfigSource.ApiType.GRPC>`.
	LoadStatsConfig *v3.ApiConfigSource `protobuf:"bytes,4,opt,name=load_stats_config,json=loadStatsConfig,proto3" json:"load_stats_config,omitempty"`
	// contains filtered or unexported fields
}

Cluster manager :ref:`architecture overview <arch_overview_cluster_manager>`.

func (*ClusterManager) Descriptor deprecated

func (*ClusterManager) Descriptor() ([]byte, []int)

Deprecated: Use ClusterManager.ProtoReflect.Descriptor instead.

func (*ClusterManager) GetLoadStatsConfig

func (x *ClusterManager) GetLoadStatsConfig() *v3.ApiConfigSource

func (*ClusterManager) GetLocalClusterName

func (x *ClusterManager) GetLocalClusterName() string

func (*ClusterManager) GetOutlierDetection

func (x *ClusterManager) GetOutlierDetection() *ClusterManager_OutlierDetection

func (*ClusterManager) GetUpstreamBindConfig

func (x *ClusterManager) GetUpstreamBindConfig() *v3.BindConfig

func (*ClusterManager) ProtoMessage

func (*ClusterManager) ProtoMessage()

func (*ClusterManager) ProtoReflect

func (x *ClusterManager) ProtoReflect() protoreflect.Message

func (*ClusterManager) Reset

func (x *ClusterManager) Reset()

func (*ClusterManager) String

func (x *ClusterManager) String() string

func (*ClusterManager) Validate

func (m *ClusterManager) Validate() error

Validate checks the field values on ClusterManager with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type ClusterManagerValidationError

type ClusterManagerValidationError struct {
	// contains filtered or unexported fields
}

ClusterManagerValidationError is the validation error returned by ClusterManager.Validate if the designated constraints aren't met.

func (ClusterManagerValidationError) Cause

Cause function returns cause value.

func (ClusterManagerValidationError) Error

Error satisfies the builtin error interface

func (ClusterManagerValidationError) ErrorName

func (e ClusterManagerValidationError) ErrorName() string

ErrorName returns error name.

func (ClusterManagerValidationError) Field

Field function returns field value.

func (ClusterManagerValidationError) Key

Key function returns key value.

func (ClusterManagerValidationError) Reason

Reason function returns reason value.

type ClusterManager_OutlierDetection

type ClusterManager_OutlierDetection struct {

	// Specifies the path to the outlier event log.
	EventLogPath string `protobuf:"bytes,1,opt,name=event_log_path,json=eventLogPath,proto3" json:"event_log_path,omitempty"`
	// [#not-implemented-hide:]
	// The gRPC service for the outlier detection event service.
	// If empty, outlier detection events won't be sent to a remote endpoint.
	EventService *v3.EventServiceConfig `protobuf:"bytes,2,opt,name=event_service,json=eventService,proto3" json:"event_service,omitempty"`
	// contains filtered or unexported fields
}

func (*ClusterManager_OutlierDetection) Descriptor deprecated

func (*ClusterManager_OutlierDetection) Descriptor() ([]byte, []int)

Deprecated: Use ClusterManager_OutlierDetection.ProtoReflect.Descriptor instead.

func (*ClusterManager_OutlierDetection) GetEventLogPath

func (x *ClusterManager_OutlierDetection) GetEventLogPath() string

func (*ClusterManager_OutlierDetection) GetEventService

func (*ClusterManager_OutlierDetection) ProtoMessage

func (*ClusterManager_OutlierDetection) ProtoMessage()

func (*ClusterManager_OutlierDetection) ProtoReflect

func (*ClusterManager_OutlierDetection) Reset

func (*ClusterManager_OutlierDetection) String

func (*ClusterManager_OutlierDetection) Validate

func (m *ClusterManager_OutlierDetection) Validate() error

Validate checks the field values on ClusterManager_OutlierDetection with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type ClusterManager_OutlierDetectionValidationError

type ClusterManager_OutlierDetectionValidationError struct {
	// contains filtered or unexported fields
}

ClusterManager_OutlierDetectionValidationError is the validation error returned by ClusterManager_OutlierDetection.Validate if the designated constraints aren't met.

func (ClusterManager_OutlierDetectionValidationError) Cause

Cause function returns cause value.

func (ClusterManager_OutlierDetectionValidationError) Error

Error satisfies the builtin error interface

func (ClusterManager_OutlierDetectionValidationError) ErrorName

ErrorName returns error name.

func (ClusterManager_OutlierDetectionValidationError) Field

Field function returns field value.

func (ClusterManager_OutlierDetectionValidationError) Key

Key function returns key value.

func (ClusterManager_OutlierDetectionValidationError) Reason

Reason function returns reason value.

type CustomInlineHeader

type CustomInlineHeader struct {

	// The name of the header that is expected to be set as the inline header.
	InlineHeaderName string `protobuf:"bytes,1,opt,name=inline_header_name,json=inlineHeaderName,proto3" json:"inline_header_name,omitempty"`
	// The type of the header that is expected to be set as the inline header.
	InlineHeaderType CustomInlineHeader_InlineHeaderType `` /* 179-byte string literal not displayed */
	// contains filtered or unexported fields
}

Used to specify the header that needs to be registered as an inline header.

If request or response contain multiple headers with the same name and the header name is registered as an inline header. Then multiple headers will be folded into one, and multiple header values will be concatenated by a suitable delimiter. The delimiter is generally a comma.

For example, if 'foo' is registered as an inline header, and the headers contains the following two headers:

.. code-block:: text

foo: bar
foo: eep

Then they will eventually be folded into:

.. code-block:: text

foo: bar, eep

Inline headers provide O(1) search performance, but each inline header imposes an additional memory overhead on all instances of the corresponding type of HeaderMap or TrailerMap.

func (*CustomInlineHeader) Descriptor deprecated

func (*CustomInlineHeader) Descriptor() ([]byte, []int)

Deprecated: Use CustomInlineHeader.ProtoReflect.Descriptor instead.

func (*CustomInlineHeader) GetInlineHeaderName

func (x *CustomInlineHeader) GetInlineHeaderName() string

func (*CustomInlineHeader) GetInlineHeaderType

func (*CustomInlineHeader) ProtoMessage

func (*CustomInlineHeader) ProtoMessage()

func (*CustomInlineHeader) ProtoReflect

func (x *CustomInlineHeader) ProtoReflect() protoreflect.Message

func (*CustomInlineHeader) Reset

func (x *CustomInlineHeader) Reset()

func (*CustomInlineHeader) String

func (x *CustomInlineHeader) String() string

func (*CustomInlineHeader) Validate

func (m *CustomInlineHeader) Validate() error

Validate checks the field values on CustomInlineHeader with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type CustomInlineHeaderValidationError

type CustomInlineHeaderValidationError struct {
	// contains filtered or unexported fields
}

CustomInlineHeaderValidationError is the validation error returned by CustomInlineHeader.Validate if the designated constraints aren't met.

func (CustomInlineHeaderValidationError) Cause

Cause function returns cause value.

func (CustomInlineHeaderValidationError) Error

Error satisfies the builtin error interface

func (CustomInlineHeaderValidationError) ErrorName

ErrorName returns error name.

func (CustomInlineHeaderValidationError) Field

Field function returns field value.

func (CustomInlineHeaderValidationError) Key

Key function returns key value.

func (CustomInlineHeaderValidationError) Reason

Reason function returns reason value.

type CustomInlineHeader_InlineHeaderType

type CustomInlineHeader_InlineHeaderType int32
const (
	CustomInlineHeader_REQUEST_HEADER   CustomInlineHeader_InlineHeaderType = 0
	CustomInlineHeader_REQUEST_TRAILER  CustomInlineHeader_InlineHeaderType = 1
	CustomInlineHeader_RESPONSE_HEADER  CustomInlineHeader_InlineHeaderType = 2
	CustomInlineHeader_RESPONSE_TRAILER CustomInlineHeader_InlineHeaderType = 3
)

func (CustomInlineHeader_InlineHeaderType) Descriptor

func (CustomInlineHeader_InlineHeaderType) Enum

func (CustomInlineHeader_InlineHeaderType) EnumDescriptor deprecated

func (CustomInlineHeader_InlineHeaderType) EnumDescriptor() ([]byte, []int)

Deprecated: Use CustomInlineHeader_InlineHeaderType.Descriptor instead.

func (CustomInlineHeader_InlineHeaderType) Number

func (CustomInlineHeader_InlineHeaderType) String

func (CustomInlineHeader_InlineHeaderType) Type

type FatalAction

type FatalAction struct {

	// Extension specific configuration for the action. It's expected to conform
	// to the “Envoy::Server::Configuration::FatalAction“ interface.
	Config *v3.TypedExtensionConfig `protobuf:"bytes,1,opt,name=config,proto3" json:"config,omitempty"`
	// contains filtered or unexported fields
}

Fatal actions to run while crashing. Actions can be safe (meaning they are async-signal safe) or unsafe. We run all safe actions before we run unsafe actions. If using an unsafe action that could get stuck or deadlock, it important to have an out of band system to terminate the process.

The interface for the extension is “Envoy::Server::Configuration::FatalAction“. *FatalAction* extensions live in the “envoy.extensions.fatal_actions“ API namespace.

func (*FatalAction) Descriptor deprecated

func (*FatalAction) Descriptor() ([]byte, []int)

Deprecated: Use FatalAction.ProtoReflect.Descriptor instead.

func (*FatalAction) GetConfig

func (x *FatalAction) GetConfig() *v3.TypedExtensionConfig

func (*FatalAction) ProtoMessage

func (*FatalAction) ProtoMessage()

func (*FatalAction) ProtoReflect

func (x *FatalAction) ProtoReflect() protoreflect.Message

func (*FatalAction) Reset

func (x *FatalAction) Reset()

func (*FatalAction) String

func (x *FatalAction) String() string

func (*FatalAction) Validate

func (m *FatalAction) Validate() error

Validate checks the field values on FatalAction with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type FatalActionValidationError

type FatalActionValidationError struct {
	// contains filtered or unexported fields
}

FatalActionValidationError is the validation error returned by FatalAction.Validate if the designated constraints aren't met.

func (FatalActionValidationError) Cause

Cause function returns cause value.

func (FatalActionValidationError) Error

Error satisfies the builtin error interface

func (FatalActionValidationError) ErrorName

func (e FatalActionValidationError) ErrorName() string

ErrorName returns error name.

func (FatalActionValidationError) Field

Field function returns field value.

func (FatalActionValidationError) Key

Key function returns key value.

func (FatalActionValidationError) Reason

Reason function returns reason value.

type LayeredRuntime

type LayeredRuntime struct {

	// The :ref:`layers <config_runtime_layering>` of the runtime. This is ordered
	// such that later layers in the list overlay earlier entries.
	Layers []*RuntimeLayer `protobuf:"bytes,1,rep,name=layers,proto3" json:"layers,omitempty"`
	// contains filtered or unexported fields
}

Runtime :ref:`configuration overview <config_runtime>`.

func (*LayeredRuntime) Descriptor deprecated

func (*LayeredRuntime) Descriptor() ([]byte, []int)

Deprecated: Use LayeredRuntime.ProtoReflect.Descriptor instead.

func (*LayeredRuntime) GetLayers

func (x *LayeredRuntime) GetLayers() []*RuntimeLayer

func (*LayeredRuntime) ProtoMessage

func (*LayeredRuntime) ProtoMessage()

func (*LayeredRuntime) ProtoReflect

func (x *LayeredRuntime) ProtoReflect() protoreflect.Message

func (*LayeredRuntime) Reset

func (x *LayeredRuntime) Reset()

func (*LayeredRuntime) String

func (x *LayeredRuntime) String() string

func (*LayeredRuntime) Validate

func (m *LayeredRuntime) Validate() error

Validate checks the field values on LayeredRuntime with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type LayeredRuntimeValidationError

type LayeredRuntimeValidationError struct {
	// contains filtered or unexported fields
}

LayeredRuntimeValidationError is the validation error returned by LayeredRuntime.Validate if the designated constraints aren't met.

func (LayeredRuntimeValidationError) Cause

Cause function returns cause value.

func (LayeredRuntimeValidationError) Error

Error satisfies the builtin error interface

func (LayeredRuntimeValidationError) ErrorName

func (e LayeredRuntimeValidationError) ErrorName() string

ErrorName returns error name.

func (LayeredRuntimeValidationError) Field

Field function returns field value.

func (LayeredRuntimeValidationError) Key

Key function returns key value.

func (LayeredRuntimeValidationError) Reason

Reason function returns reason value.

type Runtime

type Runtime struct {

	// The implementation assumes that the file system tree is accessed via a
	// symbolic link. An atomic link swap is used when a new tree should be
	// switched to. This parameter specifies the path to the symbolic link. Envoy
	// will watch the location for changes and reload the file system tree when
	// they happen. If this parameter is not set, there will be no disk based
	// runtime.
	SymlinkRoot string `protobuf:"bytes,1,opt,name=symlink_root,json=symlinkRoot,proto3" json:"symlink_root,omitempty"`
	// Specifies the subdirectory to load within the root directory. This is
	// useful if multiple systems share the same delivery mechanism. Envoy
	// configuration elements can be contained in a dedicated subdirectory.
	Subdirectory string `protobuf:"bytes,2,opt,name=subdirectory,proto3" json:"subdirectory,omitempty"`
	// Specifies an optional subdirectory to load within the root directory. If
	// specified and the directory exists, configuration values within this
	// directory will override those found in the primary subdirectory. This is
	// useful when Envoy is deployed across many different types of servers.
	// Sometimes it is useful to have a per service cluster directory for runtime
	// configuration. See below for exactly how the override directory is used.
	OverrideSubdirectory string `protobuf:"bytes,3,opt,name=override_subdirectory,json=overrideSubdirectory,proto3" json:"override_subdirectory,omitempty"`
	// Static base runtime. This will be :ref:`overridden
	// <config_runtime_layering>` by other runtime layers, e.g.
	// disk or admin. This follows the :ref:`runtime protobuf JSON representation
	// encoding <config_runtime_proto_json>`.
	Base *_struct.Struct `protobuf:"bytes,4,opt,name=base,proto3" json:"base,omitempty"`
	// contains filtered or unexported fields
}

Runtime :ref:`configuration overview <config_runtime>` (deprecated).

func (*Runtime) Descriptor deprecated

func (*Runtime) Descriptor() ([]byte, []int)

Deprecated: Use Runtime.ProtoReflect.Descriptor instead.

func (*Runtime) GetBase

func (x *Runtime) GetBase() *_struct.Struct

func (*Runtime) GetOverrideSubdirectory

func (x *Runtime) GetOverrideSubdirectory() string

func (*Runtime) GetSubdirectory

func (x *Runtime) GetSubdirectory() string

func (*Runtime) GetSymlinkRoot

func (x *Runtime) GetSymlinkRoot() string

func (*Runtime) ProtoMessage

func (*Runtime) ProtoMessage()

func (*Runtime) ProtoReflect

func (x *Runtime) ProtoReflect() protoreflect.Message

func (*Runtime) Reset

func (x *Runtime) Reset()

func (*Runtime) String

func (x *Runtime) String() string

func (*Runtime) Validate

func (m *Runtime) Validate() error

Validate checks the field values on Runtime with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type RuntimeLayer

type RuntimeLayer struct {

	// Descriptive name for the runtime layer. This is only used for the runtime
	// :http:get:`/runtime` output.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Types that are assignable to LayerSpecifier:
	//	*RuntimeLayer_StaticLayer
	//	*RuntimeLayer_DiskLayer_
	//	*RuntimeLayer_AdminLayer_
	//	*RuntimeLayer_RtdsLayer_
	LayerSpecifier isRuntimeLayer_LayerSpecifier `protobuf_oneof:"layer_specifier"`
	// contains filtered or unexported fields
}

[#next-free-field: 6]

func (*RuntimeLayer) Descriptor deprecated

func (*RuntimeLayer) Descriptor() ([]byte, []int)

Deprecated: Use RuntimeLayer.ProtoReflect.Descriptor instead.

func (*RuntimeLayer) GetAdminLayer

func (x *RuntimeLayer) GetAdminLayer() *RuntimeLayer_AdminLayer

func (*RuntimeLayer) GetDiskLayer

func (x *RuntimeLayer) GetDiskLayer() *RuntimeLayer_DiskLayer

func (*RuntimeLayer) GetLayerSpecifier

func (m *RuntimeLayer) GetLayerSpecifier() isRuntimeLayer_LayerSpecifier

func (*RuntimeLayer) GetName

func (x *RuntimeLayer) GetName() string

func (*RuntimeLayer) GetRtdsLayer

func (x *RuntimeLayer) GetRtdsLayer() *RuntimeLayer_RtdsLayer

func (*RuntimeLayer) GetStaticLayer

func (x *RuntimeLayer) GetStaticLayer() *_struct.Struct

func (*RuntimeLayer) ProtoMessage

func (*RuntimeLayer) ProtoMessage()

func (*RuntimeLayer) ProtoReflect

func (x *RuntimeLayer) ProtoReflect() protoreflect.Message

func (*RuntimeLayer) Reset

func (x *RuntimeLayer) Reset()

func (*RuntimeLayer) String

func (x *RuntimeLayer) String() string

func (*RuntimeLayer) Validate

func (m *RuntimeLayer) Validate() error

Validate checks the field values on RuntimeLayer with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type RuntimeLayerValidationError

type RuntimeLayerValidationError struct {
	// contains filtered or unexported fields
}

RuntimeLayerValidationError is the validation error returned by RuntimeLayer.Validate if the designated constraints aren't met.

func (RuntimeLayerValidationError) Cause

Cause function returns cause value.

func (RuntimeLayerValidationError) Error

Error satisfies the builtin error interface

func (RuntimeLayerValidationError) ErrorName

func (e RuntimeLayerValidationError) ErrorName() string

ErrorName returns error name.

func (RuntimeLayerValidationError) Field

Field function returns field value.

func (RuntimeLayerValidationError) Key

Key function returns key value.

func (RuntimeLayerValidationError) Reason

Reason function returns reason value.

type RuntimeLayer_AdminLayer

type RuntimeLayer_AdminLayer struct {
	// contains filtered or unexported fields
}

:ref:`Admin console runtime <config_runtime_admin>` layer.

func (*RuntimeLayer_AdminLayer) Descriptor deprecated

func (*RuntimeLayer_AdminLayer) Descriptor() ([]byte, []int)

Deprecated: Use RuntimeLayer_AdminLayer.ProtoReflect.Descriptor instead.

func (*RuntimeLayer_AdminLayer) ProtoMessage

func (*RuntimeLayer_AdminLayer) ProtoMessage()

func (*RuntimeLayer_AdminLayer) ProtoReflect

func (x *RuntimeLayer_AdminLayer) ProtoReflect() protoreflect.Message

func (*RuntimeLayer_AdminLayer) Reset

func (x *RuntimeLayer_AdminLayer) Reset()

func (*RuntimeLayer_AdminLayer) String

func (x *RuntimeLayer_AdminLayer) String() string

func (*RuntimeLayer_AdminLayer) Validate

func (m *RuntimeLayer_AdminLayer) Validate() error

Validate checks the field values on RuntimeLayer_AdminLayer with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type RuntimeLayer_AdminLayerValidationError

type RuntimeLayer_AdminLayerValidationError struct {
	// contains filtered or unexported fields
}

RuntimeLayer_AdminLayerValidationError is the validation error returned by RuntimeLayer_AdminLayer.Validate if the designated constraints aren't met.

func (RuntimeLayer_AdminLayerValidationError) Cause

Cause function returns cause value.

func (RuntimeLayer_AdminLayerValidationError) Error

Error satisfies the builtin error interface

func (RuntimeLayer_AdminLayerValidationError) ErrorName

ErrorName returns error name.

func (RuntimeLayer_AdminLayerValidationError) Field

Field function returns field value.

func (RuntimeLayer_AdminLayerValidationError) Key

Key function returns key value.

func (RuntimeLayer_AdminLayerValidationError) Reason

Reason function returns reason value.

type RuntimeLayer_AdminLayer_

type RuntimeLayer_AdminLayer_ struct {
	AdminLayer *RuntimeLayer_AdminLayer `protobuf:"bytes,4,opt,name=admin_layer,json=adminLayer,proto3,oneof"`
}

type RuntimeLayer_DiskLayer

type RuntimeLayer_DiskLayer struct {

	// The implementation assumes that the file system tree is accessed via a
	// symbolic link. An atomic link swap is used when a new tree should be
	// switched to. This parameter specifies the path to the symbolic link.
	// Envoy will watch the location for changes and reload the file system tree
	// when they happen. See documentation on runtime :ref:`atomicity
	// <config_runtime_atomicity>` for further details on how reloads are
	// treated.
	SymlinkRoot string `protobuf:"bytes,1,opt,name=symlink_root,json=symlinkRoot,proto3" json:"symlink_root,omitempty"`
	// Specifies the subdirectory to load within the root directory. This is
	// useful if multiple systems share the same delivery mechanism. Envoy
	// configuration elements can be contained in a dedicated subdirectory.
	Subdirectory string `protobuf:"bytes,3,opt,name=subdirectory,proto3" json:"subdirectory,omitempty"`
	// :ref:`Append <config_runtime_local_disk_service_cluster_subdirs>` the
	// service cluster to the path under symlink root.
	AppendServiceCluster bool `protobuf:"varint,2,opt,name=append_service_cluster,json=appendServiceCluster,proto3" json:"append_service_cluster,omitempty"`
	// contains filtered or unexported fields
}

:ref:`Disk runtime <config_runtime_local_disk>` layer.

func (*RuntimeLayer_DiskLayer) Descriptor deprecated

func (*RuntimeLayer_DiskLayer) Descriptor() ([]byte, []int)

Deprecated: Use RuntimeLayer_DiskLayer.ProtoReflect.Descriptor instead.

func (*RuntimeLayer_DiskLayer) GetAppendServiceCluster

func (x *RuntimeLayer_DiskLayer) GetAppendServiceCluster() bool

func (*RuntimeLayer_DiskLayer) GetSubdirectory

func (x *RuntimeLayer_DiskLayer) GetSubdirectory() string

func (*RuntimeLayer_DiskLayer) GetSymlinkRoot

func (x *RuntimeLayer_DiskLayer) GetSymlinkRoot() string

func (*RuntimeLayer_DiskLayer) ProtoMessage

func (*RuntimeLayer_DiskLayer) ProtoMessage()

func (*RuntimeLayer_DiskLayer) ProtoReflect

func (x *RuntimeLayer_DiskLayer) ProtoReflect() protoreflect.Message

func (*RuntimeLayer_DiskLayer) Reset

func (x *RuntimeLayer_DiskLayer) Reset()

func (*RuntimeLayer_DiskLayer) String

func (x *RuntimeLayer_DiskLayer) String() string

func (*RuntimeLayer_DiskLayer) Validate

func (m *RuntimeLayer_DiskLayer) Validate() error

Validate checks the field values on RuntimeLayer_DiskLayer with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type RuntimeLayer_DiskLayerValidationError

type RuntimeLayer_DiskLayerValidationError struct {
	// contains filtered or unexported fields
}

RuntimeLayer_DiskLayerValidationError is the validation error returned by RuntimeLayer_DiskLayer.Validate if the designated constraints aren't met.

func (RuntimeLayer_DiskLayerValidationError) Cause

Cause function returns cause value.

func (RuntimeLayer_DiskLayerValidationError) Error

Error satisfies the builtin error interface

func (RuntimeLayer_DiskLayerValidationError) ErrorName

ErrorName returns error name.

func (RuntimeLayer_DiskLayerValidationError) Field

Field function returns field value.

func (RuntimeLayer_DiskLayerValidationError) Key

Key function returns key value.

func (RuntimeLayer_DiskLayerValidationError) Reason

Reason function returns reason value.

type RuntimeLayer_DiskLayer_

type RuntimeLayer_DiskLayer_ struct {
	DiskLayer *RuntimeLayer_DiskLayer `protobuf:"bytes,3,opt,name=disk_layer,json=diskLayer,proto3,oneof"`
}

type RuntimeLayer_RtdsLayer

type RuntimeLayer_RtdsLayer struct {

	// Resource to subscribe to at *rtds_config* for the RTDS layer.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// RTDS configuration source.
	RtdsConfig *v3.ConfigSource `protobuf:"bytes,2,opt,name=rtds_config,json=rtdsConfig,proto3" json:"rtds_config,omitempty"`
	// contains filtered or unexported fields
}

:ref:`Runtime Discovery Service (RTDS) <config_runtime_rtds>` layer.

func (*RuntimeLayer_RtdsLayer) Descriptor deprecated

func (*RuntimeLayer_RtdsLayer) Descriptor() ([]byte, []int)

Deprecated: Use RuntimeLayer_RtdsLayer.ProtoReflect.Descriptor instead.

func (*RuntimeLayer_RtdsLayer) GetName

func (x *RuntimeLayer_RtdsLayer) GetName() string

func (*RuntimeLayer_RtdsLayer) GetRtdsConfig

func (x *RuntimeLayer_RtdsLayer) GetRtdsConfig() *v3.ConfigSource

func (*RuntimeLayer_RtdsLayer) ProtoMessage

func (*RuntimeLayer_RtdsLayer) ProtoMessage()

func (*RuntimeLayer_RtdsLayer) ProtoReflect

func (x *RuntimeLayer_RtdsLayer) ProtoReflect() protoreflect.Message

func (*RuntimeLayer_RtdsLayer) Reset

func (x *RuntimeLayer_RtdsLayer) Reset()

func (*RuntimeLayer_RtdsLayer) String

func (x *RuntimeLayer_RtdsLayer) String() string

func (*RuntimeLayer_RtdsLayer) Validate

func (m *RuntimeLayer_RtdsLayer) Validate() error

Validate checks the field values on RuntimeLayer_RtdsLayer with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type RuntimeLayer_RtdsLayerValidationError

type RuntimeLayer_RtdsLayerValidationError struct {
	// contains filtered or unexported fields
}

RuntimeLayer_RtdsLayerValidationError is the validation error returned by RuntimeLayer_RtdsLayer.Validate if the designated constraints aren't met.

func (RuntimeLayer_RtdsLayerValidationError) Cause

Cause function returns cause value.

func (RuntimeLayer_RtdsLayerValidationError) Error

Error satisfies the builtin error interface

func (RuntimeLayer_RtdsLayerValidationError) ErrorName

ErrorName returns error name.

func (RuntimeLayer_RtdsLayerValidationError) Field

Field function returns field value.

func (RuntimeLayer_RtdsLayerValidationError) Key

Key function returns key value.

func (RuntimeLayer_RtdsLayerValidationError) Reason

Reason function returns reason value.

type RuntimeLayer_RtdsLayer_

type RuntimeLayer_RtdsLayer_ struct {
	RtdsLayer *RuntimeLayer_RtdsLayer `protobuf:"bytes,5,opt,name=rtds_layer,json=rtdsLayer,proto3,oneof"`
}

type RuntimeLayer_StaticLayer

type RuntimeLayer_StaticLayer struct {
	// :ref:`Static runtime <config_runtime_bootstrap>` layer.
	// This follows the :ref:`runtime protobuf JSON representation encoding
	// <config_runtime_proto_json>`. Unlike static xDS resources, this static
	// layer is overridable by later layers in the runtime virtual filesystem.
	StaticLayer *_struct.Struct `protobuf:"bytes,2,opt,name=static_layer,json=staticLayer,proto3,oneof"`
}

type RuntimeValidationError

type RuntimeValidationError struct {
	// contains filtered or unexported fields
}

RuntimeValidationError is the validation error returned by Runtime.Validate if the designated constraints aren't met.

func (RuntimeValidationError) Cause

func (e RuntimeValidationError) Cause() error

Cause function returns cause value.

func (RuntimeValidationError) Error

func (e RuntimeValidationError) Error() string

Error satisfies the builtin error interface

func (RuntimeValidationError) ErrorName

func (e RuntimeValidationError) ErrorName() string

ErrorName returns error name.

func (RuntimeValidationError) Field

func (e RuntimeValidationError) Field() string

Field function returns field value.

func (RuntimeValidationError) Key

func (e RuntimeValidationError) Key() bool

Key function returns key value.

func (RuntimeValidationError) Reason

func (e RuntimeValidationError) Reason() string

Reason function returns reason value.

type Watchdog

type Watchdog struct {

	// Register actions that will fire on given WatchDog events.
	// See *WatchDogAction* for priority of events.
	Actions []*Watchdog_WatchdogAction `protobuf:"bytes,7,rep,name=actions,proto3" json:"actions,omitempty"`
	// The duration after which Envoy counts a nonresponsive thread in the
	// *watchdog_miss* statistic. If not specified the default is 200ms.
	MissTimeout *duration.Duration `protobuf:"bytes,1,opt,name=miss_timeout,json=missTimeout,proto3" json:"miss_timeout,omitempty"`
	// The duration after which Envoy counts a nonresponsive thread in the
	// *watchdog_mega_miss* statistic. If not specified the default is
	// 1000ms.
	MegamissTimeout *duration.Duration `protobuf:"bytes,2,opt,name=megamiss_timeout,json=megamissTimeout,proto3" json:"megamiss_timeout,omitempty"`
	// If a watched thread has been nonresponsive for this duration, assume a
	// programming error and kill the entire Envoy process. Set to 0 to disable
	// kill behavior. If not specified the default is 0 (disabled).
	KillTimeout *duration.Duration `protobuf:"bytes,3,opt,name=kill_timeout,json=killTimeout,proto3" json:"kill_timeout,omitempty"`
	// Defines the maximum jitter used to adjust the *kill_timeout* if *kill_timeout* is
	// enabled. Enabling this feature would help to reduce risk of synchronized
	// watchdog kill events across proxies due to external triggers. Set to 0 to
	// disable. If not specified the default is 0 (disabled).
	MaxKillTimeoutJitter *duration.Duration `protobuf:"bytes,6,opt,name=max_kill_timeout_jitter,json=maxKillTimeoutJitter,proto3" json:"max_kill_timeout_jitter,omitempty"`
	// If max(2, ceil(registered_threads * Fraction(*multikill_threshold*)))
	// threads have been nonresponsive for at least this duration kill the entire
	// Envoy process. Set to 0 to disable this behavior. If not specified the
	// default is 0 (disabled).
	MultikillTimeout *duration.Duration `protobuf:"bytes,4,opt,name=multikill_timeout,json=multikillTimeout,proto3" json:"multikill_timeout,omitempty"`
	// Sets the threshold for *multikill_timeout* in terms of the percentage of
	// nonresponsive threads required for the *multikill_timeout*.
	// If not specified the default is 0.
	MultikillThreshold *v35.Percent `protobuf:"bytes,5,opt,name=multikill_threshold,json=multikillThreshold,proto3" json:"multikill_threshold,omitempty"`
	// contains filtered or unexported fields
}

Envoy process watchdog configuration. When configured, this monitors for nonresponsive threads and kills the process after the configured thresholds. See the :ref:`watchdog documentation <operations_performance_watchdog>` for more information. [#next-free-field: 8]

func (*Watchdog) Descriptor deprecated

func (*Watchdog) Descriptor() ([]byte, []int)

Deprecated: Use Watchdog.ProtoReflect.Descriptor instead.

func (*Watchdog) GetActions

func (x *Watchdog) GetActions() []*Watchdog_WatchdogAction

func (*Watchdog) GetKillTimeout

func (x *Watchdog) GetKillTimeout() *duration.Duration

func (*Watchdog) GetMaxKillTimeoutJitter

func (x *Watchdog) GetMaxKillTimeoutJitter() *duration.Duration

func (*Watchdog) GetMegamissTimeout

func (x *Watchdog) GetMegamissTimeout() *duration.Duration

func (*Watchdog) GetMissTimeout

func (x *Watchdog) GetMissTimeout() *duration.Duration

func (*Watchdog) GetMultikillThreshold

func (x *Watchdog) GetMultikillThreshold() *v35.Percent

func (*Watchdog) GetMultikillTimeout

func (x *Watchdog) GetMultikillTimeout() *duration.Duration

func (*Watchdog) ProtoMessage

func (*Watchdog) ProtoMessage()

func (*Watchdog) ProtoReflect

func (x *Watchdog) ProtoReflect() protoreflect.Message

func (*Watchdog) Reset

func (x *Watchdog) Reset()

func (*Watchdog) String

func (x *Watchdog) String() string

func (*Watchdog) Validate

func (m *Watchdog) Validate() error

Validate checks the field values on Watchdog with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type WatchdogValidationError

type WatchdogValidationError struct {
	// contains filtered or unexported fields
}

WatchdogValidationError is the validation error returned by Watchdog.Validate if the designated constraints aren't met.

func (WatchdogValidationError) Cause

func (e WatchdogValidationError) Cause() error

Cause function returns cause value.

func (WatchdogValidationError) Error

func (e WatchdogValidationError) Error() string

Error satisfies the builtin error interface

func (WatchdogValidationError) ErrorName

func (e WatchdogValidationError) ErrorName() string

ErrorName returns error name.

func (WatchdogValidationError) Field

func (e WatchdogValidationError) Field() string

Field function returns field value.

func (WatchdogValidationError) Key

func (e WatchdogValidationError) Key() bool

Key function returns key value.

func (WatchdogValidationError) Reason

func (e WatchdogValidationError) Reason() string

Reason function returns reason value.

type Watchdog_WatchdogAction

type Watchdog_WatchdogAction struct {

	// Extension specific configuration for the action.
	Config *v3.TypedExtensionConfig              `protobuf:"bytes,1,opt,name=config,proto3" json:"config,omitempty"`
	Event  Watchdog_WatchdogAction_WatchdogEvent `` /* 133-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*Watchdog_WatchdogAction) Descriptor deprecated

func (*Watchdog_WatchdogAction) Descriptor() ([]byte, []int)

Deprecated: Use Watchdog_WatchdogAction.ProtoReflect.Descriptor instead.

func (*Watchdog_WatchdogAction) GetConfig

func (*Watchdog_WatchdogAction) GetEvent

func (*Watchdog_WatchdogAction) ProtoMessage

func (*Watchdog_WatchdogAction) ProtoMessage()

func (*Watchdog_WatchdogAction) ProtoReflect

func (x *Watchdog_WatchdogAction) ProtoReflect() protoreflect.Message

func (*Watchdog_WatchdogAction) Reset

func (x *Watchdog_WatchdogAction) Reset()

func (*Watchdog_WatchdogAction) String

func (x *Watchdog_WatchdogAction) String() string

func (*Watchdog_WatchdogAction) Validate

func (m *Watchdog_WatchdogAction) Validate() error

Validate checks the field values on Watchdog_WatchdogAction with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type Watchdog_WatchdogActionValidationError

type Watchdog_WatchdogActionValidationError struct {
	// contains filtered or unexported fields
}

Watchdog_WatchdogActionValidationError is the validation error returned by Watchdog_WatchdogAction.Validate if the designated constraints aren't met.

func (Watchdog_WatchdogActionValidationError) Cause

Cause function returns cause value.

func (Watchdog_WatchdogActionValidationError) Error

Error satisfies the builtin error interface

func (Watchdog_WatchdogActionValidationError) ErrorName

ErrorName returns error name.

func (Watchdog_WatchdogActionValidationError) Field

Field function returns field value.

func (Watchdog_WatchdogActionValidationError) Key

Key function returns key value.

func (Watchdog_WatchdogActionValidationError) Reason

Reason function returns reason value.

type Watchdog_WatchdogAction_WatchdogEvent

type Watchdog_WatchdogAction_WatchdogEvent int32

The events are fired in this order: KILL, MULTIKILL, MEGAMISS, MISS. Within an event type, actions execute in the order they are configured. For KILL/MULTIKILL there is a default PANIC that will run after the registered actions and kills the process if it wasn't already killed. It might be useful to specify several debug actions, and possibly an alternate FATAL action.

const (
	Watchdog_WatchdogAction_UNKNOWN   Watchdog_WatchdogAction_WatchdogEvent = 0
	Watchdog_WatchdogAction_KILL      Watchdog_WatchdogAction_WatchdogEvent = 1
	Watchdog_WatchdogAction_MULTIKILL Watchdog_WatchdogAction_WatchdogEvent = 2
	Watchdog_WatchdogAction_MEGAMISS  Watchdog_WatchdogAction_WatchdogEvent = 3
	Watchdog_WatchdogAction_MISS      Watchdog_WatchdogAction_WatchdogEvent = 4
)

func (Watchdog_WatchdogAction_WatchdogEvent) Descriptor

func (Watchdog_WatchdogAction_WatchdogEvent) Enum

func (Watchdog_WatchdogAction_WatchdogEvent) EnumDescriptor deprecated

func (Watchdog_WatchdogAction_WatchdogEvent) EnumDescriptor() ([]byte, []int)

Deprecated: Use Watchdog_WatchdogAction_WatchdogEvent.Descriptor instead.

func (Watchdog_WatchdogAction_WatchdogEvent) Number

func (Watchdog_WatchdogAction_WatchdogEvent) String

func (Watchdog_WatchdogAction_WatchdogEvent) Type

type Watchdogs

type Watchdogs struct {

	// Watchdog for the main thread.
	MainThreadWatchdog *Watchdog `protobuf:"bytes,1,opt,name=main_thread_watchdog,json=mainThreadWatchdog,proto3" json:"main_thread_watchdog,omitempty"`
	// Watchdog for the worker threads.
	WorkerWatchdog *Watchdog `protobuf:"bytes,2,opt,name=worker_watchdog,json=workerWatchdog,proto3" json:"worker_watchdog,omitempty"`
	// contains filtered or unexported fields
}

Allows you to specify different watchdog configs for different subsystems. This allows finer tuned policies for the watchdog. If a subsystem is omitted the default values for that system will be used.

func (*Watchdogs) Descriptor deprecated

func (*Watchdogs) Descriptor() ([]byte, []int)

Deprecated: Use Watchdogs.ProtoReflect.Descriptor instead.

func (*Watchdogs) GetMainThreadWatchdog

func (x *Watchdogs) GetMainThreadWatchdog() *Watchdog

func (*Watchdogs) GetWorkerWatchdog

func (x *Watchdogs) GetWorkerWatchdog() *Watchdog

func (*Watchdogs) ProtoMessage

func (*Watchdogs) ProtoMessage()

func (*Watchdogs) ProtoReflect

func (x *Watchdogs) ProtoReflect() protoreflect.Message

func (*Watchdogs) Reset

func (x *Watchdogs) Reset()

func (*Watchdogs) String

func (x *Watchdogs) String() string

func (*Watchdogs) Validate

func (m *Watchdogs) Validate() error

Validate checks the field values on Watchdogs with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type WatchdogsValidationError

type WatchdogsValidationError struct {
	// contains filtered or unexported fields
}

WatchdogsValidationError is the validation error returned by Watchdogs.Validate if the designated constraints aren't met.

func (WatchdogsValidationError) Cause

func (e WatchdogsValidationError) Cause() error

Cause function returns cause value.

func (WatchdogsValidationError) Error

func (e WatchdogsValidationError) Error() string

Error satisfies the builtin error interface

func (WatchdogsValidationError) ErrorName

func (e WatchdogsValidationError) ErrorName() string

ErrorName returns error name.

func (WatchdogsValidationError) Field

func (e WatchdogsValidationError) Field() string

Field function returns field value.

func (WatchdogsValidationError) Key

Key function returns key value.

func (WatchdogsValidationError) Reason

func (e WatchdogsValidationError) Reason() string

Reason function returns reason value.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL