plugins

Documentation

Overview

Package plugins implements the custom plugin.

Index

• Constants
• type Config
• type IndyKitePlugin
  • func IndyKite() *IndyKitePlugin
  • func (p *IndyKitePlugin) AuthorizationClient() *authorization.Client
  • func (p *IndyKitePlugin) Log(ctx context.Context, event logs.EventV1) error
  • func (p *IndyKitePlugin) Reconfigure(ctx context.Context, config interface{})
  • func (p *IndyKitePlugin) Start(ctx context.Context) (err error)
  • func (p *IndyKitePlugin) Stop(ctx context.Context)

Constants

const PluginName = "indykite_plugin"

PluginName defines name of plugin used in config files.

Types

type Config

type Config struct {
	Test            string `json:"test,omitempty" yaml:"test,omitempty"`
	UseEnvVariables bool   `json:"use_env_variables,omitempty" yaml:"use_env_variables,omitempty"`
	// contains filtered or unexported fields
}

Config defines structure of plugin configuration.

type IndyKitePlugin

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

IndyKitePlugin defines internal structure of OPA Plugin.

func IndyKite

func IndyKite() *IndyKitePlugin

IndyKite returns Plugin instance if it was defined in config, otherwise returns nil.

func (*IndyKitePlugin) AuthorizationClient

func (p *IndyKitePlugin) AuthorizationClient() *authorization.Client

AuthorizationClient returns IndyKite authorization client created from plugin configuration.

func (*IndyKitePlugin) Log

func (p *IndyKitePlugin) Log(ctx context.Context, event logs.EventV1) error

Log plugin events.

func (*IndyKitePlugin) Reconfigure

func (p *IndyKitePlugin) Reconfigure(ctx context.Context, config interface{})

Reconfigure internal plugin configuration state.

func (*IndyKitePlugin) Start

func (p *IndyKitePlugin) Start(ctx context.Context) (err error)

Start plugin based on its configuration.

func (*IndyKitePlugin) Stop

func (p *IndyKitePlugin) Stop(ctx context.Context)

Stop plugin instance.