roles

Documentation

Index

• Variables
• func Register(name string, constructor RoleConstructor)
• type Event
  • func NewEvent(ctx context.Context, data map[string]interface{}) *Event
  • func (ev *Event) String() string
  • func (ev *Event) WithTopic(topic string) *Event
• type EventHandler
• type EventPayload
• type HookOptions
• type Instance
• type MigratableRole
• type Migration
• type Role
• type RoleConstructor
  • func GetRole(name string) RoleConstructor
• type RoleMigrator

Variables

var ErrRoleNotConfigured = errors.New("role: Not configured")

Functions

func Register

func Register(name string, constructor RoleConstructor)

Types

type Event

type Event struct {
	Context context.Context

	Payload EventPayload
	// contains filtered or unexported fields
}

func NewEvent

func NewEvent(ctx context.Context, data map[string]interface{}) *Event

func (*Event) String

func (ev *Event) String() string

func (*Event) WithTopic

func (ev *Event) WithTopic(topic string) *Event

type EventHandler

type EventHandler func(ev *Event)

type EventPayload

type EventPayload struct {
	Data                 map[string]interface{}
	RelatedObjectKey     *storage.Key
	RelatedObjectOptions []clientv3.OpOption
}

type HookOptions

type HookOptions struct {
	Method string
	Source string
	Env    map[string]interface{}
}

type Instance

type Instance interface {
	KV() *storage.Client
	Log() *zap.Logger
	DispatchEvent(topic string, ev *Event)
	AddEventListener(topic string, handler EventHandler)
	Context() context.Context
	ExecuteHook(HookOptions, ...interface{})
	Migrator() RoleMigrator
}

type MigratableRole

type MigratableRole interface {
	Role
	RegisterMigrations()
}

type Migration

type Migration interface {
	Check(clusterVersion *semver.Version, ctx context.Context) (bool, error)
	Hook(context.Context) (*storage.Client, error)
	Cleanup(context.Context) error
	Name() string
}

type Role

type Role interface {
	Start(ctx context.Context, config []byte) error
	Stop()
}

type RoleConstructor

type RoleConstructor func(Instance) Role

func GetRole

func GetRole(name string) RoleConstructor

type RoleMigrator

type RoleMigrator interface {
	AddMigration(Migration)
	Run(ctx context.Context) (*storage.Client, error)
}