clusterresolver

Documentation

Overview

Package clusterresolver contains EDS balancer implementation.

Index

• Constants
• type DiscoveryMechanism
  • func (dm DiscoveryMechanism) Equal(b DiscoveryMechanism) bool
• type DiscoveryMechanismType
  • func (t DiscoveryMechanismType) MarshalJSON() ([]byte, error)
  • func (t *DiscoveryMechanismType) UnmarshalJSON(b []byte) error
• type LBConfig

Constants

const Name = "cluster_resolver_experimental"

Name is the name of the cluster_resolver balancer.

Types

type DiscoveryMechanism

type DiscoveryMechanism struct {
	// Cluster is the cluster name.
	Cluster string `json:"cluster,omitempty"`
	// LoadReportingServer is the LRS server to send load reports to. If not
	// present, load reporting will be disabled.
	LoadReportingServer *bootstrap.ServerConfig `json:"lrsLoadReportingServer,omitempty"`
	// MaxConcurrentRequests is the maximum number of outstanding requests can
	// be made to the upstream cluster. Default is 1024.
	MaxConcurrentRequests *uint32 `json:"maxConcurrentRequests,omitempty"`
	// Type is the discovery mechanism type.
	Type DiscoveryMechanismType `json:"type,omitempty"`
	// EDSServiceName is the EDS service name, as returned in CDS. May be unset
	// if not specified in CDS. For type EDS only.
	//
	// This is used for EDS watch if set. If unset, Cluster is used for EDS
	// watch.
	EDSServiceName string `json:"edsServiceName,omitempty"`
	// DNSHostname is the DNS name to resolve in "host:port" form. For type
	// LOGICAL_DNS only.
	DNSHostname string `json:"dnsHostname,omitempty"`
	// OutlierDetection is the Outlier Detection LB configuration for this
	// priority.
	OutlierDetection outlierdetection.LBConfig `json:"outlierDetection,omitempty"`
}

DiscoveryMechanism is the discovery mechanism, can be either EDS or DNS.

For DNS, the ClientConn target will be used for name resolution.

For EDS, if EDSServiceName is not empty, it will be used for watching. If EDSServiceName is empty, Cluster will be used.

func (DiscoveryMechanism) Equal

func (dm DiscoveryMechanism) Equal(b DiscoveryMechanism) bool

Equal returns whether the DiscoveryMechanism is the same with the parameter.

type DiscoveryMechanismType

type DiscoveryMechanismType int

DiscoveryMechanismType is the type of discovery mechanism.

const (
	// DiscoveryMechanismTypeEDS is eds.
	DiscoveryMechanismTypeEDS DiscoveryMechanismType = iota // `json:"EDS"`
	// DiscoveryMechanismTypeLogicalDNS is DNS.
	DiscoveryMechanismTypeLogicalDNS // `json:"LOGICAL_DNS"`
)

func (DiscoveryMechanismType) MarshalJSON

func (t DiscoveryMechanismType) MarshalJSON() ([]byte, error)

MarshalJSON marshals a DiscoveryMechanismType to a quoted json string.

This is necessary to handle enum (as strings) from JSON.

Note that this needs to be defined on the type not pointer, otherwise the variables of this type will marshal to int not string.

func (*DiscoveryMechanismType) UnmarshalJSON

func (t *DiscoveryMechanismType) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals a quoted json string to the DiscoveryMechanismType.

type LBConfig

type LBConfig struct {
	serviceconfig.LoadBalancingConfig `json:"-"`
	// DiscoveryMechanisms is an ordered list of discovery mechanisms.
	//
	// Must have at least one element. Results from each discovery mechanism are
	// concatenated together in successive priorities.
	DiscoveryMechanisms []DiscoveryMechanism `json:"discoveryMechanisms,omitempty"`

	// XDSLBPolicy specifies the policy for locality picking and endpoint picking.
	//
	// Note that it's not normal balancing policy, and it can only be either
	// ROUND_ROBIN or RING_HASH.
	//
	// For ROUND_ROBIN, the policy name will be "ROUND_ROBIN", and the config
	// will be empty. This sets the locality-picking policy to weighted_target
	// and the endpoint-picking policy to round_robin.
	//
	// For RING_HASH, the policy name will be "RING_HASH", and the config will
	// be lb config for the ring_hash_experimental LB Policy. ring_hash policy
	// is responsible for both locality picking and endpoint picking.
	XDSLBPolicy *internalserviceconfig.BalancerConfig `json:"xdsLbPolicy,omitempty"`
}

LBConfig is the config for cluster resolver balancer.