generator

Documentation

Index

• Constants
• Variables
• func InferServiceProtocol(endpoints []core_xds.Endpoint) core_mesh.Protocol
• func NewDefaultProxyProfile() core.ResourceGenerator
• func NewEgressProxyProfile() core.ResourceGenerator
• func RegisterProfile(profileName string, generator core.ResourceGenerator)
• type AdminProxyGenerator
  • func (g AdminProxyGenerator) Generate(ctx xds_context.Context, proxy *core_xds.Proxy) (*core_xds.ResourceSet, error)
• type DNSGenerator
  • func (g DNSGenerator) Generate(ctx xds_context.Context, proxy *core_xds.Proxy) (*core_xds.ResourceSet, error)
• type DirectAccessProxyGenerator
  • func (_ DirectAccessProxyGenerator) Generate(ctx xds_context.Context, proxy *core_xds.Proxy) (*core_xds.ResourceSet, error)
• type Endpoint
• type Endpoints
  • func (a Endpoints) Len() int
  • func (a Endpoints) Less(i, j int) bool
  • func (a Endpoints) Swap(i, j int)
• type InboundProxyGenerator
  • func (g InboundProxyGenerator) Generate(ctx xds_context.Context, proxy *core_xds.Proxy) (*core_xds.ResourceSet, error)
• type IngressGenerator
  • func (i IngressGenerator) Generate(ctx xds_context.Context, proxy *core_xds.Proxy) (*core_xds.ResourceSet, error)
• type OutboundProxyGenerator
  • func (g OutboundProxyGenerator) Generate(ctx xds_context.Context, proxy *model.Proxy) (*model.ResourceSet, error)
• type ProbeProxyGenerator
  • func (g ProbeProxyGenerator) Generate(ctx xds_context.Context, proxy *model.Proxy) (*model.ResourceSet, error)
• type PrometheusEndpointGenerator
  • func (g PrometheusEndpointGenerator) Generate(ctx xds_context.Context, proxy *core_xds.Proxy) (*core_xds.ResourceSet, error)
• type ProxyTemplateGenerator
  • func (g *ProxyTemplateGenerator) Generate(ctx xds_context.Context, proxy *model.Proxy) (*model.ResourceSet, error)
• type ProxyTemplateProfileSource
  • func (s *ProxyTemplateProfileSource) Generate(ctx xds_context.Context, proxy *model.Proxy) (*model.ResourceSet, error)
• type ProxyTemplateRawSource
  • func (s *ProxyTemplateRawSource) Generate(_ xds_context.Context, proxy *model.Proxy) (*model.ResourceSet, error)
• type TracingProxyGenerator
  • func (t TracingProxyGenerator) Generate(ctx xds_context.Context, proxy *core_xds.Proxy) (resources *core_xds.ResourceSet, err error)
• type TransparentProxyGenerator
  • func (tpg TransparentProxyGenerator) Generate(ctx xds_context.Context, proxy *model.Proxy) (*model.ResourceSet, error)

Constants

const (
	IngressProxy = "ingress-proxy"

	// OriginIngress is a marker to indicate by which ProxyGenerator resources were generated.
	OriginIngress = "ingress"
)

const OriginAdmin = "admin"

OriginAdmin is a marker to indicate by which ProxyGenerator resources were generated.

const OriginDNS = "dns"

OriginDNS is a marker to indicate by which ProxyGenerator resources were generated.

const OriginDirectAccess = "direct-access"

OriginDirectAccess is a marker to indicate by which ProxyGenerator resources were generated.

const OriginInbound = "inbound"

OriginInbound is a marker to indicate by which ProxyGenerator resources were generated.

const OriginOutbound = "outbound"

OriginOutbound is a marker to indicate by which ProxyGenerator resources were generated.

const (
	// OriginProbes is a marker to indicate by which ProxyGenerator resources were generated.
	OriginProbe = "probe"
)

const OriginPrometheus = "prometheus"

OriginPrometheus is a marker to indicate by which ProxyGenerator resources were generated.

const OriginProxyTemplateRaw = "proxy-template-raw"

OriginProxyTemplateRaw is a marker to indicate by which ProxyGenerator resources were generated.

const OriginTracing = "tracing"

OriginTracing is a marker to indicate by which ProxyGenerator resources were generated.

const (
	OriginTransparent = "transparent"
)

OriginTransparent is a marker to indicate by which ProxyGenerator resources were generated.

Variables

var DefaultTemplateResolver template.ProxyTemplateResolver = &template.StaticProxyTemplateResolver{
	Template: &mesh_proto.ProxyTemplate{
		Conf: &mesh_proto.ProxyTemplate_Conf{
			Imports: []string{core_mesh.ProfileDefaultProxy},
		},
	},
}

DefaultTemplateResolver is the default template resolver that xDS generators fall back to if they are otherwise unable to determine which ProxyTemplate resource to apply. Plugins may modify this variable.

Functions

func InferServiceProtocol

func InferServiceProtocol(endpoints []core_xds.Endpoint) core_mesh.Protocol

InferServiceProtocol returns a common protocol for a given group of endpoints.

func NewDefaultProxyProfile

func NewDefaultProxyProfile() core.ResourceGenerator

func NewEgressProxyProfile

func NewEgressProxyProfile() core.ResourceGenerator

func RegisterProfile

func RegisterProfile(profileName string, generator core.ResourceGenerator)

Types

type AdminProxyGenerator

type AdminProxyGenerator struct {
}

AdminProxyGenerator generates resources to expose some endpoints of Admin API on public interface. By default, Admin API is exposed only on loopback interface because of security reasons.

func (AdminProxyGenerator) Generate

func (g AdminProxyGenerator) Generate(ctx xds_context.Context, proxy *core_xds.Proxy) (*core_xds.ResourceSet, error)

type DNSGenerator

type DNSGenerator struct {
}

func (DNSGenerator) Generate

func (g DNSGenerator) Generate(ctx xds_context.Context, proxy *core_xds.Proxy) (*core_xds.ResourceSet, error)

type DirectAccessProxyGenerator

type DirectAccessProxyGenerator struct {
}

Transparent Proxy is based on having 1 IP for cluster (ex. ClusterIP of Service on K8S), so consuming apps by their IP is unknown destination from Envoy perspective. Therefore such request will go trough pass_trough cluster and won't be encrypted by mTLS. This generates listener for every IP and redirect traffic trough "direct_access" cluster which is configured to encrypt connections. Generating listener for every endpoint will cause XDS snapshot to be large therefore it should be used only if really needed.

Second approach to consider was to use FilterChainMatch on catch_all listener with list of all direct access endpoints instead of generating outbound listener, but it seemed to not work with Listener#UseOriginalDst

func (DirectAccessProxyGenerator) Generate

func (_ DirectAccessProxyGenerator) Generate(ctx xds_context.Context, proxy *core_xds.Proxy) (*core_xds.ResourceSet, error)

type Endpoint

type Endpoint struct {
	Address string
	Port    uint32
}

type Endpoints

type Endpoints []Endpoint

func (Endpoints) Len

func (a Endpoints) Len() int

func (Endpoints) Less

func (a Endpoints) Less(i, j int) bool

func (Endpoints) Swap

func (a Endpoints) Swap(i, j int)

type InboundProxyGenerator

type InboundProxyGenerator struct {
}

func (InboundProxyGenerator) Generate

func (g InboundProxyGenerator) Generate(ctx xds_context.Context, proxy *core_xds.Proxy) (*core_xds.ResourceSet, error)

type IngressGenerator

type IngressGenerator struct {
}

func (IngressGenerator) Generate

func (i IngressGenerator) Generate(ctx xds_context.Context, proxy *core_xds.Proxy) (*core_xds.ResourceSet, error)

type OutboundProxyGenerator

type OutboundProxyGenerator struct {
}

func (OutboundProxyGenerator) Generate

func (g OutboundProxyGenerator) Generate(ctx xds_context.Context, proxy *model.Proxy) (*model.ResourceSet, error)

type ProbeProxyGenerator

type ProbeProxyGenerator struct {
}

func (ProbeProxyGenerator) Generate

func (g ProbeProxyGenerator) Generate(ctx xds_context.Context, proxy *model.Proxy) (*model.ResourceSet, error)

type PrometheusEndpointGenerator

type PrometheusEndpointGenerator struct {
}

PrometheusEndpointGenerator generates an inbound Envoy listener that forwards HTTP requests into the `/stats/prometheus` endpoint of the Envoy Admin API.

When generating such a listener, it's important not to overshadow a port that is already in use by the application or other Envoy listeners. In the latter case we prefer not generate Prometheus endpoint at all rather than introduce undeterministic behavior.

func (PrometheusEndpointGenerator) Generate

func (g PrometheusEndpointGenerator) Generate(ctx xds_context.Context, proxy *core_xds.Proxy) (*core_xds.ResourceSet, error)

type ProxyTemplateGenerator

type ProxyTemplateGenerator struct {
	ProxyTemplate *mesh_proto.ProxyTemplate
}

func (*ProxyTemplateGenerator) Generate

func (g *ProxyTemplateGenerator) Generate(ctx xds_context.Context, proxy *model.Proxy) (*model.ResourceSet, error)

type ProxyTemplateProfileSource

type ProxyTemplateProfileSource struct {
	ProfileName string
}

func (*ProxyTemplateProfileSource) Generate

func (s *ProxyTemplateProfileSource) Generate(ctx xds_context.Context, proxy *model.Proxy) (*model.ResourceSet, error)

type ProxyTemplateRawSource

type ProxyTemplateRawSource struct {
	Resources []*mesh_proto.ProxyTemplateRawResource
}

func (*ProxyTemplateRawSource) Generate

func (s *ProxyTemplateRawSource) Generate(_ xds_context.Context, proxy *model.Proxy) (*model.ResourceSet, error)

type TracingProxyGenerator

type TracingProxyGenerator struct {
}

func (TracingProxyGenerator) Generate

func (t TracingProxyGenerator) Generate(ctx xds_context.Context, proxy *core_xds.Proxy) (resources *core_xds.ResourceSet, err error)

type TransparentProxyGenerator

type TransparentProxyGenerator struct {
}

func (TransparentProxyGenerator) Generate

func (tpg TransparentProxyGenerator) Generate(ctx xds_context.Context, proxy *model.Proxy) (*model.ResourceSet, error)