rule

Documentation

Index

• func ExecuteRule(rule *stork_api.Rule, rType Type, owner runtime.Object, ...) (chan bool, error)
• func Init() error
• func PerformRuleRecovery(owner runtime.Object) error
• func ValidateRule(rule *stork_api.Rule, ruleType Type) error
• type CommandTask
• type Pod
• type Type

Functions

func ExecuteRule

func ExecuteRule(
	rule *stork_api.Rule,
	rType Type,
	owner runtime.Object,
	pvcs []v1.PersistentVolumeClaim,
) (chan bool, error)

ExecuteRule executes rules for the given owner. PVCs are used to figure out the pods on which the rule actions will be run on

func Init

func Init() error

Init initializes the rule executor

func PerformRuleRecovery

func PerformRuleRecovery(
	owner runtime.Object,
) error

PerformRuleRecovery terminates potential background commands running pods for the given owner

func ValidateRule

func ValidateRule(rule *stork_api.Rule, ruleType Type) error

ValidateRule validates a rule

Types

type CommandTask

type CommandTask struct {
	TaskID string `json:"taskID"`
	Pods   []Pod  `json:"pods"`
}

CommandTask tracks pods where commands for a taskID might still be running

type Pod

type Pod struct {
	UID       string `json:"uid"`
	Namespace string `json:"namespace"`
}

Pod is a simple type to encapsulate a Pod's uid and namespace

type Type

type Type string

Type The type of rule to be executed

const (
	// PreExecRule This type of rule is to be run before an operation
	PreExecRule Type = "preExecRule"
	// PostExecRule This type of rule is to be run after an operation
	PostExecRule Type = "postExecRule"
)