interpreter

Documentation

Index

• Constants
• Variables
• type Matcher
  • func (m *Matcher) Matches() bool
• type NameValue
• type Rule
• type RuleArgs
• type RuleResult
• type Rules
  • func (r Rules) Get(name string) Rule
  • func (r Rules) GetByOperation(operation string) Rule
  • func (r Rules) Names() []string

Constants

const (
	// Wildcard indicates that any value can be matched.
	Wildcard = "*"
)

Variables

var AllResourceInterpreterCustomizationRules = []Rule{
	&retentionRule{},
	&replicaResourceRule{},
	&replicaRevisionRule{},
	&statusReflectionRule{},
	&statusAggregationRule{},
	&healthInterpretationRule{},
	&dependencyInterpretationRule{},
}

AllResourceInterpreterCustomizationRules all InterpreterOperations

Types

type Matcher

type Matcher struct {
	ObjGVK    schema.GroupVersionKind
	Operation configv1alpha1.InterpreterOperation
	Rule      configv1alpha1.RuleWithOperations
}

Matcher determines if the Object matches the Rule.

func (*Matcher) Matches

func (m *Matcher) Matches() bool

Matches tells if the Operation, Object matches the Rule.

type NameValue

type NameValue struct {
	Name  string
	Value interface{}
}

NameValue name and value.

type Rule

type Rule interface {
	// Name returns the name of the rule.
	Name() string
	// Document explains detail of rule.
	Document() string
	// GetScript returns the script for the rule from customization. If not enabled, return empty
	GetScript(*configv1alpha1.ResourceInterpreterCustomization) string
	// SetScript set the script for the rule. If script is empty, disable the rule.
	SetScript(*configv1alpha1.ResourceInterpreterCustomization, string)
	// Run execute the rule with given args, and return the result.
	Run(*configurableinterpreter.ConfigurableInterpreter, RuleArgs) *RuleResult
}

Rule known how to get and set script for interpretation rule, and can execute the rule with given args.

type RuleArgs

type RuleArgs struct {
	Desired  *unstructured.Unstructured
	Observed *unstructured.Unstructured
	Status   []workv1alpha2.AggregatedStatusItem
	Replica  int64
}

RuleArgs rule execution args.

type RuleResult

type RuleResult struct {
	Results []NameValue
	Err     error
}

RuleResult rule execution result.

type Rules

type Rules []Rule

Rules is a series of rules.

func (Rules) Get

func (r Rules) Get(name string) Rule

Get returns the rule with the name. If not found, return nil.

func (Rules) GetByOperation

func (r Rules) GetByOperation(operation string) Rule

GetByOperation returns the matched rule by operation name, ignoring case. Return nil if none is matched.

func (Rules) Names

func (r Rules) Names() []string

Names returns the names of containing rules.