plugin

Documentation

Index

• func CapsuleStep[T any](_ T, req pipeline.CapsuleRequest) (string, any, error)
• func GetNew(group, kind, name string, req pipeline.CapsuleRequest) (client.Object, error)
• func LoadYAMLConfig(data []byte, out any) error
• func ParseTemplatedConfig[T any](data []byte, req pipeline.CapsuleRequest, steps ...ParseStep[T]) (T, error)
• func StartPlugin(name string, rigPlugin Server)
• type ExternalPlugin
  • func (p *ExternalPlugin) Run(ctx context.Context, req pipeline.CapsuleRequest) error
  • func (p *ExternalPlugin) Stop(context.Context)
• type GRPCServer
  • func (m *GRPCServer) Initialize(_ context.Context, req *apiplugin.InitializeRequest) (*apiplugin.InitializeResponse, error)
  • func (m *GRPCServer) RunCapsule(ctx context.Context, req *apiplugin.RunCapsuleRequest) (*apiplugin.RunCapsuleResponse, error)
• type Info
• type InitializeRequest
• type Manager
  • func NewManager(opts ...ManagerOption) (*Manager, error)
  • func (m *Manager) GetPlugin(name string) (Info, bool)
  • func (m *Manager) GetPlugins() []Info
  • func (m *Manager) NewStep(step v1alpha1.Step, logger logr.Logger) (*Step, error)
• type ManagerOption
  • func SetBuiltinBinaryPathOption(path string) ManagerOption
• type Matcher
  • func NewMatcher(namespaces, capsules []string, selector metav1.LabelSelector, ...) (Matcher, error)
  • func (m Matcher) Match(namespace, capsule string, capsuleLabels map[string]string) bool
• type ParseStep
• type Plugin
  • func NewExternalPlugin(name, stepTag, pluginTag, pluginConfig, path string, args []string, ...) (Plugin, error)
• type Server
• type Step
  • func (s *Step) Apply(ctx context.Context, req pipeline.CapsuleRequest) error
  • func (s *Step) Stop(ctx context.Context)
• type ThirdPartyConfig
• type ThirdPartyPlugin

Functions

func CapsuleStep

func CapsuleStep[T any](_ T, req pipeline.CapsuleRequest) (string, any, error)

func GetNew

func GetNew(group, kind, name string, req pipeline.CapsuleRequest) (client.Object, error)

func LoadYAMLConfig

func LoadYAMLConfig(data []byte, out any) error

func ParseTemplatedConfig

func ParseTemplatedConfig[T any](data []byte, req pipeline.CapsuleRequest, steps ...ParseStep[T]) (T, error)

Using this, we parse the config at every execution of the plugin. If we get performance issues due to that we can try and optimize that.

func StartPlugin

func StartPlugin(name string, rigPlugin Server)

Types

type ExternalPlugin

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

func (*ExternalPlugin) Run

func (p *ExternalPlugin) Run(ctx context.Context, req pipeline.CapsuleRequest) error

func (*ExternalPlugin) Stop

func (p *ExternalPlugin) Stop(context.Context)

type GRPCServer

type GRPCServer struct {
	apiplugin.UnimplementedPluginServiceServer

	Impl Server
	// contains filtered or unexported fields
}

func (*GRPCServer) Initialize

func (m *GRPCServer) Initialize(
	_ context.Context,
	req *apiplugin.InitializeRequest,
) (*apiplugin.InitializeResponse, error)

func (*GRPCServer) RunCapsule

func (m *GRPCServer) RunCapsule(
	ctx context.Context,
	req *apiplugin.RunCapsuleRequest,
) (*apiplugin.RunCapsuleResponse, error)

type Info

type Info struct {
	Name       string
	Image      string
	IsBuiltin  bool
	BinaryPath string
	Args       []string
}

type InitializeRequest

type InitializeRequest struct {
	Config []byte
	Tag    string
}

type Manager

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

func NewManager

func NewManager(opts ...ManagerOption) (*Manager, error)

func (*Manager) GetPlugin

func (m *Manager) GetPlugin(name string) (Info, bool)

func (*Manager) GetPlugins

func (m *Manager) GetPlugins() []Info

func (*Manager) NewStep

func (m *Manager) NewStep(step v1alpha1.Step, logger logr.Logger) (*Step, error)

type ManagerOption

type ManagerOption func(m *Manager)

func SetBuiltinBinaryPathOption

func SetBuiltinBinaryPathOption(path string) ManagerOption

type Matcher

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

func NewMatcher

func NewMatcher(namespaces, capsules []string, selector metav1.LabelSelector, enableForPlatform bool) (Matcher, error)

func (Matcher) Match

func (m Matcher) Match(namespace, capsule string, capsuleLabels map[string]string) bool

type ParseStep

type ParseStep[T any] func(config T, req pipeline.CapsuleRequest) (string, any, error)

type Plugin

type Plugin interface {
	Run(context.Context, pipeline.CapsuleRequest) error
	Stop(context.Context)
}

func NewExternalPlugin

func NewExternalPlugin(
	name, stepTag, pluginTag, pluginConfig, path string,
	args []string,
	logger logr.Logger,
) (Plugin, error)

type Server

type Server interface {
	Run(ctx context.Context, req pipeline.CapsuleRequest, logger hclog.Logger) error
	Initialize(req InitializeRequest) error
}

type Step

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

func (*Step) Apply

func (s *Step) Apply(ctx context.Context, req pipeline.CapsuleRequest) error

func (*Step) Stop

func (s *Step) Stop(ctx context.Context)

type ThirdPartyConfig

type ThirdPartyConfig struct {
	Plugins []ThirdPartyPlugin `json:"plugins"`
}

type ThirdPartyPlugin

type ThirdPartyPlugin struct {
	Name string `json:"name"`
}