agentfunctions

Documentation

Overview

+kubebuilder:validation:Optional

Index

• Constants
• Variables
• func RegisterClient(in RegisterClientIn) error
• func RegisterControlPointsHandler(handler ControlPointsHandler, registry *rpc.HandlerRegistry) error
• func RegisterPreviewHandler(handler *PreviewHandler, registry *rpc.HandlerRegistry) error
• type ClientConfig
  • func (in *ClientConfig) DeepCopy() *ClientConfig
  • func (in *ClientConfig) DeepCopyInto(out *ClientConfig)
• type Config
  • func (in *Config) DeepCopy() *Config
  • func (in *Config) DeepCopyInto(out *Config)
• type ControlPointsHandler
  • func NewControlPointsHandler(cache *cache.Cache[selectors.ControlPointID], agentInfo *agentinfo.AgentInfo) ControlPointsHandler
  • func (h *ControlPointsHandler) ListControlPoints(ctx context.Context, _ *cmdv1.ListControlPointsRequest) (*cmdv1.ListControlPointsAgentResponse, error)
• type PreviewHandler
  • func ProvidePreviewHandler(handler *preview.Handler, unmarshaller config.Unmarshaller) (*PreviewHandler, error)
  • func (h *PreviewHandler) PreviewFlowLabels(ctx context.Context, req *cmdv1.PreviewFlowLabelsRequest) (*previewv1.PreviewFlowLabelsResponse, error)
  • func (h *PreviewHandler) PreviewHTTPRequests(ctx context.Context, req *cmdv1.PreviewHTTPRequestsRequest) (*previewv1.PreviewHTTPRequestsResponse, error)
• type RegisterClientIn

Constants

const ConfigKey = "agent_functions"

ConfigKey is the key for agentfunctions configuration.

Variables

var Module = fx.Options(

	grpcclient.ClientConstructor{
		Name:      "agent-functions",
		ConfigKey: ConfigKey + ".client.grpc",
	}.Annotate(),
	fx.Provide(
		NewControlPointsHandler,
		ProvidePreviewHandler,
	),
	fx.Invoke(
		RegisterClient,
		RegisterControlPointsHandler,
		RegisterPreviewHandler,
	),
)

Module provides rpc client for agent functions.

Functions

func RegisterClient

func RegisterClient(in RegisterClientIn) error

RegisterClient registers a client which will allow calling agent functions from controller.

func RegisterControlPointsHandler

func RegisterControlPointsHandler(handler ControlPointsHandler, registry *rpc.HandlerRegistry) error

RegisterControlPointsHandler registers ControlPointsHandler in handler registry.

func RegisterPreviewHandler

func RegisterPreviewHandler(handler *PreviewHandler, registry *rpc.HandlerRegistry) error

RegisterPreviewHandler registers PreviewHandler in handler registry.

Types

type ClientConfig

type ClientConfig struct {
	// GRPC client settings.
	GRPCClient grpcclient.GRPCClientConfig `json:"grpc"`
}

ClientConfig is configuration for network clients used by agent-functions. swagger:model +kubebuilder:object:generate=true

func (*ClientConfig) DeepCopy

func (in *ClientConfig) DeepCopy() *ClientConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClientConfig.

func (*ClientConfig) DeepCopyInto

func (in *ClientConfig) DeepCopyInto(out *ClientConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Config

type Config struct {
	// RPC servers to connect to (which will be able to call agent functions)
	Endpoints []string `json:"endpoints,omitempty" validate:"omitempty,dive,omitempty"`

	// Network client configuration
	ClientConfig ClientConfig `json:"client"`
}

Config is configuration for agent functions. swagger:model +kubebuilder:object:generate=true

func (*Config) DeepCopy

func (in *Config) DeepCopy() *Config

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Config.

func (*Config) DeepCopyInto

func (in *Config) DeepCopyInto(out *Config)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ControlPointsHandler

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

ControlPointsHandler is a handler for ListControlPoints function

Note: There's no requirement every handler needs to be in a separate struct. More methods can be added to this one.

func NewControlPointsHandler

func NewControlPointsHandler(
	cache *cache.Cache[selectors.ControlPointID],
	agentInfo *agentinfo.AgentInfo,
) ControlPointsHandler

NewControlPointsHandler returns a new ControlPointsHandler.

func (*ControlPointsHandler) ListControlPoints

func (h *ControlPointsHandler) ListControlPoints(
	ctx context.Context,
	_ *cmdv1.ListControlPointsRequest,
) (*cmdv1.ListControlPointsAgentResponse, error)

ListControlPoints lists currently discovered control points.

type PreviewHandler

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

PreviewHandler is a handler for preview-family of functions.

Simply forwards methods to grpc handler, which provides actual implementation.

func ProvidePreviewHandler

func ProvidePreviewHandler(
	handler *preview.Handler,
	unmarshaller config.Unmarshaller,
) (*PreviewHandler, error)

ProvidePreviewHandler provides PreviewHandler.

func (*PreviewHandler) PreviewFlowLabels

func (h *PreviewHandler) PreviewFlowLabels(
	ctx context.Context,
	req *cmdv1.PreviewFlowLabelsRequest,
) (*previewv1.PreviewFlowLabelsResponse, error)

PreviewFlowLabels previews flow labels on given control point.

func (*PreviewHandler) PreviewHTTPRequests

func (h *PreviewHandler) PreviewHTTPRequests(
	ctx context.Context,
	req *cmdv1.PreviewHTTPRequestsRequest,
) (*previewv1.PreviewHTTPRequestsResponse, error)

PreviewHTTPRequests previews HTTP requests on given control point.

type RegisterClientIn

type RegisterClientIn struct {
	fx.In
	Lc           fx.Lifecycle
	Unmarshaller config.Unmarshaller
	Handlers     *rpc.HandlerRegistry
	ConnBuilder  grpcclient.ClientConnectionBuilder `name:"agent-functions"`
}

RegisterClientIn are parameters for InvokeClient function.