preview

Documentation

Overview

+kubebuilder:validation:Optional

Index

• Constants
• func Module() fx.Option
• func Register(handler *Handler, server *grpc.Server, healthsrv *health.Server, ...) error
• type FlowPreviewConfig
  • func (in *FlowPreviewConfig) DeepCopy() *FlowPreviewConfig
  • func (in *FlowPreviewConfig) DeepCopyInto(out *FlowPreviewConfig)
• type HTTPRequestsPreviewRequest
  • func (r *HTTPRequestsPreviewRequest) AddHTTPRequestPreview(request map[string]interface{})
  • func (r *HTTPRequestsPreviewRequest) GetFlowSelector() *policylangv1.FlowSelector
  • func (r *HTTPRequestsPreviewRequest) GetPreviewID() iface.PreviewID
• type Handler
  • func NewHandler(engine iface.Engine, classifier *classification.ClassificationEngine, ...) *Handler
  • func (h *Handler) PreviewFlowLabels(ctx context.Context, req *flowpreviewv1.PreviewRequest) (*flowpreviewv1.PreviewFlowLabelsResponse, error)
  • func (h *Handler) PreviewHTTPRequests(ctx context.Context, req *flowpreviewv1.PreviewRequest) (*flowpreviewv1.PreviewHTTPRequestsResponse, error)

Constants

const ConfigKey = "flow_control.preview_service"

ConfigKey is config path where FlowPreviewConfig is located.

Functions

func Module

func Module() fx.Option

Module provides preview handler and registers the service.

func Register

func Register(handler *Handler,
	server *grpc.Server,
	healthsrv *health.Server,
	unmarshaller cfg.Unmarshaller,
) error

Register registers the handler on grpc.Server.

Types

type FlowPreviewConfig

type FlowPreviewConfig struct {
	// Enables the flow preview service.
	Enabled bool `json:"enabled" default:"true"`
}

FlowPreviewConfig is the configuration for the flow control preview service. swagger:model +kubebuilder:object:generate=true

func (*FlowPreviewConfig) DeepCopy

func (in *FlowPreviewConfig) DeepCopy() *FlowPreviewConfig

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

func (*FlowPreviewConfig) DeepCopyInto

func (in *FlowPreviewConfig) DeepCopyInto(out *FlowPreviewConfig)

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

type HTTPRequestsPreviewRequest

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

HTTPRequestsPreviewRequest holds the samples while the preview is being generated.

func (*HTTPRequestsPreviewRequest) AddHTTPRequestPreview

func (r *HTTPRequestsPreviewRequest) AddHTTPRequestPreview(request map[string]interface{})

AddHTTPRequestPreview adds a HTTP request preview to the response.

func (*HTTPRequestsPreviewRequest) GetFlowSelector

func (r *HTTPRequestsPreviewRequest) GetFlowSelector() *policylangv1.FlowSelector

GetFlowSelector returns the flow selector.

func (*HTTPRequestsPreviewRequest) GetPreviewID

func (r *HTTPRequestsPreviewRequest) GetPreviewID() iface.PreviewID

GetPreviewID returns the preview ID.

type Handler

type Handler struct {
	flowpreviewv1.UnimplementedFlowPreviewServiceServer
	// contains filtered or unexported fields
}

Handler implements flowpreview.v1 service.

func NewHandler

func NewHandler(
	engine iface.Engine,
	classifier *classification.ClassificationEngine,
	agentInfo *agentinfo.AgentInfo,
) *Handler

NewHandler returns a new Handler.

func (*Handler) PreviewFlowLabels

func (h *Handler) PreviewFlowLabels(ctx context.Context, req *flowpreviewv1.PreviewRequest) (*flowpreviewv1.PreviewFlowLabelsResponse, error)

PreviewFlowLabels implements flowpreview.v1.PreviewFlowLabels.

func (*Handler) PreviewHTTPRequests

func (h *Handler) PreviewHTTPRequests(ctx context.Context, req *flowpreviewv1.PreviewRequest) (*flowpreviewv1.PreviewHTTPRequestsResponse, error)

PreviewHTTPRequests implements flowpreview.v1.PreviewHTTPRequests.