classifier

Documentation

Index

• Variables
• type ActiveRuleset
  • func (rs ActiveRuleset) Drop()
• type ClassificationEngine
  • func NewClassificationEngine(registry status.Registry) *ClassificationEngine
  • func ProvideClassificationEngine(in ClassificationEngineIn) *ClassificationEngine
  • func (c *ClassificationEngine) ActiveRules() []compiler.ReportedRule
  • func (c *ClassificationEngine) AddRules(ctx context.Context, name string, ...) (ActiveRuleset, error)
  • func (c *ClassificationEngine) Classify(ctx context.Context, svcs []string, ctrlPt selectors.ControlPoint, ...) ([]*flowcontrolv1.ClassifierInfo, flowlabel.FlowLabels, error)
  • func (c *ClassificationEngine) GetSelector() *selectorv1.Selector
• type ClassificationEngineIn

Variables

var Module fx.Option = fx.Options(
	fx.Provide(
		fx.Annotated{
			Target: setupEtcdClassifierWatcher,
			Name:   "classifier",
		},
		ProvideClassificationEngine,
	),
)

Module is a default set of components to enable flow classification

Note: this module provides just a Classifier datastructure, with no API endpoint. Example API endpoint to the classifier is pkg/envoy.

Types

type ActiveRuleset

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

ActiveRuleset represents one of currently active set of rules.

func (ActiveRuleset) Drop

func (rs ActiveRuleset) Drop()

Drop retracts all the rules belonging to a ruleset.

type ClassificationEngine

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

ClassificationEngine receives classification policies and provides Classify method.

func NewClassificationEngine

func NewClassificationEngine(registry status.Registry) *ClassificationEngine

NewClassificationEngine creates a new Flow Classifier.

func ProvideClassificationEngine

func ProvideClassificationEngine(in ClassificationEngineIn) *ClassificationEngine

ProvideClassificationEngine provides a classifier that loads the rules from config file.

func (*ClassificationEngine) ActiveRules

func (c *ClassificationEngine) ActiveRules() []compiler.ReportedRule

ActiveRules returns a slice of uncompiled Rules which are currently active.

func (*ClassificationEngine) AddRules

func (c *ClassificationEngine) AddRules(
	ctx context.Context,
	name string,
	classifierWrapper *wrappersv1.ClassifierWrapper,
) (ActiveRuleset, error)

AddRules compiles a ruleset and adds it to the active rules

The name will be used for reporting

To retract the rules, call Classifier.Drop.

func (*ClassificationEngine) Classify

func (c *ClassificationEngine) Classify(
	ctx context.Context,
	svcs []string,
	ctrlPt selectors.ControlPoint,
	labelsForMatching map[string]string,
	input ast.Value,
) ([]*flowcontrolv1.ClassifierInfo, flowlabel.FlowLabels, error)

Classify takes rego input, performs classification, and returns a map of flow labels. LabelsForMatching are additional labels to use for selector matching.

func (*ClassificationEngine) GetSelector

func (c *ClassificationEngine) GetSelector() *selectorv1.Selector

GetSelector returns the selector.

type ClassificationEngineIn

type ClassificationEngineIn struct {
	fx.In
	Watcher   notifiers.Watcher `name:"classifier"`
	Lifecycle fx.Lifecycle
	Registry  status.Registry
}

ClassificationEngineIn holds parameters for ProvideClassificationEngine.