agent

Documentation

Index

• Variables
• func AppEnvironment(ctx context.Context, ag *agentconfig.Container) (map[string]string, error)
• func Main(ctx context.Context, _ ...string) error
• func StartServices(ctx context.Context, g *dgroup.Group, config Config, srv State) (*rpc.AgentInfo, error)
• func TalkToManager(ctx context.Context, address string, info *rpc.AgentInfo, state State) error
• func TalkToManagerLoop(ctx context.Context, s State, info *rpc.AgentInfo)
• type Config
  • func LoadConfig(ctx context.Context) (Config, error)
• type ContainerState
  • func NewContainerState(mountPoint string, env map[string]string) ContainerState
• type InterceptState
• type InterceptTarget
  • func NewInterceptTarget(ics []*agentconfig.Intercept) InterceptTarget
  • func (cp InterceptTarget) AgentPort() uint16
  • func (cp InterceptTarget) AppProtocol(ctx context.Context) (proto string)
  • func (cp InterceptTarget) ContainerPort() uint16
  • func (cp InterceptTarget) ContainerPortName() string
  • func (cp InterceptTarget) HasServicePort(port uint16) bool
  • func (cp InterceptTarget) HasServicePortName(name string) bool
  • func (cp InterceptTarget) MatchForSpec(spec *manager.InterceptSpec) bool
  • func (cp InterceptTarget) Protocol() v1.Protocol
  • func (cp InterceptTarget) String() string
• type ProviderMux
  • func (pm *ProviderMux) CreateClientStream(ctx context.Context, sessionID string, id tunnel.ConnID, ...) (tunnel.Stream, error)
  • func (pm *ProviderMux) ReportMetrics(ctx context.Context, metrics *manager.TunnelMetrics)
• type State
  • func NewState(config Config) State

Variables

var DisplayName = "OSS Traffic Agent" //nolint:gochecknoglobals // extension point

var NewExtendedManagerClient func(conn *grpc.ClientConn, ossManager rpc.ManagerClient) rpc.ManagerClient //nolint:gochecknoglobals // extension point

Functions

func AppEnvironment

func AppEnvironment(ctx context.Context, ag *agentconfig.Container) (map[string]string, error)

AppEnvironment returns the environment visible to this agent together with environment variables explicitly declared for the app container and minus the environment variables provided by this config.

func Main

func Main(ctx context.Context, _ ...string) error

func StartServices

func StartServices(ctx context.Context, g *dgroup.Group, config Config, srv State) (*rpc.AgentInfo, error)

func TalkToManager

func TalkToManager(ctx context.Context, address string, info *rpc.AgentInfo, state State) error

func TalkToManagerLoop

func TalkToManagerLoop(ctx context.Context, s State, info *rpc.AgentInfo)

Types

type Config

type Config interface {
	Ext() agentconfig.SidecarExt
	AgentConfig() *agentconfig.Sidecar
	HasMounts(ctx context.Context) bool
	PodName() string
	PodIP() string
}

func LoadConfig

func LoadConfig(ctx context.Context) (Config, error)

type ContainerState

type ContainerState interface {
	MountPoint() string
	Env() map[string]string
}

func NewContainerState

func NewContainerState(mountPoint string, env map[string]string) ContainerState

NewContainerState creates a ContainerState that provides the environment variables and the mount point for a container.

type InterceptState

type InterceptState interface {
	State
	Target() InterceptTarget
	InterceptInfo(ctx context.Context, callerID, path string, containerPort uint16, headers http.Header) (*restapi.InterceptInfo, error)
}

An InterceptState implements what's needed to intercept one target port.

type InterceptTarget

type InterceptTarget []*agentconfig.Intercept

InterceptTarget describes the mapping between service ports and one container port, or if no service is used, just the container port. All entries must be guaranteed to all have the same Protocol, ContainerPort, and AgentPort. The slice must be considered immutable once created using NewInterceptTarget.

func NewInterceptTarget

func NewInterceptTarget(ics []*agentconfig.Intercept) InterceptTarget

func (InterceptTarget) AgentPort

func (cp InterceptTarget) AgentPort() uint16

func (InterceptTarget) AppProtocol

func (cp InterceptTarget) AppProtocol(ctx context.Context) (proto string)

func (InterceptTarget) ContainerPort

func (cp InterceptTarget) ContainerPort() uint16

func (InterceptTarget) ContainerPortName

func (cp InterceptTarget) ContainerPortName() string

func (InterceptTarget) HasServicePort

func (cp InterceptTarget) HasServicePort(port uint16) bool

func (InterceptTarget) HasServicePortName

func (cp InterceptTarget) HasServicePortName(name string) bool

func (InterceptTarget) MatchForSpec

func (cp InterceptTarget) MatchForSpec(spec *manager.InterceptSpec) bool

func (InterceptTarget) Protocol

func (cp InterceptTarget) Protocol() v1.Protocol

func (InterceptTarget) String

func (cp InterceptTarget) String() string

type ProviderMux

type ProviderMux struct {
	AgentProvider   tunnel.ClientStreamProvider
	ManagerProvider tunnel.StreamProvider
}

func (*ProviderMux) CreateClientStream

func (pm *ProviderMux) CreateClientStream(ctx context.Context, sessionID string, id tunnel.ConnID, roundTripLatency, dialTimeout time.Duration) (tunnel.Stream, error)

func (*ProviderMux) ReportMetrics

func (pm *ProviderMux) ReportMetrics(ctx context.Context, metrics *manager.TunnelMetrics)

type State

type State interface {
	Config
	agent.AgentServer
	tunnel.ClientStreamProvider
	AddInterceptState(is InterceptState)
	AgentState() restapi.AgentState
	InterceptStates() []InterceptState
	HandleIntercepts(ctx context.Context, cepts []*manager.InterceptInfo) []*manager.ReviewInterceptRequest
	ManagerClient() manager.ManagerClient
	ManagerVersion() semver.Version
	SessionInfo() *manager.SessionInfo
	SetFileSharingPorts(ftp uint16, sftp uint16)
	SetManager(ctx context.Context, sessionInfo *manager.SessionInfo, manager manager.ManagerClient, version semver.Version)
	FtpPort() uint16
	SftpPort() uint16
	NewInterceptState(forwarder forwarder.Interceptor, target InterceptTarget, container string) InterceptState
	AddContainerState(containerName string, containerState ContainerState)
}

State reflects the current state of the agent.

func NewState

func NewState(config Config) State