event

Documentation

Index

• Constants
• type DefaultHandlerState
  • func (c *DefaultHandlerState) GetRemoteEndpoints() []submV1.Endpoint
  • func (c *DefaultHandlerState) IsOnGateway() bool
• type EndpointHandler
• type Handler
• type HandlerBase
  • func (ev *HandlerBase) Init() error
  • func (ev *HandlerBase) LocalEndpointCreated(_ *submV1.Endpoint) error
  • func (ev *HandlerBase) LocalEndpointRemoved(_ *submV1.Endpoint) error
  • func (ev *HandlerBase) LocalEndpointUpdated(_ *submV1.Endpoint) error
  • func (ev *HandlerBase) RemoteEndpointCreated(_ *submV1.Endpoint) error
  • func (ev *HandlerBase) RemoteEndpointRemoved(_ *submV1.Endpoint) error
  • func (ev *HandlerBase) RemoteEndpointUpdated(_ *submV1.Endpoint) error
  • func (ev *HandlerBase) SetState(handlerState HandlerState)
  • func (ev *HandlerBase) State() HandlerState
  • func (ev *HandlerBase) Stop() error
  • func (ev *HandlerBase) TransitionToGateway() error
  • func (ev *HandlerBase) TransitionToNonGateway() error
  • func (ev *HandlerBase) Uninstall() error
• type HandlerState
• type NodeHandler
• type NodeHandlerBase
  • func (h *NodeHandlerBase) NodeCreated(_ *k8sV1.Node) error
  • func (h *NodeHandlerBase) NodeRemoved(_ *k8sV1.Node) error
  • func (h *NodeHandlerBase) NodeUpdated(_ *k8sV1.Node) error
• type Registry
  • func NewRegistry(name, networkPlugin string, eventHandlers ...Handler) (*Registry, error)
  • func (er *Registry) GetHandlers() []Handler
  • func (er *Registry) GetName() string
  • func (er *Registry) StopHandlers() error
  • func (er *Registry) Uninstall() error

Constants

const AnyNetworkPlugin = ""

Types

type DefaultHandlerState

type DefaultHandlerState struct{}

func (*DefaultHandlerState) GetRemoteEndpoints

func (c *DefaultHandlerState) GetRemoteEndpoints() []submV1.Endpoint

func (*DefaultHandlerState) IsOnGateway

func (c *DefaultHandlerState) IsOnGateway() bool

type EndpointHandler

type EndpointHandler interface {
	// TransitionToNonGateway is called once for each transition of the local node from Gateway to a non-Gateway.
	TransitionToNonGateway() error

	// TransitionToGateway is called once for each transition of the local node from non-Gateway to a Gateway.
	TransitionToGateway() error

	// LocalEndpointCreated is called when an endpoint for the local cluster is created.
	LocalEndpointCreated(endpoint *submV1.Endpoint) error

	// LocalEndpointUpdated is called when an endpoint for the local cluster is updated.
	LocalEndpointUpdated(endpoint *submV1.Endpoint) error

	// LocalEndpointRemoved is called when an endpoint for the local cluster is removed.
	LocalEndpointRemoved(endpoint *submV1.Endpoint) error

	// RemoteEndpointCreated is called when an endpoint associated with a remote cluster is created.
	RemoteEndpointCreated(endpoint *submV1.Endpoint) error

	// RemoteEndpointUpdated is called when an endpoint associated with a remote cluster is updated.
	RemoteEndpointUpdated(endpoint *submV1.Endpoint) error

	// RemoteEndpointRemoved is called when an endpoint associated with a remote cluster is removed
	RemoteEndpointRemoved(endpoint *submV1.Endpoint) error
}

type Handler

type Handler interface {
	// Init is called once on startup to let the handler initialize any state it needs.
	Init() error

	// SetHandlerState is called once on startup after Init with the HandlerState that can be used to access global data from event callbacks.
	SetState(handlerCtx HandlerState)

	// GetName returns the name of the event handler
	GetName() string

	// GetNetworkPlugin returns the kubernetes network plugin that this handler supports.
	GetNetworkPlugins() []string

	// Stop is called once during shutdown to let the handler perform any cleanup.
	Stop() error

	// Uninstall is called once after shutdown to let the handler process a Submariner uninstallation.
	Uninstall() error

	EndpointHandler
}

type HandlerBase

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

Base structure for event handlers that stubs out methods considered to be optional.

func (*HandlerBase) Init

func (ev *HandlerBase) Init() error

func (*HandlerBase) LocalEndpointCreated

func (ev *HandlerBase) LocalEndpointCreated(_ *submV1.Endpoint) error

func (*HandlerBase) LocalEndpointRemoved

func (ev *HandlerBase) LocalEndpointRemoved(_ *submV1.Endpoint) error

func (*HandlerBase) LocalEndpointUpdated

func (ev *HandlerBase) LocalEndpointUpdated(_ *submV1.Endpoint) error

func (*HandlerBase) RemoteEndpointCreated

func (ev *HandlerBase) RemoteEndpointCreated(_ *submV1.Endpoint) error

func (*HandlerBase) RemoteEndpointRemoved

func (ev *HandlerBase) RemoteEndpointRemoved(_ *submV1.Endpoint) error

func (*HandlerBase) RemoteEndpointUpdated

func (ev *HandlerBase) RemoteEndpointUpdated(_ *submV1.Endpoint) error

func (*HandlerBase) SetState

func (ev *HandlerBase) SetState(handlerState HandlerState)

func (*HandlerBase) State

func (ev *HandlerBase) State() HandlerState

func (*HandlerBase) Stop

func (ev *HandlerBase) Stop() error

func (*HandlerBase) TransitionToGateway

func (ev *HandlerBase) TransitionToGateway() error

func (*HandlerBase) TransitionToNonGateway

func (ev *HandlerBase) TransitionToNonGateway() error

func (*HandlerBase) Uninstall

func (ev *HandlerBase) Uninstall() error

type HandlerState

type HandlerState interface {
	IsOnGateway() bool
	GetRemoteEndpoints() []submV1.Endpoint
}

type NodeHandler

type NodeHandler interface {
	// NodeCreated indicates when a node has been added to the cluster
	NodeCreated(node *k8sV1.Node) error

	// NodeUpdated indicates when a node has been updated in the cluster
	NodeUpdated(node *k8sV1.Node) error

	// NodeRemoved indicates when a node has been removed from the cluster
	NodeRemoved(node *k8sV1.Node) error
}

type NodeHandlerBase

type NodeHandlerBase struct{}

func (*NodeHandlerBase) NodeCreated

func (h *NodeHandlerBase) NodeCreated(_ *k8sV1.Node) error

func (*NodeHandlerBase) NodeRemoved

func (h *NodeHandlerBase) NodeRemoved(_ *k8sV1.Node) error

func (*NodeHandlerBase) NodeUpdated

func (h *NodeHandlerBase) NodeUpdated(_ *k8sV1.Node) error

type Registry

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

func NewRegistry

func NewRegistry(name, networkPlugin string, eventHandlers ...Handler) (*Registry, error)

NewRegistry creates a new registry with the given name, typically referencing the owner, to manage event Handlers that match the given networkPlugin name. The given event Handlers whose associated network plugin matches the given networkPlugin name are added. Non-matching Handlers are ignored. Handlers will be called in registration order.

func (*Registry) GetHandlers

func (er *Registry) GetHandlers() []Handler

func (*Registry) GetName

func (er *Registry) GetName() string

GetName returns the name of the registry.

func (*Registry) StopHandlers

func (er *Registry) StopHandlers() error

func (*Registry) Uninstall

func (er *Registry) Uninstall() error