hook

Documentation

Index

• func CreateRateLimiter(cfg *config.HookConfig) *rate.Limiter
• type CommonHook
• type Hook
  • func NewHook(name, path string, keepTemporaryHookFiles bool, logProxyHookJSON bool, ...) *Hook
  • func (h *Hook) GetConfig() *config.HookConfig
  • func (h *Hook) GetConfigDescription() string
  • func (h *Hook) LoadConfig(configOutput []byte) (hook *Hook, err error)
  • func (h *Hook) RateLimitWait(ctx context.Context) error
  • func (h *Hook) Run(_ htypes.BindingType, context []bctx.BindingContext, ...) (*Result, error)
  • func (h *Hook) SafeName() string
  • func (h *Hook) WithHookController(hookController *controller.HookController)
  • func (h *Hook) WithTmpDir(dir string)
• type Manager
  • func NewHookManager(config *ManagerConfig) *Manager
  • func (hm *Manager) DetectAdmissionEventType(event admission.Event) htypes.BindingType
  • func (hm *Manager) FindConversionChain(crdName string, rule conversion.Rule) []conversion.Rule
  • func (hm *Manager) GetHook(name string) *Hook
  • func (hm *Manager) GetHookNames() []string
  • func (hm *Manager) GetHooksInOrder(bindingType htypes.BindingType) ([]string, error)
  • func (hm *Manager) HandleAdmissionEvent(event admission.Event, ...)
  • func (hm *Manager) HandleConversionEvent(crdName string, request *v1.ConversionRequest, rule conversion.Rule, ...)
  • func (hm *Manager) HandleKubeEvent(kubeEvent kemtypes.KubeEvent, ...)
  • func (hm *Manager) HandleScheduleEvent(crontab string, createTaskFn func(*Hook, controller.BindingExecutionInfo))
  • func (hm *Manager) Init() error
  • func (hm *Manager) TempDir() string
  • func (hm *Manager) UpdateConversionChains() error
  • func (hm *Manager) WorkingDir() string
• type ManagerConfig
• type Result

Functions

func CreateRateLimiter

func CreateRateLimiter(cfg *config.HookConfig) *rate.Limiter

Types

type CommonHook

type CommonHook interface {
	Name() string
}

type Hook

type Hook struct {
	Name   string // The unique name like '002-prometheus-hooks/startup_hook'.
	Path   string // The absolute path to the executable file.
	Config *config.HookConfig

	HookController *controller.HookController
	RateLimiter    *rate.Limiter

	TmpDir                 string
	KeepTemporaryHookFiles bool

	LogProxyHookJSON    bool
	LogProxyHookJSONKey string

	Logger *log.Logger
}

func NewHook

func NewHook(name, path string, keepTemporaryHookFiles bool, logProxyHookJSON bool, logProxyHookJSONKey string, logger *log.Logger) *Hook

func (*Hook) GetConfig

func (h *Hook) GetConfig() *config.HookConfig

func (*Hook) GetConfigDescription

func (h *Hook) GetConfigDescription() string

func (*Hook) LoadConfig

func (h *Hook) LoadConfig(configOutput []byte) (hook *Hook, err error)

func (*Hook) RateLimitWait

func (h *Hook) RateLimitWait(ctx context.Context) error

func (*Hook) Run

func (h *Hook) Run(_ htypes.BindingType, context []bctx.BindingContext, logLabels map[string]string) (*Result, error)

func (*Hook) SafeName

func (h *Hook) SafeName() string

func (*Hook) WithHookController

func (h *Hook) WithHookController(hookController *controller.HookController)

func (*Hook) WithTmpDir

func (h *Hook) WithTmpDir(dir string)

type Manager

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

func NewHookManager

func NewHookManager(config *ManagerConfig) *Manager

func (*Manager) DetectAdmissionEventType

func (hm *Manager) DetectAdmissionEventType(event admission.Event) htypes.BindingType

func (*Manager) FindConversionChain

func (hm *Manager) FindConversionChain(crdName string, rule conversion.Rule) []conversion.Rule

func (*Manager) GetHook

func (hm *Manager) GetHook(name string) *Hook

func (*Manager) GetHookNames

func (hm *Manager) GetHookNames() []string

func (*Manager) GetHooksInOrder

func (hm *Manager) GetHooksInOrder(bindingType htypes.BindingType) ([]string, error)

func (*Manager) HandleAdmissionEvent

func (hm *Manager) HandleAdmissionEvent(event admission.Event, createTaskFn func(*Hook, controller.BindingExecutionInfo))

func (*Manager) HandleConversionEvent

func (hm *Manager) HandleConversionEvent(crdName string, request *v1.ConversionRequest, rule conversion.Rule, createTaskFn func(*Hook, controller.BindingExecutionInfo))

HandleConversionEvent receives a crdName and calculates a sequence of hooks to run.

func (*Manager) HandleKubeEvent

func (hm *Manager) HandleKubeEvent(kubeEvent kemtypes.KubeEvent, createTaskFn func(*Hook, controller.BindingExecutionInfo))

func (*Manager) HandleScheduleEvent

func (hm *Manager) HandleScheduleEvent(crontab string, createTaskFn func(*Hook, controller.BindingExecutionInfo))

func (*Manager) Init

func (hm *Manager) Init() error

Init finds executables in WorkingDir, execute them with --config argument and add them into indices.

func (*Manager) TempDir

func (hm *Manager) TempDir() string

func (*Manager) UpdateConversionChains

func (hm *Manager) UpdateConversionChains() error

func (*Manager) WorkingDir

func (hm *Manager) WorkingDir() string

type ManagerConfig

type ManagerConfig struct {
	WorkingDir string
	TempDir    string
	Kmgr       kubeeventsmanager.KubeEventsManager
	Smgr       schedulemanager.ScheduleManager
	Wmgr       *admission.WebhookManager
	Cmgr       *conversion.WebhookManager

	Logger *log.Logger
}

ManagerConfig sets configuration for Manager

type Result

type Result struct {
	Usage                *executor.CmdUsage
	Metrics              []operation.MetricOperation
	ConversionResponse   *conversion.Response
	AdmissionResponse    *admission.Response
	KubernetesPatchBytes []byte
}