proxy

Documentation

Index

• Variables
• func ChangeLogLevel(level logrus.Level)
• func GetProxyPort(name string) (uint16, error)
• func OpenLocalPorts() map[uint16]struct{}
• type CRDRedirect
  • func (r *CRDRedirect) Close(wg *completion.WaitGroup) (revert.FinalizeFunc, revert.RevertFunc)
  • func (r *CRDRedirect) UpdateRules(wg *completion.WaitGroup) (revert.RevertFunc, error)
• type DatapathUpdater
• type IPCacheManager
• type Proxy
  • func (p *Proxy) AckProxyPort(ctx context.Context, name string) error
  • func (p *Proxy) AllocateProxyPort(name string, ingress, localOnly bool) (uint16, error)
  • func (p *Proxy) CreateOrUpdateRedirect(ctx context.Context, l4 policy.ProxyPolicy, id string, ...) (proxyPort uint16, err error, finalizeFunc revert.FinalizeFunc, ...)
  • func (p *Proxy) GetStatusModel() *models.ProxyStatus
  • func (p *Proxy) ReinstallRules(ctx context.Context) error
  • func (p *Proxy) ReleaseProxyPort(name string) error
  • func (p *Proxy) RemoveRedirect(id string, wg *completion.WaitGroup) (error, revert.FinalizeFunc, revert.RevertFunc)
  • func (p *Proxy) SetProxyPort(name string, proxyType ProxyType, port uint16, ingress bool) error
  • func (p *Proxy) UpdateEnvoyResources(ctx context.Context, old, new envoy.Resources, ...) error
  • func (p *Proxy) UpdateNetworkPolicy(ep endpoint.EndpointUpdater, vis *policy.VisibilityPolicy, ...) (error, func() error)
  • func (p *Proxy) UpsertEnvoyResources(ctx context.Context, resources envoy.Resources, ...) error
• type ProxyPort
• type ProxyType
  • func (p ProxyType) String() string
• type Redirect
• type RedirectImplementation

Variables

var Cell = cell.Module(
	"l7-proxy",
	"L7 Proxy provides support for L7 network policies",

	cell.Provide(newProxy),
	cell.ProvidePrivate(endpoint.NewEndpointInfoRegistry),
)

Cell provides the L7 Proxy which provides support for L7 network policies. It is manages the different L7 proxies (Envoy, CoreDNS, ...) and the traffic redirection to them.

var (
	// DefaultDNSProxy is the global, shared, DNS Proxy singleton.
	DefaultDNSProxy proxy.DNSProxier
)

Functions

func ChangeLogLevel

func ChangeLogLevel(level logrus.Level)

ChangeLogLevel changes proxy log level to correspond to the logrus log level 'level'.

func GetProxyPort

func GetProxyPort(name string) (uint16, error)

GetProxyPort() returns the fixed listen port for a proxy, if any.

func OpenLocalPorts

func OpenLocalPorts() map[uint16]struct{}

OpenLocalPorts returns the set of L4 ports currently open locally.

Types

type CRDRedirect

type CRDRedirect struct{}

Redirect type for custom Listeners, which are managed externally.

func (*CRDRedirect) Close

func (r *CRDRedirect) Close(wg *completion.WaitGroup) (revert.FinalizeFunc, revert.RevertFunc)

func (*CRDRedirect) UpdateRules

func (r *CRDRedirect) UpdateRules(wg *completion.WaitGroup) (revert.RevertFunc, error)

type DatapathUpdater

type DatapathUpdater interface {
	InstallProxyRules(ctx context.Context, proxyPort uint16, ingress, localOnly bool, name string) error
	SupportsOriginalSourceAddr() bool
}

type IPCacheManager

type IPCacheManager interface {
	// AddListener is required for envoy.StartXDSServer()
	AddListener(ipcache.IPIdentityMappingListener)

	LookupByIP(IP string) (ipcache.Identity, bool)
}

type Proxy

type Proxy struct {
	*envoy.XDSServer
	// contains filtered or unexported fields
}

Proxy maintains state about redirects

func (*Proxy) AckProxyPort

func (p *Proxy) AckProxyPort(ctx context.Context, name string) error

AckProxyPort() marks the proxy of the given type as successfully created and creates or updates the datapath rules accordingly.

func (*Proxy) AllocateProxyPort

func (p *Proxy) AllocateProxyPort(name string, ingress, localOnly bool) (uint16, error)

AllocateProxyPort() allocates a new port for listener 'name', or returns the current one if already allocated. Each call has to be paired with AckProxyPort(name) to update the datapath rules accordingly. Each allocated port must be eventually freed with ReleaseProxyPort().

func (*Proxy) CreateOrUpdateRedirect

func (p *Proxy) CreateOrUpdateRedirect(ctx context.Context, l4 policy.ProxyPolicy, id string, localEndpoint endpoint.EndpointUpdater,
	wg *completion.WaitGroup) (proxyPort uint16, err error, finalizeFunc revert.FinalizeFunc, revertFunc revert.RevertFunc)

CreateOrUpdateRedirect creates or updates a L4 redirect with corresponding proxy configuration. This will allocate a proxy port as required and launch a proxy instance. If the redirect is already in place, only the rules will be updated. The proxy listening port is returned, but proxy configuration on that port may still be ongoing asynchronously. Caller should wait for successful completion on 'wg' before assuming the returned proxy port is listening. Caller must call exactly one of the returned functions: - finalizeFunc to make the changes stick, or - revertFunc to cancel the changes. Called with 'localEndpoint' locked!

func (*Proxy) GetStatusModel

func (p *Proxy) GetStatusModel() *models.ProxyStatus

GetStatusModel returns the proxy status as API model

func (*Proxy) ReinstallRules

func (p *Proxy) ReinstallRules(ctx context.Context) error

ReinstallRules is called by daemon reconfiguration to re-install proxy ports rules that were removed during the removal of all Cilium rules.

func (*Proxy) ReleaseProxyPort

func (p *Proxy) ReleaseProxyPort(name string) error

func (*Proxy) RemoveRedirect

func (p *Proxy) RemoveRedirect(id string, wg *completion.WaitGroup) (error, revert.FinalizeFunc, revert.RevertFunc)

RemoveRedirect removes an existing redirect that has been successfully created earlier.

func (*Proxy) SetProxyPort

func (p *Proxy) SetProxyPort(name string, proxyType ProxyType, port uint16, ingress bool) error

SetProxyPort() marks the proxy 'name' as successfully created with proxy port 'port'. Another call to AckProxyPort(name) is needed to update the datapath rules accordingly. This should only be called for proxies that have a static listener that is already listening on 'port'. May only be called once per proxy.

func (*Proxy) UpdateEnvoyResources

func (p *Proxy) UpdateEnvoyResources(ctx context.Context, old, new envoy.Resources, portAllocator envoy.PortAllocator) error

Overload XDSServer.UpdateEnvoyResources to start Envoy on demand

func (*Proxy) UpdateNetworkPolicy

func (p *Proxy) UpdateNetworkPolicy(ep endpoint.EndpointUpdater, vis *policy.VisibilityPolicy, policy *policy.L4Policy, ingressPolicyEnforced, egressPolicyEnforced bool, wg *completion.WaitGroup) (error, func() error)

UpdateNetworkPolicy must update the redirect configuration of an endpoint in the proxy

func (*Proxy) UpsertEnvoyResources

func (p *Proxy) UpsertEnvoyResources(ctx context.Context, resources envoy.Resources, portAllocator envoy.PortAllocator) error

Overload XDSServer.UpsertEnvoyResources to start Envoy on demand

type ProxyPort

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

type ProxyType

type ProxyType string

const (
	// ProxyTypeAny represents the case where no proxy type is provided.
	ProxyTypeAny ProxyType = ""
	// ProxyTypeHTTP specifies the Envoy HTTP proxy type
	ProxyTypeHTTP ProxyType = "http"
	// ProxyTypeDNS specifies the staticly configured DNS proxy type
	ProxyTypeDNS ProxyType = "dns"
	// ProxyTypeCRD specifies a proxy configured via CiliumEnvoyConfig CRD
	ProxyTypeCRD ProxyType = "crd"

	DNSProxyName = "cilium-dns-egress"
)

func (ProxyType) String

func (p ProxyType) String() string

type Redirect

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

type RedirectImplementation

type RedirectImplementation interface {
	// UpdateRules updates the rules for the given proxy redirect.
	// The implementation should .Add to the WaitGroup if the update is
	// asynchronous and the update should not return until it is complete.
	// The returned RevertFunc must be non-nil.
	// Note: UpdateRules is not called when a redirect is created.
	UpdateRules(wg *completion.WaitGroup) (revert.RevertFunc, error)

	// Close closes and cleans up resources associated with the redirect
	// implementation. The implementation should .Add to the WaitGroup if the
	// update is asynchronous and the update should not return until it is
	// complete.
	Close(wg *completion.WaitGroup) (revert.FinalizeFunc, revert.RevertFunc)
}

RedirectImplementation is the generic proxy redirect interface that each proxy redirect type must implement