envoy

Documentation

Index

• type APIVersion
  • func ParseAPIVersion(version string) (APIVersion, error)
  • func (version APIVersion) String() string
• type EndpointHealthStatus
• type Resource
• type Type
• type UpstreamHost

Types

type APIVersion

type APIVersion string

APIVersion is an enum with the supported envoy API versions.

const (
	// APIv3 is the envoy v3 API version.
	APIv3 APIVersion = "v3"
)

func ParseAPIVersion

func ParseAPIVersion(version string) (APIVersion, error)

ParseAPIVersion returns an APIVersion for the given string or an error

func (APIVersion) String

func (version APIVersion) String() string

String returns the string representation of APIVersion

type EndpointHealthStatus

type EndpointHealthStatus int32

const (
	// The health status is not known. This is interpreted by Envoy as “HEALTHY“.
	HealthStatus_UNKNOWN EndpointHealthStatus = 0
	// Healthy.
	HealthStatus_HEALTHY EndpointHealthStatus = 1
	// Unhealthy.
	HealthStatus_UNHEALTHY EndpointHealthStatus = 2
	// Connection draining in progress. E.g.,
	// `<https://aws.amazon.com/blogs/aws/elb-connection-draining-remove-instances-from-service-with-care/>`_
	// or
	// `<https://cloud.google.com/compute/docs/load-balancing/enabling-connection-draining>`_.
	// This is interpreted by Envoy as “UNHEALTHY“.
	HealthStatus_DRAINING EndpointHealthStatus = 3
	// Health check timed out. This is part of HDS and is interpreted by Envoy as
	// “UNHEALTHY“.
	HealthStatus_TIMEOUT EndpointHealthStatus = 4
	// Degraded.
	HealthStatus_DEGRADED EndpointHealthStatus = 5
)

type Resource

type Resource interface {
	proto.Message
}

Resource is the base interface for the xDS payload. Any envoy resource type implements this interface.

type Type

type Type string

Type is an enum of the supported envoy resource types

const (
	// Endpoint is an envoy endpoint resource
	Endpoint Type = "endpoint"
	// Cluster is an envoy cluster resource
	Cluster Type = "cluster"
	// Route is an envoy route resource
	Route Type = "route"
	// ScopedRoute is an envoy scoped route resource
	ScopedRoute Type = "scopedRoute"
	// VirtualHost is an enovy virtual host resource (not implemented)
	VirtualHost Type = "virtualHost"
	// Listener is an envoy listener resource
	Listener Type = "listener"
	// Secret is an envoy secret resource
	Secret Type = "secret"
	// Runtime is an envoy runtime resource
	Runtime Type = "runtime"
	// ExtensionConfig is an envoy extension config resource
	ExtensionConfig Type = "extensionConfig"
)

type UpstreamHost

type UpstreamHost struct {
	IP     net.IP
	Port   uint32
	Health EndpointHealthStatus
}